Python cache decorator and other itils with support for Redis or KeyDB
Project description
redis-cached
Python cache decorator that uses Redis or KeyDB as storage. This is very handy for replicated apps (e.g. Kubernetes), AWS Lambda functions, and other stateless apps.
Features:
- Function result and kwarg values are pickled, so you can work with complex structures like pydantic's
BaseModel
- Prevents multiple simultaneous cache updates when a function is called concurrently and there is no cached value.
- Cache invalidation is available
Limitations:
- Only async functions are supported.
- Only keyword arguments are supported. It will raise an error if you pass non-kwargs while calling your function.
Installation
pip install redis_cached
Usage
Basic usage:
import asyncio
from redis_cached import cached, invalidate_cache
@cached(5)
async def add_one(x):
return x + 1
async def main():
result = await add_one(x=2) # result is cached for 5 seconds
# Pass the same kwargs to this func to invalidate the cache
await invalidate_cache('add_one', x=2)
asyncio.run(main())
Optionally, add salt to the decorator to avoid clashing with the same-named functions in other modules or other apps that use the same Redis or KeyDB database:
import asyncio
from redis_cached import cached, invalidate_cache
CACHE_SALT = 'XnsJ-7C9PIU0qhDwh9YhJQ'
@cached(5, cache_key_salt=CACHE_SALT)
async def add_one(x):
return x + 1
async def invalidate_add_one(**kwargs):
await invalidate_cache('add_one', cache_key_salt=CACHE_SALT, **kwargs)
async def main():
result = await add_one(x=2) # cached
await invalidate_add_one(x=2) # invalidated
asyncio.run(main())
Contributing
Contributions are welcome. Please refer to maintenance readme for more details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
redis_cached-0.2.0.tar.gz
(3.6 kB
view details)
Built Distribution
File details
Details for the file redis_cached-0.2.0.tar.gz
.
File metadata
- Download URL: redis_cached-0.2.0.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.11.3 Darwin/23.2.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa61730008880038dbf454fd6c5daaad685932299f4d71b8f2da31534ae4034d |
|
MD5 | 16ebe80012b864f505568a117a3d47a4 |
|
BLAKE2b-256 | ebec7a27d30f87a08c0161e58e5d89c3d7e149dbfe8051b4137357fb9046fb27 |
File details
Details for the file redis_cached-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: redis_cached-0.2.0-py3-none-any.whl
- Upload date:
- Size: 4.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.11.3 Darwin/23.2.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0a7545920d05db5e2126a10e3837bda0182c95cf154d218b511101849bce17e |
|
MD5 | f16cdb06ea3603b3cc86619da0513d2a |
|
BLAKE2b-256 | 7c5054758958b9563f494f8c6ed18ab80294ebf2761c1c09563459ad123cc0f9 |