-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathinterface.py
More file actions
316 lines (280 loc) · 10.7 KB
/
Copy pathinterface.py
File metadata and controls
316 lines (280 loc) · 10.7 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
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: 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
:returns: The value if it exists and is readable, else ``None``.
"""
@abstractmethod
async def delete_async(self, key: str, version: str = None) -> bool:
"""Delete `key` from the cache.
:param key: the key to delete.
:param version: the version for the key
:returns: Whether the key existed and has been deleted.
:rtype: boolean
"""
@abstractmethod
async def set_async(
self,
key: str,
value: t.Any,
ttl: t.Union[float, int] = None,
version: 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 for the key
:param version: the version for the key
:param ttl: the cache ttl for the key in seconds (if not
specified, it uses the default ttl). A ttl of
0 indicates that the cache never expires.
:returns: ``True`` if key has been updated, ``False`` for backend
errors. Pickling errors, however, will raise a subclass of
``pickle.PickleError``.
:rtype: boolean
"""
@abstractmethod
async def touch_async(
self, key: str, ttl: t.Union[float, int] = None, version: str = None
) -> bool:
"""
Update the key's expiry time using ttl. Return True if successful
or False if the key does not exist.
"""
async def has_key_async(self, key: str, version: str = None) -> bool:
"""
Return True if the key is in the cache and has not expired.
"""
@abstractmethod
async def incr_async(self, key: str, delta: int = 1, version: str = None) -> int:
"""
Increments the number stored at key by one. If the key does not exist, it is set to 0
"""
@abstractmethod
async def decr_async(self, key: str, delta: int = 1, version: str = None) -> int:
"""
Decrements the number stored at key by one. If the key does not exist, it is set to 0
"""
class IBaseCacheBackendSync(ABC):
@abstractmethod
def get(self, key: str, version: 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
:returns: The value if it exists and is readable, else ``None``.
"""
@abstractmethod
def delete(self, key: str, version: str = None) -> bool:
"""Delete `key` from the cache.
:param key: the key to delete.
:param version: the version for the key
:returns: Whether the key existed and has been deleted.
:rtype: boolean
"""
@abstractmethod
def set(
self,
key: str,
value: t.Any,
ttl: t.Union[float, int] = None,
version: 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 for the key
:param version: the version for the key
:param ttl: the cache ttl for the key in seconds (if not
specified, it uses the default ttl). A ttl of
0 indicates that the cache never expires.
:returns: ``True`` if key has been updated, ``False`` for backend
errors. Pickling errors, however, will raise a subclass of
``pickle.PickleError``.
:rtype: boolean
"""
@abstractmethod
def touch(
self, key: str, ttl: t.Union[float, int] = None, version: str = None
) -> bool:
"""
Update the key's expiry time using ttl. Return True if successful
or False if the key does not exist.
"""
def has_key(self, key: str, version: str = None) -> bool:
"""
Return True if the key is in the cache and has not expired.
"""
@abstractmethod
def incr(self, key: str, delta: int = 1, version: str = None) -> int:
"""
Increments the number stored at key by one. If the key does not exist, it is set to 0
"""
@abstractmethod
def decr(self, key: str, delta: int = 1, version: str = None) -> int:
"""
Decrements the number stored at key by one. If the key does not exist, it is set to 0
"""
class ICacheServiceSync(ABC):
@abstractmethod
def get(self, key: str, version: str = None, backend: 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: a backend service name
:returns: The value if it exists and is readable, else ``None``.
"""
@abstractmethod
def delete(self, key: str, version: str = None, backend: str = None) -> bool:
"""Delete `key` from the cache.
:param key: the key to delete.
:param version: the version for the key
:param backend: a backend service name
:returns: Whether the key existed and has been deleted.
:rtype: boolean
"""
@abstractmethod
def set(
self,
key: str,
value: t.Any,
ttl: t.Union[float, int] = None,
version: str = None,
backend: 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 for the key
:param version: the version for the key
:param backend: a backend service name
:param ttl: the cache ttl for the key in seconds (if not
specified, it uses the default ttl). A ttl of
0 indicates that the cache never expires.
:returns: ``True`` if key has been updated, ``False`` for backend
errors. Pickling errors, however, will raise a subclass of
``pickle.PickleError``.
:rtype: boolean
"""
@abstractmethod
def touch(
self,
key: str,
ttl: t.Union[float, int] = None,
version: str = None,
backend: str = None,
) -> bool:
"""
Update the key's expiry time using ttl. Return True if successful
or False if the key does not exist.
"""
@abstractmethod
def has_key(self, key: str, version: str = None, backend: str = None) -> bool:
"""
Return True if the key is in the cache and has not expired.
"""
@abstractmethod
def incr(
self, key: str, delta: int = 1, version: str = None, backend: str = None
) -> int:
"""
Increments the number stored at key by one. If the key does not exist, it is set to 0
"""
@abstractmethod
def decr(
self, key: str, delta: int = 1, version: str = None, backend: str = None
) -> int:
"""
Decrements the number stored at key by one. If the key does not exist, it is set to 0
"""
class ICacheServiceAsync(ABC):
@abstractmethod
async def get_async(
self, key: str, version: str = None, backend: 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: a backend service name
:returns: The value if it exists and is readable, else ``None``.
"""
@abstractmethod
async def delete_async(
self, key: str, version: str = None, backend: str = None
) -> bool:
"""Delete `key` from the cache.
:param key: the key to delete.
:param version: the version for the key
:param backend: a backend service name
:returns: Whether the key existed and has been deleted.
:rtype: boolean
"""
@abstractmethod
async def set_async(
self,
key: str,
value: t.Any,
ttl: t.Union[float, int] = None,
version: str = None,
backend: 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 for the key
:param version: the version for the key
:param backend: a backend service name
:param ttl: the cache ttl for the key in seconds (if not
specified, it uses the default ttl). A ttl of
0 indicates that the cache never expires.
:returns: ``True`` if key has been updated, ``False`` for backend
errors. Pickling errors, however, will raise a subclass of
``pickle.PickleError``.
:rtype: boolean
"""
@abstractmethod
async def touch_async(
self,
key: str,
ttl: t.Union[float, int] = None,
version: str = None,
backend: str = None,
) -> bool:
"""
Update the key's expiry time using ttl. Return True if successful
or False if the key does not exist.
"""
@abstractmethod
async def has_key_async(
self, key: str, version: str = None, backend: str = None
) -> bool:
"""
Return True if the key is in the cache and has not expired.
"""
@abstractmethod
async def incr_async(
self, key: str, delta: int = 1, version: str = None, backend: str = None
) -> int:
"""
Increments the number stored at key by one. If the key does not exist, it is set to 0
"""
@abstractmethod
async def decr_async(
self, key: str, delta: int = 1, version: str = None, backend: str = None
) -> int:
"""
Decrements the number stored at key by one. If the key does not exist, it is set to 0
"""
class ICacheService(ICacheServiceSync, ICacheServiceAsync, ABC):
"""Cache Service Interface"""
def get_backend(self, backend: 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
"""