Pular para conteúdo

Backend

cachetoolz.backend

Module interface.

cachetoolz.backend.AsyncInMemory

Bases: AsyncBackendABC

Async in memory backend.

This backend is used to store caches in memory asynchronous.

Source code in cachetoolz/backend/inmemory.py 
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
class AsyncInMemory(AsyncBackendABC):
    """
    Async in memory backend.

    This backend is used to store caches in memory asynchronous.
    """

    def __init__(self):
        """Initialize the instance."""
        self._store: Store = defaultdict(lambda: {})
        self._lock: Lock = Lock()

    def __repr__(self):
        """Creates a visual representation of the instance."""
        store = walk_values(
            partial(walk_values, asdict), dict(self._store.items())
        )
        return f'AsyncInMemory({store})'

    async def get(self, key: str) -> Optional[str]:
        """
        Get a value if not expired.

        Parameters
        ----------
        key : str
            Cache identifier key.

        Returns
        -------
        with_cache : Any
            Value cached.
        without_cache : None
            If not exists or expired.
        """
        self.logger.debug("Get 'key=%s'", key)

        namespace, key_hash = self._separate_namespace(key)

        async with self._lock:
            if cached := self._store[namespace].get(key_hash):
                if cached.expires_at >= datetime.now():
                    return cached.value
                del self._store[namespace][key_hash]

        self.logger.debug("No cache to 'key=%s'", key)
        return None

    async def set(self, key: str, value: str, expires_at: timedelta) -> None:
        """
        Set a value with expires time.

        Parameters
        ----------
        key : str
            Cache identifier key.
        value : str
            Value to cache encoded.
        expires_at : datetime.timedelta
            Expiry time.
        """
        self.logger.debug(
            "Set 'key=%s', 'value=%s', 'expires_at=%s'",
            key,
            value,
            expires_at,
        )

        namespace, key_hash = self._separate_namespace(key)

        async with self._lock:
            self._store[namespace][key_hash] = Cached(
                value=value,
                expires_at=datetime.now() + expires_at,
            )

    async def clear(self, namespace: str) -> None:
        """
        Clear a namespace.

        Parameters
        ----------
        namespace : str
            Namespace to cache.
        """
        self.logger.debug("Clear 'namespace=%s'", namespace)

        async with self._lock:
            self._store.pop(namespace, None)

get(key: str) -> Optional[str] async

Get a value if not expired.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required

Returns:

Name Type Description
with_cache Any

Value cached.
without_cache None

If not exists or expired.
Source code in cachetoolz/backend/inmemory.py 
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
async def get(self, key: str) -> Optional[str]:
    """
    Get a value if not expired.

    Parameters
    ----------
    key : str
        Cache identifier key.

    Returns
    -------
    with_cache : Any
        Value cached.
    without_cache : None
        If not exists or expired.
    """
    self.logger.debug("Get 'key=%s'", key)

    namespace, key_hash = self._separate_namespace(key)

    async with self._lock:
        if cached := self._store[namespace].get(key_hash):
            if cached.expires_at >= datetime.now():
                return cached.value
            del self._store[namespace][key_hash]

    self.logger.debug("No cache to 'key=%s'", key)
    return None

set(key: str, value: str, expires_at: timedelta) -> None async

Set a value with expires time.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required
value str

Value to cache encoded.

 required
expires_at datetime.timedelta

Expiry time.

 required
Source code in cachetoolz/backend/inmemory.py 
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
async def set(self, key: str, value: str, expires_at: timedelta) -> None:
    """
    Set a value with expires time.

    Parameters
    ----------
    key : str
        Cache identifier key.
    value : str
        Value to cache encoded.
    expires_at : datetime.timedelta
        Expiry time.
    """
    self.logger.debug(
        "Set 'key=%s', 'value=%s', 'expires_at=%s'",
        key,
        value,
        expires_at,
    )

    namespace, key_hash = self._separate_namespace(key)

    async with self._lock:
        self._store[namespace][key_hash] = Cached(
            value=value,
            expires_at=datetime.now() + expires_at,
        )

clear(namespace: str) -> None async

Clear a namespace.

Parameters:

Name Type Description Default
namespace str

Namespace to cache.

 required
