Skip to content

Commit 0d60ff4

Browse files
gerzsegerzse
committed
Change terminology for allow/deny lists
1 parent 48b43f4 commit 0d60ff4

File tree

9 files changed

+52
-52
lines changed

9 files changed

+52
-52
lines changed

‎redis/_cache.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class EvictionPolicy(Enum):
1717

1818
DEFAULT_EVICTION_POLICY = EvictionPolicy.LRU
1919

20-
DEFAULT_BLACKLIST = [
20+
DEFAULT_DENY_LIST = [
2121
"BF.CARD",
2222
"BF.DEBUG",
2323
"BF.EXISTS",
@@ -77,7 +77,7 @@ class EvictionPolicy(Enum):
7777
"TTL",
7878
]
7979

80-
DEFAULT_WHITELIST = [
80+
DEFAULT_ALLOW_LIST = [
8181
"BITCOUNT",
8282
"BITFIELD_RO",
8383
"BITPOS",

‎redis/asyncio/client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727
)
2828

2929
from redis._cache import (
30-
DEFAULT_BLACKLIST,
30+
DEFAULT_ALLOW_LIST,
31+
DEFAULT_DENY_LIST,
3132
DEFAULT_EVICTION_POLICY,
32-
DEFAULT_WHITELIST,
3333
AbstractCache,
3434
)
3535
from redis._parsers.helpers import (
@@ -243,8 +243,8 @@ def __init__(
243243
cache_max_size: int = 100,
244244
cache_ttl: int = 0,
245245
cache_policy: str = DEFAULT_EVICTION_POLICY,
246-
cache_blacklist: List[str] = DEFAULT_BLACKLIST,
247-
cache_whitelist: List[str] = DEFAULT_WHITELIST,
246+
cache_deny_list: List[str] = DEFAULT_DENY_LIST,
247+
cache_allow_list: List[str] = DEFAULT_ALLOW_LIST,
248248
):
249249
"""
250250
Initialize a new Redis client.
@@ -299,8 +299,8 @@ def __init__(
299299
"cache_max_size": cache_max_size,
300300
"cache_ttl": cache_ttl,
301301
"cache_policy": cache_policy,
302-
"cache_blacklist": cache_blacklist,
303-
"cache_whitelist": cache_whitelist,
302+
"cache_deny_list": cache_deny_list,
303+
"cache_allow_list": cache_allow_list,
304304
}
305305
# based on input, setup appropriate connection args
306306
if unix_socket_path is not None:

‎redis/asyncio/cluster.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020
)
2121

2222
from redis._cache import (
23-
DEFAULT_BLACKLIST,
23+
DEFAULT_ALLOW_LIST,
24+
DEFAULT_DENY_LIST,
2425
DEFAULT_EVICTION_POLICY,
25-
DEFAULT_WHITELIST,
2626
AbstractCache,
2727
)
2828
from redis._parsers import AsyncCommandsParser, Encoder
@@ -280,8 +280,8 @@ def __init__(
280280
cache_max_size: int = 100,
281281
cache_ttl: int = 0,
282282
cache_policy: str = DEFAULT_EVICTION_POLICY,
283-
cache_blacklist: List[str] = DEFAULT_BLACKLIST,
284-
cache_whitelist: List[str] = DEFAULT_WHITELIST,
283+
cache_deny_list: List[str] = DEFAULT_DENY_LIST,
284+
cache_allow_list: List[str] = DEFAULT_ALLOW_LIST,
285285
) -> None:
286286
if db:
287287
raise RedisClusterException(
@@ -331,8 +331,8 @@ def __init__(
331331
"cache_max_size": cache_max_size,
332332
"cache_ttl": cache_ttl,
333333
"cache_policy": cache_policy,
334-
"cache_blacklist": cache_blacklist,
335-
"cache_whitelist": cache_whitelist,
334+
"cache_deny_list": cache_deny_list,
335+
"cache_allow_list": cache_allow_list,
336336
}
337337

338338
if ssl:

‎redis/asyncio/connection.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@
5151
from redis.utils import HIREDIS_AVAILABLE, get_lib_version, str_if_bytes
5252

5353
from .._cache import (
54-
DEFAULT_BLACKLIST,
54+
DEFAULT_ALLOW_LIST,
55+
DEFAULT_DENY_LIST,
5556
DEFAULT_EVICTION_POLICY,
56-
DEFAULT_WHITELIST,
5757
AbstractCache,
5858
_LocalCache,
5959
)
@@ -120,8 +120,8 @@ class AbstractConnection:
120120
"ssl_context",
121121
"protocol",
122122
"client_cache",
123-
"cache_blacklist",
124-
"cache_whitelist",
123+
"cache_deny_list",
124+
"cache_allow_list",
125125
"_reader",
126126
"_writer",
127127
"_parser",
@@ -161,8 +161,8 @@ def __init__(
161161
cache_max_size: int = 10000,
162162
cache_ttl: int = 0,
163163
cache_policy: str = DEFAULT_EVICTION_POLICY,
164-
cache_blacklist: List[str] = DEFAULT_BLACKLIST,
165-
cache_whitelist: List[str] = DEFAULT_WHITELIST,
164+
cache_deny_list: List[str] = DEFAULT_DENY_LIST,
165+
cache_allow_list: List[str] = DEFAULT_ALLOW_LIST,
166166
):
167167
if (username or password) and credential_provider is not None:
168168
raise DataError(
@@ -230,8 +230,8 @@ def __init__(
230230
raise RedisError(
231231
"client caching is only supported with protocol version 3 or higher"
232232
)
233-
self.cache_blacklist = cache_blacklist
234-
self.cache_whitelist = cache_whitelist
233+
self.cache_deny_list = cache_deny_list
234+
self.cache_allow_list = cache_allow_list
235235

236236
def __del__(self, _warnings: Any = warnings):
237237
# For some reason, the individual streams don't get properly garbage
@@ -708,8 +708,8 @@ async def _get_from_local_cache(self, command: str):
708708
"""
709709
if (
710710
self.client_cache is None
711-
or command[0] in self.cache_blacklist
712-
or command[0] not in self.cache_whitelist
711+
or command[0] in self.cache_deny_list
712+
or command[0] not in self.cache_allow_list
713713
):
714714
return None
715715
while not self._socket_is_empty():
@@ -725,8 +725,8 @@ def _add_to_local_cache(
725725
"""
726726
if (
727727
self.client_cache is not None
728-
and (self.cache_blacklist == [] or command[0] not in self.cache_blacklist)
729-
and (self.cache_whitelist == [] or command[0] in self.cache_whitelist)
728+
and (self.cache_deny_list == [] or command[0] not in self.cache_deny_list)
729+
and (self.cache_allow_list == [] or command[0] in self.cache_allow_list)
730730
):
731731
self.client_cache.set(command, response, keys)
732732

‎redis/client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
from typing import Any, Callable, Dict, List, Optional, Type, Union
88

99
from redis._cache import (
10-
DEFAULT_BLACKLIST,
10+
DEFAULT_ALLOW_LIST,
11+
DEFAULT_DENY_LIST,
1112
DEFAULT_EVICTION_POLICY,
12-
DEFAULT_WHITELIST,
1313
AbstractCache,
1414
)
1515
from redis._parsers.encoders import Encoder
@@ -220,8 +220,8 @@ def __init__(
220220
cache_max_size: int = 10000,
221221
cache_ttl: int = 0,
222222
cache_policy: str = DEFAULT_EVICTION_POLICY,
223-
cache_blacklist: List[str] = DEFAULT_BLACKLIST,
224-
cache_whitelist: List[str] = DEFAULT_WHITELIST,
223+
cache_deny_list: List[str] = DEFAULT_DENY_LIST,
224+
cache_allow_list: List[str] = DEFAULT_ALLOW_LIST,
225225
) -> None:
226226
"""
227227
Initialize a new Redis client.
@@ -278,8 +278,8 @@ def __init__(
278278
"cache_max_size": cache_max_size,
279279
"cache_ttl": cache_ttl,
280280
"cache_policy": cache_policy,
281-
"cache_blacklist": cache_blacklist,
282-
"cache_whitelist": cache_whitelist,
281+
"cache_deny_list": cache_deny_list,
282+
"cache_allow_list": cache_allow_list,
283283
}
284284
# based on input, setup appropriate connection args
285285
if unix_socket_path is not None:

‎redis/cluster.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,8 @@ def parse_cluster_myshardid(resp, **options):
172172
"cache_max_size",
173173
"cache_ttl",
174174
"cache_policy",
175-
"cache_blacklist",
176-
"cache_whitelist",
175+
"cache_deny_list",
176+
"cache_allow_list",
177177
)
178178
KWARGS_DISABLED_KEYS = ("host", "port")
179179

‎redis/connection.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
from urllib.parse import parse_qs, unquote, urlparse
1414

1515
from ._cache import (
16-
DEFAULT_BLACKLIST,
16+
DEFAULT_ALLOW_LIST,
17+
DEFAULT_DENY_LIST,
1718
DEFAULT_EVICTION_POLICY,
18-
DEFAULT_WHITELIST,
1919
AbstractCache,
2020
_LocalCache,
2121
)
@@ -162,8 +162,8 @@ def __init__(
162162
cache_max_size: int = 10000,
163163
cache_ttl: int = 0,
164164
cache_policy: str = DEFAULT_EVICTION_POLICY,
165-
cache_blacklist: List[str] = DEFAULT_BLACKLIST,
166-
cache_whitelist: List[str] = DEFAULT_WHITELIST,
165+
cache_deny_list: List[str] = DEFAULT_DENY_LIST,
166+
cache_allow_list: List[str] = DEFAULT_ALLOW_LIST,
167167
):
168168
"""
169169
Initialize a new Connection.
@@ -239,8 +239,8 @@ def __init__(
239239
raise RedisError(
240240
"client caching is only supported with protocol version 3 or higher"
241241
)
242-
self.cache_blacklist = cache_blacklist
243-
self.cache_whitelist = cache_whitelist
242+
self.cache_deny_list = cache_deny_list
243+
self.cache_allow_list = cache_allow_list
244244

245245
def __repr__(self):
246246
repr_args = ",".join([f"{k}={v}" for k, v in self.repr_pieces()])
@@ -629,8 +629,8 @@ def _get_from_local_cache(self, command: str):
629629
"""
630630
if (
631631
self.client_cache is None
632-
or command[0] in self.cache_blacklist
633-
or command[0] not in self.cache_whitelist
632+
or command[0] in self.cache_deny_list
633+
or command[0] not in self.cache_allow_list
634634
):
635635
return None
636636
while self.can_read():
@@ -646,8 +646,8 @@ def _add_to_local_cache(
646646
"""
647647
if (
648648
self.client_cache is not None
649-
and (self.cache_blacklist == [] or command[0] not in self.cache_blacklist)
650-
and (self.cache_whitelist == [] or command[0] in self.cache_whitelist)
649+
and (self.cache_deny_list == [] or command[0] not in self.cache_deny_list)
650+
and (self.cache_allow_list == [] or command[0] in self.cache_allow_list)
651651
):
652652
self.client_cache.set(command, response, keys)
653653

‎tests/test_asyncio/test_cache.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,10 @@ async def test_cache_decode_response(self, r):
125125

126126
@pytest.mark.parametrize(
127127
"r",
128-
[{"cache": _LocalCache(), "kwargs": {"cache_blacklist": ["LLEN"]}}],
128+
[{"cache": _LocalCache(), "kwargs": {"cache_deny_list": ["LLEN"]}}],
129129
indirect=True,
130130
)
131-
async def test_cache_blacklist(self, r):
131+
async def test_cache_deny_list(self, r):
132132
r, cache = r
133133
# add list to redis
134134
await r.lpush("mylist", "foo", "bar", "baz")
@@ -139,10 +139,10 @@ async def test_cache_blacklist(self, r):
139139

140140
@pytest.mark.parametrize(
141141
"r",
142-
[{"cache": _LocalCache(), "kwargs": {"cache_whitelist": ["LLEN"]}}],
142+
[{"cache": _LocalCache(), "kwargs": {"cache_allow_list": ["LLEN"]}}],
143143
indirect=True,
144144
)
145-
async def test_cache_whitelist(self, r):
145+
async def test_cache_allow_list(self, r):
146146
r, cache = r
147147
# add list to redis
148148
await r.lpush("mylist", "foo", "bar", "baz")

‎tests/test_cache.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,10 @@ def test_cache_decode_response(self, r):
139139

140140
@pytest.mark.parametrize(
141141
"r",
142-
[{"cache": _LocalCache(), "kwargs": {"cache_blacklist": ["LLEN"]}}],
142+
[{"cache": _LocalCache(), "kwargs": {"cache_deny_list": ["LLEN"]}}],
143143
indirect=True,
144144
)
145-
def test_cache_blacklist(self, r):
145+
def test_cache_deny_list(self, r):
146146
r, cache = r
147147
# add list to redis
148148
r.lpush("mylist", "foo", "bar", "baz")
@@ -153,10 +153,10 @@ def test_cache_blacklist(self, r):
153153

154154
@pytest.mark.parametrize(
155155
"r",
156-
[{"cache": _LocalCache(), "kwargs": {"cache_whitelist": ["LLEN"]}}],
156+
[{"cache": _LocalCache(), "kwargs": {"cache_allow_list": ["LLEN"]}}],
157157
indirect=True,
158158
)
159-
def test_cache_whitelist(self, r):
159+
def test_cache_allow_list(self, r):
160160
r, cache = r
161161
r.lpush("mylist", "foo", "bar", "baz")
162162
assert r.llen("mylist") == 3

0 commit comments

Comments
 (0)