1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
|
import re
from collections import OrderedDict
from datetime import datetime
from typing import Union
from redis.exceptions import ConnectionError
from ..exceptions import ConnectionInterrupted
from ..hash_ring import HashRing
from ..util import CacheKey
from .default import DEFAULT_TIMEOUT, DefaultClient
class ShardClient(DefaultClient):
_findhash = re.compile(r".*\{(.*)\}.*", re.I)
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
if not isinstance(self._server, (list, tuple)):
self._server = [self._server]
self._ring = HashRing(self._server)
self._serverdict = self.connect()
def get_client(self, *args, **kwargs):
raise NotImplementedError
def connect(self, index=0):
connection_dict = {}
for name in self._server:
connection_dict[name] = self.connection_factory.connect(name)
return connection_dict
def get_server_name(self, _key):
key = str(_key)
g = self._findhash.match(key)
if g is not None and len(g.groups()) > 0:
key = g.groups()[0]
name = self._ring.get_node(key)
return name
def get_server(self, key):
name = self.get_server_name(key)
return self._serverdict[name]
def add(self, key, value, timeout=DEFAULT_TIMEOUT, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().add(
key=key, value=value, version=version, client=client, timeout=timeout
)
def get(self, key, default=None, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().get(key=key, default=default, version=version, client=client)
def get_many(self, keys, version=None):
if not keys:
return {}
recovered_data = OrderedDict()
new_keys = [self.make_key(key, version=version) for key in keys]
map_keys = dict(zip(new_keys, keys))
for key in new_keys:
client = self.get_server(key)
value = self.get(key=key, version=version, client=client)
if value is None:
continue
recovered_data[map_keys[key]] = value
return recovered_data
def set(
self, key, value, timeout=DEFAULT_TIMEOUT, version=None, client=None, nx=False
):
"""
Persist a value to the cache, and set an optional expiration time.
"""
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().set(
key=key, value=value, timeout=timeout, version=version, client=client, nx=nx
)
def set_many(self, data, timeout=DEFAULT_TIMEOUT, version=None):
"""
Set a bunch of values in the cache at once from a dict of key/value
pairs. This is much more efficient than calling set() multiple times.
If timeout is given, that timeout will be used for the key; otherwise
the default cache timeout will be used.
"""
for key, value in data.items():
self.set(key, value, timeout, version=version)
def has_key(self, key, version=None, client=None):
"""
Test if key exists.
"""
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
key = self.make_key(key, version=version)
try:
return client.exists(key) == 1
except ConnectionError as e:
raise ConnectionInterrupted(connection=client) from e
def delete(self, key, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().delete(key=key, version=version, client=client)
def ttl(self, key, version=None, client=None):
"""
Executes TTL redis command and return the "time-to-live" of specified key.
If key is a non volatile key, it returns None.
"""
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().ttl(key=key, version=version, client=client)
def pttl(self, key, version=None, client=None):
"""
Executes PTTL redis command and return the "time-to-live" of specified key
in milliseconds. If key is a non volatile key, it returns None.
"""
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().pttl(key=key, version=version, client=client)
def persist(self, key, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().persist(key=key, version=version, client=client)
def expire(self, key, timeout, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().expire(key=key, timeout=timeout, version=version, client=client)
def pexpire(self, key, timeout, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().pexpire(key=key, timeout=timeout, version=version, client=client)
def pexpire_at(self, key, when: Union[datetime, int], version=None, client=None):
"""
Set an expire flag on a ``key`` to ``when`` on a shard client.
``when`` which can be represented as an integer indicating unix
time or a Python datetime object.
"""
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().pexpire_at(key=key, when=when, version=version, client=client)
def expire_at(self, key, when: Union[datetime, int], version=None, client=None):
"""
Set an expire flag on a ``key`` to ``when`` on a shard client.
``when`` which can be represented as an integer indicating unix
time or a Python datetime object.
"""
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().expire_at(key=key, when=when, version=version, client=client)
def lock(
self,
key,
version=None,
timeout=None,
sleep=0.1,
blocking_timeout=None,
client=None,
thread_local=True,
):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
key = self.make_key(key, version=version)
return super().lock(
key,
timeout=timeout,
sleep=sleep,
client=client,
blocking_timeout=blocking_timeout,
thread_local=thread_local,
)
def delete_many(self, keys, version=None):
"""
Remove multiple keys at once.
"""
res = 0
for key in [self.make_key(k, version=version) for k in keys]:
client = self.get_server(key)
res += self.delete(key, client=client)
return res
def incr_version(self, key, delta=1, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
if version is None:
version = self._backend.version
old_key = self.make_key(key, version)
value = self.get(old_key, version=version, client=client)
try:
ttl = self.ttl(old_key, version=version, client=client)
except ConnectionError as e:
raise ConnectionInterrupted(connection=client) from e
if value is None:
raise ValueError("Key '%s' not found" % key)
if isinstance(key, CacheKey):
new_key = self.make_key(key.original_key(), version=version + delta)
else:
new_key = self.make_key(key, version=version + delta)
self.set(new_key, value, timeout=ttl, client=self.get_server(new_key))
self.delete(old_key, client=client)
return version + delta
def incr(self, key, delta=1, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().incr(key=key, delta=delta, version=version, client=client)
def decr(self, key, delta=1, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().decr(key=key, delta=delta, version=version, client=client)
def iter_keys(self, key, version=None):
raise NotImplementedError("iter_keys not supported on sharded client")
def keys(self, search, version=None):
pattern = self.make_pattern(search, version=version)
keys = []
try:
for server, connection in self._serverdict.items():
keys.extend(connection.keys(pattern))
except ConnectionError as e:
# FIXME: technically all clients should be passed as `connection`.
client = self.get_server(pattern)
raise ConnectionInterrupted(connection=client) from e
return [self.reverse_key(k.decode()) for k in keys]
def delete_pattern(
self, pattern, version=None, client=None, itersize=None, prefix=None
):
"""
Remove all keys matching pattern.
"""
pattern = self.make_pattern(pattern, version=version, prefix=prefix)
kwargs = {"match": pattern}
if itersize:
kwargs["count"] = itersize
keys = []
for server, connection in self._serverdict.items():
keys.extend(key for key in connection.scan_iter(**kwargs))
res = 0
if keys:
for server, connection in self._serverdict.items():
res += connection.delete(*keys)
return res
def do_close_clients(self):
for client in self._serverdict.values():
self.disconnect(client=client)
def touch(self, key, timeout=DEFAULT_TIMEOUT, version=None, client=None):
if client is None:
key = self.make_key(key, version=version)
client = self.get_server(key)
return super().touch(key=key, timeout=timeout, version=version, client=client)
def clear(self, client=None):
for connection in self._serverdict.values():
connection.flushdb()
|