Source code in cachetoolz/backend/inmemory.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
async def clear(self, namespace: str) -> None:
    """
    Clear a namespace.

    Parameters
    ----------
    namespace : str
        Namespace to cache.
    """
    self.logger.debug("Clear 'namespace=%s'", namespace)

    async with self._lock:
        self._store.pop(namespace, None)

cachetoolz.backend.InMemory

Bases: BackendABC

In memory backend.

This backend is used to store caches in memory synchronous.

Source code in cachetoolz/backend/inmemory.py 
 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
class InMemory(BackendABC):
    """
    In memory backend.

    This backend is used to store caches in memory synchronous.
    """

    def __init__(self):
        """Initialize the instance."""
        self._store: Store = defaultdict(lambda: {})

    def __repr__(self):
        """Creates a visual representation of the instance."""
        store = walk_values(
            partial(walk_values, asdict), dict(self._store.items())
        )
        return f'InMemory({store})'

    def get(self, key: str) -> Any:
        """
        Get a value if not expired.

        Parameters
        ----------
        key : str
            Cache identifier key.

        Returns
        -------
        with_cache : Any
            Value cached.
        without_cache : None
            If not exists or expired.
        """
        self.logger.debug("Get 'key=%s'", key)

        namespace, key_hash = self._separate_namespace(key)

        if cached := self._store[namespace].get(key_hash):
            if cached.expires_at >= datetime.now():
                return cached.value

            del self._store[namespace][key_hash]

        self.logger.debug("No cache to 'key=%s'", key)

    def set(self, key: str, value: str, expires_at: timedelta) -> None:
        """
        Set a value with expires time.

        Parameters
        ----------
        key : str
            Cache identifier key.
        value : str
            Value to cache encoded.
        expires_at : datetime.timedelta
            Expiry time.
        """
        self.logger.debug(
            "Set 'key=%s', 'value=%s', 'expires_at=%s'",
            key,
            value,
            expires_at,
        )

        namespace, key_hash = self._separate_namespace(key)

        self._store[namespace][key_hash] = Cached(
            value=value,
            expires_at=datetime.now() + expires_at,
        )

    def clear(self, namespace: str) -> None:
        """
        Clear a namespace.

        Parameters
        ----------
        namespace : str
            Namespace to cache.
        """
        self.logger.debug("Clear 'namespace=%s'", namespace)

        self._store.pop(namespace)

get(key: str) -> Any

Get a value if not expired.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required

Returns:

Name Type Description
with_cache Any

Value cached.
without_cache None

If not exists or expired.
Source code in cachetoolz/backend/inmemory.py 
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
def get(self, key: str) -> Any:
    """
    Get a value if not expired.

    Parameters
    ----------
    key : str
        Cache identifier key.

    Returns
    -------
    with_cache : Any
        Value cached.
    without_cache : None
        If not exists or expired.
    """
    self.logger.debug("Get 'key=%s'", key)

    namespace, key_hash = self._separate_namespace(key)

    if cached := self._store[namespace].get(key_hash):
        if cached.expires_at >= datetime.now():
            return cached.value

        del self._store[namespace][key_hash]

    self.logger.debug("No cache to 'key=%s'", key)

set(key: str, value: str, expires_at: timedelta) -> None

Set a value with expires time.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required
value str

Value to cache encoded.

 required
expires_at datetime.timedelta

Expiry time.

 required
Source code in cachetoolz/backend/inmemory.py 
 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
def set(self, key: str, value: str, expires_at: timedelta) -> None:
    """
    Set a value with expires time.

    Parameters
    ----------
    key : str
        Cache identifier key.
    value : str
        Value to cache encoded.
    expires_at : datetime.timedelta
        Expiry time.
    """
    self.logger.debug(
        "Set 'key=%s', 'value=%s', 'expires_at=%s'",
        key,
        value,
        expires_at,
    )

    namespace, key_hash = self._separate_namespace(key)

    self._store[namespace][key_hash] = Cached(
        value=value,
        expires_at=datetime.now() + expires_at,
    )

clear(namespace: str) -> None

Clear a namespace.

Parameters:

Name Type Description Default
namespace str

Namespace to cache.

 required
