-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathinterface.py
More file actions
440 lines (375 loc) · 14.5 KB
/
Copy pathinterface.py
File metadata and controls
440 lines (375 loc) · 14.5 KB
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
import typing as t
from abc import ABC, abstractmethod
if t.TYPE_CHECKING: # pragma: no cover
from ellar.cache.model import BaseCacheBackend
class IBaseCacheBackendAsync(ABC):
@abstractmethod
async def get_async(self, key: str, version: t.Optional[str] = None) -> t.Any:
"""
Look up key in the cache and return the value for it.
:param key: The key to be looked up.
:param version: The version for the key.
:return: The value if it exists and is readable, else ``None``.
"""
@abstractmethod
async def delete_async(self, key: str, version: t.Optional[str] = None) -> bool:
"""
Delete `key` from the cache.
:param key: The key to delete.
:param version: The version for the key.
:return: Whether the key existed and has been deleted.
"""
@abstractmethod
async def set_async(
self,
key: str,
value: t.Any,
ttl: t.Union[float, int, None] = None,
version: t.Optional[str] = None,
) -> bool:
"""
Add a new key/value to the cache (overwrites value, if key already exists in the cache).
:param key: The key to set.
:param value: The value to be cached.
:param ttl: The cache time-to-live for the key in seconds.
If not specified, the default TTL is used.
A TTL of 0 indicates that the cache never expires.
:param version: The version for the key.
:return: ``True`` if key has been updated, ``False`` for backend errors.
Pickling errors, however, will raise a subclass of ``pickle.PickleError``.
"""
@abstractmethod
async def touch_async(
self,
key: str,
ttl: t.Union[float, int, None] = None,
version: t.Optional[str] = None,
) -> bool:
"""
Update the key's expiry time using ttl.
:param key: The key to update.
:param ttl: The new time-to-live.
:param version: The version for the key.
:return: `True` if successful or `False` if the key does not exist.
"""
@abstractmethod
async def has_key_async(self, key: str, version: t.Optional[str] = None) -> bool:
"""
Return True if the key is in the cache and has not expired.
:param key: The key to check.
:param version: The version for the key.
:return: `True` if key is found and not expired, else `False`.
"""
@abstractmethod
async def incr_async(
self, key: str, delta: int = 1, version: t.Optional[str] = None
) -> int:
"""
Increments the number stored at key by one. If the key does not exist, it is set to 0.
:param key: The key to increment.
:param delta: The amount to increment by.
:param version: The version for the key.
:return: The new value.
"""
@abstractmethod
async def decr_async(
self, key: str, delta: int = 1, version: t.Optional[str] = None
) -> int:
"""
Decrements the number stored at key by one. If the key does not exist, it is set to 0.
:param key: The key to decrement.
:param delta: The amount to decrement by.
:param version: The version for the key.
:return: The new value.
"""
class IBaseCacheBackendSync(ABC):
@abstractmethod
def get(self, key: str, version: t.Optional[str] = None) -> t.Any:
"""
Look up key in the cache and return the value for it.
:param key: The key to be looked up.
:param version: The version for the key.
:return: The value if it exists and is readable, else ``None``.
"""
@abstractmethod
def delete(self, key: str, version: t.Optional[str] = None) -> bool:
"""
Delete `key` from the cache.
:param key: The key to delete.
:param version: The version for the key.
:return: Whether the key existed and has been deleted.
"""
@abstractmethod
def set(
self,
key: str,
value: t.Any,
ttl: t.Union[float, int, None] = None,
version: t.Optional[str] = None,
) -> bool:
"""
Add a new key/value to the cache (overwrites value, if key already exists in the cache).
:param key: The key to set.
:param value: The value to be cached.
:param ttl: The cache time-to-live for the key in seconds.
If not specified, the default TTL is used.
A TTL of 0 indicates that the cache never expires.
:param version: The version for the key.
:return: ``True`` if key has been updated, ``False`` for backend errors.
Pickling errors, however, will raise a subclass of ``pickle.PickleError``.
"""
@abstractmethod
def touch(
self,
key: str,
ttl: t.Union[float, int, None] = None,
version: t.Optional[str] = None,
) -> bool:
"""
Update the key's expiry time using ttl.
:param key: The key to update.
:param ttl: The new time-to-live.
:param version: The version for the key.
:return: `True` if successful or `False` if the key does not exist.
"""
@abstractmethod
def has_key(self, key: str, version: t.Optional[str] = None) -> bool:
"""
Return True if the key is in the cache and has not expired.
:param key: The key to check.
:param version: The version for the key.
:return: `True` if key is found and not expired, else `False`.
"""
@abstractmethod
def incr(self, key: str, delta: int = 1, version: t.Optional[str] = None) -> int:
"""
Increments the number stored at key by one. If the key does not exist, it is set to 0.
:param key: The key to increment.
:param delta: The amount to increment by.
:param version: The version for the key.
:return: The new value.
"""
@abstractmethod
def decr(self, key: str, delta: int = 1, version: t.Optional[str] = None) -> int:
"""
Decrements the number stored at key by one. If the key does not exist, it is set to 0.
:param key: The key to decrement.
:param delta: The amount to decrement by.
:param version: The version for the key.
:return: The new value.
"""
class ICacheServiceSync(ABC):
@abstractmethod
def get(
self, key: str, version: t.Optional[str] = None, backend: t.Optional[str] = None
) -> t.Any:
"""
Look up key in the cache and return the value for it.
:param key: The key to be looked up.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: The value if it exists and is readable, else ``None``.
"""
@abstractmethod
def delete(
self, key: str, version: t.Optional[str] = None, backend: t.Optional[str] = None
) -> bool:
"""
Delete `key` from the cache.
:param key: The key to delete.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: Whether the key existed and has been deleted.
"""
@abstractmethod
def set(
self,
key: str,
value: t.Any,
ttl: t.Union[float, int, None] = None,
version: t.Optional[str] = None,
backend: t.Optional[str] = None,
) -> bool:
"""
Add a new key/value to the cache (overwrites value, if key already exists in the cache).
:param key: The key to set.
:param value: The value to be cached.
:param ttl: The cache time-to-live for the key in seconds.
If not specified, the default TTL is used.
A TTL of 0 indicates that the cache never expires.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: ``True`` if key has been updated, ``False`` for backend errors.
Pickling errors, however, will raise a subclass of ``pickle.PickleError``.
"""
@abstractmethod
def touch(
self,
key: str,
ttl: t.Union[float, int, None] = None,
version: t.Optional[str] = None,
backend: t.Optional[str] = None,
) -> bool:
"""
Update the key's expiry time using ttl.
:param key: The key to update.
:param ttl: The new time-to-live.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: `True` if successful or `False` if the key does not exist.
"""
@abstractmethod
def has_key(
self, key: str, version: t.Optional[str] = None, backend: t.Optional[str] = None
) -> bool:
"""
Return True if the key is in the cache and has not expired.
:param key: The key to check.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: `True` if key is found and not expired, else `False`.
"""
@abstractmethod
def incr(
self,
key: str,
delta: int = 1,
version: t.Optional[str] = None,
backend: t.Optional[str] = None,
) -> int:
"""
Increments the number stored at key by one. If the key does not exist, it is set to 0.
:param key: The key to increment.
:param delta: The amount to increment by.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: The new value.
"""
@abstractmethod
def decr(
self,
key: str,
delta: int = 1,
version: t.Optional[str] = None,
backend: t.Optional[str] = None,
) -> int:
"""
Decrements the number stored at key by one. If the key does not exist, it is set to 0.
:param key: The key to decrement.
:param delta: The amount to decrement by.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: The new value.
"""
class ICacheServiceAsync(ABC):
@abstractmethod
async def get_async(
self, key: str, version: t.Optional[str] = None, backend: t.Optional[str] = None
) -> t.Any:
"""
Look up key in the cache and return the value for it.
:param key: The key to be looked up.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: The value if it exists and is readable, else ``None``.
"""
@abstractmethod
async def delete_async(
self, key: str, version: t.Optional[str] = None, backend: t.Optional[str] = None
) -> bool:
"""
Delete `key` from the cache.
:param key: The key to delete.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: Whether the key existed and has been deleted.
"""
@abstractmethod
async def set_async(
self,
key: str,
value: t.Any,
ttl: t.Union[float, int, None] = None,
version: t.Optional[str] = None,
backend: t.Optional[str] = None,
) -> bool:
"""
Add a new key/value to the cache (overwrites value, if key already exists in the cache).
:param key: The key to set.
:param value: The value to be cached.
:param ttl: The cache time-to-live for the key in seconds.
If not specified, the default TTL is used.
A TTL of 0 indicates that the cache never expires.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: ``True`` if key has been updated, ``False`` for backend errors.
Pickling errors, however, will raise a subclass of ``pickle.PickleError``.
"""
@abstractmethod
async def touch_async(
self,
key: str,
ttl: t.Union[float, int, None] = None,
version: t.Optional[str] = None,
backend: t.Optional[str] = None,
) -> bool:
"""
Update the key's expiry time using ttl.
:param key: The key to update.
:param ttl: The new time-to-live.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: `True` if successful or `False` if the key does not exist.
"""
@abstractmethod
async def has_key_async(
self, key: str, version: t.Optional[str] = None, backend: t.Optional[str] = None
) -> bool:
"""
Return True if the key is in the cache and has not expired.
:param key: The key to check.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: `True` if key is found and not expired, else `False`.
"""
@abstractmethod
async def incr_async(
self,
key: str,
delta: int = 1,
version: t.Optional[str] = None,
backend: t.Optional[str] = None,
) -> int:
"""
Increments the number stored at key by one. If the key does not exist, it is set to 0.
:param key: The key to increment.
:param delta: The amount to increment by.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: The new value.
"""
@abstractmethod
async def decr_async(
self,
key: str,
delta: int = 1,
version: t.Optional[str] = None,
backend: t.Optional[str] = None,
) -> int:
"""
Decrements the number stored at key by one. If the key does not exist, it is set to 0.
:param key: The key to decrement.
:param delta: The amount to decrement by.
:param version: The version for the key.
:param backend: The name of the backend service to use.
:return: The new value.
"""
class ICacheService(ICacheServiceSync, ICacheServiceAsync, ABC):
"""Cache Service Interface"""
@abstractmethod
def get_backend(self, backend: t.Optional[str] = None) -> "BaseCacheBackend":
"""
Return a given Cache Backend configured by configuration backend name.
:param backend: Cache Backend configuration name. If not set, 'default' backend will be returned.
:return: BaseCacheBackend
"""