Source code in cachetoolz/backend/inmemory.py 
118
119
120
121
122
123
124
125
126
127
128
129
def clear(self, namespace: str) -> None:
    """
    Clear a namespace.

    Parameters
    ----------
    namespace : str
        Namespace to cache.
    """
    self.logger.debug("Clear 'namespace=%s'", namespace)

    self._store.pop(namespace)

cachetoolz.backend.AsyncMongoBackend

Bases: AsyncBackendABC

Async MongoDB cache.

This backend is used to store caches mongo asynchronous.

Parameters:

Name Type Description Default
host str

MongoDB URI.

 'localhost'
database str

Cache database name.

 '.cachetoolz'
**kwargs Any

Takes the same constructor arguments as pymongo.mongo_client.MongoClient.

 {}
Source code in cachetoolz/backend/mongo.py 
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
class AsyncMongoBackend(AsyncBackendABC):
    """
    Async MongoDB cache.

    This backend is used to store caches mongo asynchronous.

    Parameters
    ----------
    host : str
        MongoDB URI.
    database : str
        Cache database name.
    **kwargs : Any
        Takes the same constructor arguments as
        `pymongo.mongo_client.MongoClient`.
    """

    def __init__(
        self,
        host: str = 'localhost',
        database: str = '.cachetoolz',
        **kwargs: Any,
    ):
        """Initialize the instance."""
        try:
            from motor.motor_asyncio import AsyncIOMotorClient
        except ImportError as exc:  # pragma: no cover
            raise RuntimeError(
                "Install cachetoolz with the 'mongo' extra in order "
                "to use mongo backend."
            ) from exc

        self._client_cls = AsyncIOMotorClient
        self._kwargs = kwargs
        self._kwargs['host'] = host

        self._host = host
        self._database = database

    def __repr__(self):
        """Creates a visual representation of the instance."""
        _cls = self.__class__.__name__
        return f'{_cls}(host="{self._host}", database="{self._database}")'

    @contextmanager
    def _get_database_or_collection(self, collection=None):
        client = self._client_cls(**self._kwargs)
        try:
            if collection:
                yield client[self._database][collection]
            else:
                yield client[self._database]
        finally:
            client.close()

    async def get(self, key: str) -> Any:
        """
        Get a value if not expired.

        Parameters
        ----------
        key : str
            Cache identifier key.

        Returns
        -------
        with_cache : Any
            Value cached.
        without_cache : None
            If not exists or expired.
        """
        self.logger.debug("Get 'key=%s'", key)

        namespace, key_hash = self._separate_namespace(key)

        with self._get_database_or_collection(namespace) as collection:
            doc = await collection.find_one({'key': key_hash})

        if doc and doc['expires_at'] >= datetime.now():
            return doc['value']

        self.logger.debug("No cache to 'key=%s'", key)

    async def set(self, key: str, value: str, expires_at: timedelta) -> None:
        """
        Set a value with expires time.

        Parameters
        ----------
        key : str
            Cache identifier key.
        value : str
            Value to cache encoded.
        expires_at : datetime.timedelta
            Expiry time.
        """
        self.logger.debug(
            "Set 'key=%s', 'value=%s', 'expires_at=%s'",
            key,
            value,
            expires_at,
        )

        namespace, key_hash = self._separate_namespace(key)

        with self._get_database_or_collection(namespace) as collection:
            await collection.create_index('expires_at', expireAfterSeconds=0)

            await collection.update_one(
                {'key': key_hash},
                {
                    '$set': {
                        'key': key_hash,
                        'value': value,
                        'expires_at': datetime.now() + expires_at,
                    },
                },
                upsert=True,
            )

    async def clear(self, namespace: str) -> None:
        """
        Clear a namespace.

        Parameters
        ----------
        namespace : str
            Namespace to cache.
        """
        self.logger.debug("Clear 'namespace=%s'", namespace)

        with self._get_database_or_collection() as database:
            await database.drop_collection(namespace)

get(key: str) -> Any async

Get a value if not expired.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required

Returns:

Name Type Description
with_cache Any

Value cached.
without_cache None

If not exists or expired.
Source code in cachetoolz/backend/mongo.py 
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
async def get(self, key: str) -> Any:
    """
    Get a value if not expired.

    Parameters
    ----------
    key : str
        Cache identifier key.

    Returns
    -------
    with_cache : Any
        Value cached.
    without_cache : None
        If not exists or expired.
    """
    self.logger.debug("Get 'key=%s'", key)

    namespace, key_hash = self._separate_namespace(key)

    with self._get_database_or_collection(namespace) as collection:
        doc = await collection.find_one({'key': key_hash})

    if doc and doc['expires_at'] >= datetime.now():
        return doc['value']

    self.logger.debug("No cache to 'key=%s'", key)

set(key: str, value: str, expires_at: timedelta) -> None async

Set a value with expires time.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required
value str

Value to cache encoded.

 required
expires_at datetime.timedelta

Expiry time.

 required
Source code in cachetoolz/backend/mongo.py 
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
async def set(self, key: str, value: str, expires_at: timedelta) -> None:
    """
    Set a value with expires time.

    Parameters
    ----------
    key : str
        Cache identifier key.
    value : str
        Value to cache encoded.
    expires_at : datetime.timedelta
        Expiry time.
    """
    self.logger.debug(
        "Set 'key=%s', 'value=%s', 'expires_at=%s'",
        key,
        value,
        expires_at,
    )

    namespace, key_hash = self._separate_namespace(key)

    with self._get_database_or_collection(namespace) as collection:
        await collection.create_index('expires_at', expireAfterSeconds=0)

        await collection.update_one(
            {'key': key_hash},
            {
                '$set': {
                    'key': key_hash,
                    'value': value,
                    'expires_at': datetime.now() + expires_at,
                },
            },
            upsert=True,
        )

clear(namespace: str) -> None async

Clear a namespace.

Parameters:

Name Type Description Default
namespace str

Namespace to cache.

 required
Source code in cachetoolz/backend/mongo.py 
267
268
269
270
271
272
273
274
275
276
277
278
279
async def clear(self, namespace: str) -> None:
    """
    Clear a namespace.

    Parameters
    ----------
    namespace : str
        Namespace to cache.
    """
    self.logger.debug("Clear 'namespace=%s'", namespace)

    with self._get_database_or_collection() as database:
        await database.drop_collection(namespace)

cachetoolz.backend.MongoBackend

Bases: BackendABC

MongoDB cache.

This backend is used to store caches mongo synchronous.

Parameters:

Name Type Description Default
host str

MongoDB URI.

 'localhost'
database str

Cache database name.

 '.cachetoolz'
**kwargs Any

Takes the same constructor arguments as pymongo.mongo_client.MongoClient.

 {}
Source code in cachetoolz/backend/mongo.py 
 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
class MongoBackend(BackendABC):
    """
    MongoDB cache.

    This backend is used to store caches mongo synchronous.

    Parameters
    ----------
    host : str
        MongoDB URI.
    database : str
        Cache database name.
    **kwargs : Any
        Takes the same constructor arguments as
        `pymongo.mongo_client.MongoClient`.
    """

    def __init__(
        self,
        host: str = 'localhost',
        database: str = '.cachetoolz',
        **kwargs: Any,
    ):
        """Initialize the instance."""
        try:
            from pymongo import MongoClient
        except ImportError as exc:  # pragma: no cover
            raise RuntimeError(
                "Install cachetoolz with the 'mongo' extra in order "
                "to use mongo backend."
            ) from exc

        self._client_cls = MongoClient
        self._kwargs = kwargs

        self._kwargs['host'] = host

        self._host = host
        self._database = database

    def __repr__(self):
        """Creates a visual representation of the instance."""
        _cls = self.__class__.__name__
        return f'{_cls}(host="{self._host}", database="{self._database}")'

    @contextmanager
    def _get_database_or_collection(self, collection=None):
        from pymongo import MongoClient

        client: MongoClient
        with self._client_cls(**self._kwargs) as client:
            # client = cast(MongoClient, client)
            if collection:
                yield client[self._database][collection]
            else:
                yield client[self._database]

    def get(self, key: str) -> Any:
        """
        Get a value if not expired.

        Parameters
        ----------
        key : str
            Cache identifier key.

        Returns
        -------
        with_cache : Any
            Value cached.
        without_cache : None
            If not exists or expired.
        """
        self.logger.debug("Get 'key=%s'", key)

        namespace, key_hash = self._separate_namespace(key)

        with self._get_database_or_collection(namespace) as collection:
            doc = collection.find_one({'key': key_hash})

        if doc and doc['expires_at'] >= datetime.now():
            return doc['value']

        self.logger.debug("No cache to 'key=%s'", key)

    def set(self, key: str, value: str, expires_at: timedelta) -> None:
        """
        Set a value with expires time.

        Parameters
        ----------
        key : str
            Cache identifier key.
        value : str
            Value to cache encoded.
        expires_at : datetime.timedelta
            Expiry time.
        """
        self.logger.debug(
            "Set 'key=%s', 'value=%s', 'expires_at=%s'",
            key,
            value,
            expires_at,
        )

        namespace, key_hash = self._separate_namespace(key)

        with self._get_database_or_collection(namespace) as collection:
            collection.create_index('expires_at', expireAfterSeconds=0)

            collection.update_one(
                {'key': key_hash},
                {
                    '$set': {
                        'key': key_hash,
                        'value': value,
                        'expires_at': datetime.now() + expires_at,
                    },
                },
                upsert=True,
            )

    def clear(self, namespace: str) -> None:
        """
        Clear a namespace.

        Parameters
        ----------
        namespace : str
            Namespace to cache.
        """
        self.logger.debug("Clear 'namespace=%s'", namespace)

        with self._get_database_or_collection() as database:
            database.drop_collection(namespace)

get(key: str) -> Any

Get a value if not expired.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required

Returns:

Name Type Description
with_cache Any

Value cached.
without_cache None

If not exists or expired.
Source code in cachetoolz/backend/mongo.py 
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
def get(self, key: str) -> Any:
    """
    Get a value if not expired.

    Parameters
    ----------
    key : str
        Cache identifier key.

    Returns
    -------
    with_cache : Any
        Value cached.
    without_cache : None
        If not exists or expired.
    """
    self.logger.debug("Get 'key=%s'", key)

    namespace, key_hash = self._separate_namespace(key)

    with self._get_database_or_collection(namespace) as collection:
        doc = collection.find_one({'key': key_hash})

    if doc and doc['expires_at'] >= datetime.now():
        return doc['value']

    self.logger.debug("No cache to 'key=%s'", key)

set(key: str, value: str, expires_at: timedelta) -> None

Set a value with expires time.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required
value str

Value to cache encoded.

 required
expires_at datetime.timedelta

Expiry time.

 required
Source code in cachetoolz/backend/mongo.py 
 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
def set(self, key: str, value: str, expires_at: timedelta) -> None:
    """
    Set a value with expires time.

    Parameters
    ----------
    key : str
        Cache identifier key.
    value : str
        Value to cache encoded.
    expires_at : datetime.timedelta
        Expiry time.
    """
    self.logger.debug(
        "Set 'key=%s', 'value=%s', 'expires_at=%s'",
        key,
        value,
        expires_at,
    )

    namespace, key_hash = self._separate_namespace(key)

    with self._get_database_or_collection(namespace) as collection:
        collection.create_index('expires_at', expireAfterSeconds=0)

        collection.update_one(
            {'key': key_hash},
            {
                '$set': {
                    'key': key_hash,
                    'value': value,
                    'expires_at': datetime.now() + expires_at,
                },
            },
            upsert=True,
        )

clear(namespace: str) -> None

Clear a namespace.

Parameters:

Name Type Description Default
namespace str

Namespace to cache.

 required
Source code in cachetoolz/backend/mongo.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
def clear(self, namespace: str) -> None:
    """
    Clear a namespace.

    Parameters
    ----------
    namespace : str
        Namespace to cache.
    """
    self.logger.debug("Clear 'namespace=%s'", namespace)

    with self._get_database_or_collection() as database:
        database.drop_collection(namespace)

cachetoolz.backend.AsyncRedisBackend

Bases: AsyncBackendABC

Async Redis backend.

This backend is used to store caches redis asynchronous.

Parameters:

Name Type Description Default
url str

Redis url.

 'redis://localhost:6379'
**kwargs Any

Takes the same constructor arguments as redis.asyncio. client.Redis.from_url. The decode_responses parameter will always be True as the result needs to be returned as a string.

 {}
Source code in cachetoolz/backend/redis.py 
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
class AsyncRedisBackend(AsyncBackendABC):
    """
    Async Redis backend.

    This backend is used to store caches redis asynchronous.

    Parameters
    ----------
    url : str, default='redis://localhost:6379'
        Redis url.
    **kwargs : Any
        Takes the same constructor arguments as
        `redis.asyncio. client.Redis.from_url`.
        The ``decode_responses`` parameter will always be True
        as the result needs to be returned as a string.
    """

    def __init__(self, url: str = 'redis://localhost:6379', **kwargs: Any):
        """Initialize the instance."""
        try:
            from redis.asyncio import Redis
        except ImportError as exc:  # pragma: no cover
            raise RuntimeError(
                "Install cachetoolz with the 'redis' extra in order "
                "to use redis backend."
            ) from exc

        self._url = url
        kwargs['decode_responses'] = True
        self._backend = Redis.from_url(self._url, **kwargs)

    def __repr__(self):
        """Creates a visual representation of the instance."""
        return f'{self.__class__.__name__}(url="{self._url}")'

    async def get(self, key: str) -> Optional[Any]:
        """
        Get a value if not expired.

        Parameters
        -----------
        key : str
            Cache identifier key.

        Returns
        -------
        with_cache : Any
            Value cached.
        without_cache : None
            If not exists or expired.
        """
        self.logger.debug("Get 'key=%s'", key)

        if result := await self._backend.get(key):
            return result

        self.logger.debug("No cache to 'key=%s'", key)
        return None

    async def set(self, key: str, value: str, expires_at: timedelta) -> None:
        """
        Set a value with expires time.

        Parameters
        ----------
        key : str
            Cache identifier key.
        value : str
            Value to cache encoded.
        expires_at : datetime.timedelta
            Expiry time.
        """
        self.logger.debug(
            "Set 'key=%s', 'value=%s', 'expires_at=%s'",
            key,
            value,
            expires_at,
        )

        await self._backend.set(key, str(value), ex=expires_at)

    async def clear(self, namespace: str) -> None:
        """
        Clear a namespace.

        Parameters
        ----------
        namespace : str
            Namespace to cache.
        """
        self.logger.debug("Clear 'namespace=%s'", namespace)

        async for key in self._backend.scan_iter(f'{namespace}:*'):
            await self._backend.delete(key)

get(key: str) -> Optional[Any] async

Get a value if not expired.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required

Returns:

Name Type Description
with_cache Any

Value cached.
without_cache None

If not exists or expired.
Source code in cachetoolz/backend/redis.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
async def get(self, key: str) -> Optional[Any]:
    """
    Get a value if not expired.

    Parameters
    -----------
    key : str
        Cache identifier key.

    Returns
    -------
    with_cache : Any
        Value cached.
    without_cache : None
        If not exists or expired.
    """
    self.logger.debug("Get 'key=%s'", key)

    if result := await self._backend.get(key):
        return result

    self.logger.debug("No cache to 'key=%s'", key)
    return None

set(key: str, value: str, expires_at: timedelta) -> None async

Set a value with expires time.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required
value str

Value to cache encoded.

 required
expires_at datetime.timedelta

Expiry time.

 required
Source code in cachetoolz/backend/redis.py 
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
async def set(self, key: str, value: str, expires_at: timedelta) -> None:
    """
    Set a value with expires time.

    Parameters
    ----------
    key : str
        Cache identifier key.
    value : str
        Value to cache encoded.
    expires_at : datetime.timedelta
        Expiry time.
    """
    self.logger.debug(
        "Set 'key=%s', 'value=%s', 'expires_at=%s'",
        key,
        value,
        expires_at,
    )

    await self._backend.set(key, str(value), ex=expires_at)

clear(namespace: str) -> None async

Clear a namespace.

Parameters:

Name Type Description Default
namespace str

Namespace to cache.

 required
Source code in cachetoolz/backend/redis.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
async def clear(self, namespace: str) -> None:
    """
    Clear a namespace.

    Parameters
    ----------
    namespace : str
        Namespace to cache.
    """
    self.logger.debug("Clear 'namespace=%s'", namespace)

    async for key in self._backend.scan_iter(f'{namespace}:*'):
        await self._backend.delete(key)

cachetoolz.backend.RedisBackend

Bases: BackendABC

Redis cache.

Parameters:

Name Type Description Default
url str

Redis url.

 'redis://localhost:6379'
**kwargs Any

Takes the same constructor arguments as redis.client.Redis.from_url. The decode_responses parameter will always be True as the result needs to be returned as a string.

 {}
Source code in cachetoolz/backend/redis.py 
  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
class RedisBackend(BackendABC):
    """
    Redis cache.

    Parameters
    ----------
    url : str, default='redis://localhost:6379'
        Redis url.
    **kwargs : Any
        Takes the same constructor arguments as
        `redis.client.Redis.from_url`.
        The ``decode_responses`` parameter will always be True
        as the result needs to be returned as a string.
    """

    def __init__(self, url: str = 'redis://localhost:6379', **kwargs: Any):
        """Initialize the instance."""
        try:
            from redis import Redis
        except ImportError as exc:  # pragma: no cover
            raise RuntimeError(
                "Install cachetoolz with the 'redis' extra in order "
                "to use redis backend."
            ) from exc

        self._url = url
        kwargs['decode_responses'] = True
        self._backend = Redis.from_url(self._url, **kwargs)

    def __repr__(self):
        """Creates a visual representation of the instance."""
        return f'{self.__class__.__name__}(url="{self._url}")'

    def get(self, key: str) -> Optional[Any]:
        """
        Get a value if not expired.

        Parameters
        ----------
        key : str
            Cache identifier key.

        Returns
        -------
        with_cache : Any
            Value cached.
        without_cache : None
            If not exists or expired.
        """
        self.logger.debug("Get 'key=%s'", key)

        if result := self._backend.get(key):
            return result

        self.logger.debug("No cache to 'key=%s'", key)
        return None

    def set(self, key: str, value: str, expires_at: timedelta) -> None:
        """
        Set a value with expires time.

        Parameters
        ----------
        key : str
            Cache identifier key.
        value : str
            Value to cache encoded.
        expires_at : datetime.timedelta
            Expiry time.
        """
        self.logger.debug(
            "Set 'key=%s', 'value=%s', 'expires_at=%s'",
            key,
            value,
            expires_at,
        )

        self._backend.set(key, str(value), ex=expires_at)

    def clear(self, namespace: str) -> None:
        """
        Clear a namespace.

        Parameters
        ----------
        namespace : str
            Namespace to cache.
        """
        self.logger.debug("Clear 'namespace=%s'", namespace)

        for key in self._backend.scan_iter(f'{namespace}:*'):
            self._backend.delete(key)

get(key: str) -> Optional[Any]

Get a value if not expired.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required

Returns:

Name Type Description
with_cache Any

Value cached.
without_cache None

If not exists or expired.
Source code in cachetoolz/backend/redis.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def get(self, key: str) -> Optional[Any]:
    """
    Get a value if not expired.

    Parameters
    ----------
    key : str
        Cache identifier key.

    Returns
    -------
    with_cache : Any
        Value cached.
    without_cache : None
        If not exists or expired.
    """
    self.logger.debug("Get 'key=%s'", key)

    if result := self._backend.get(key):
        return result

    self.logger.debug("No cache to 'key=%s'", key)
    return None

set(key: str, value: str, expires_at: timedelta) -> None

Set a value with expires time.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required
value str

Value to cache encoded.

 required
expires_at datetime.timedelta

Expiry time.

 required
Source code in cachetoolz/backend/redis.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def set(self, key: str, value: str, expires_at: timedelta) -> None:
    """
    Set a value with expires time.

    Parameters
    ----------
    key : str
        Cache identifier key.
    value : str
        Value to cache encoded.
    expires_at : datetime.timedelta
        Expiry time.
    """
    self.logger.debug(
        "Set 'key=%s', 'value=%s', 'expires_at=%s'",
        key,
        value,
        expires_at,
    )

    self._backend.set(key, str(value), ex=expires_at)

clear(namespace: str) -> None

Clear a namespace.

Parameters:

Name Type Description Default
namespace str

Namespace to cache.

 required
Source code in cachetoolz/backend/redis.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def clear(self, namespace: str) -> None:
    """
    Clear a namespace.

    Parameters
    ----------
    namespace : str
        Namespace to cache.
    """
    self.logger.debug("Clear 'namespace=%s'", namespace)

    for key in self._backend.scan_iter(f'{namespace}:*'):
        self._backend.delete(key)