Lazy cache updates for Django
Project description
django-update-cache
Lazy cache updates for Django.
Rationale
Cache function results with optional asynchronous updates.
Support
Supports: Python 3.10.
Supports Django Versions: 4.2.7
Installation
$ pip install django-update-cache
Usage
Add update_cache.apps.UpdateCacheConfig
to INSTALLED_APPS
.
Run migrations:
python manage.py migrate
Add a module cached_functions
to one or more of your apps. Decorate any function for which you want the results to be
cached:
# cached_functions.py
from update_cache.decorators import cache_function
@cache_function()
def my_expensive_function():
...
Specify a specific timeout:
# cached_functions.py
from update_cache.decorators import cache_function
@cache_function(timeout=60)
def my_expensive_function():
...
Use asynchronous updating (this requires running a django_rq worker):
# cached_functions.py
from update_cache.brokers import async_broker
from update_cache.decorators import cache_function
@cache_function(broker=async_broker)
def my_expensive_function():
...
Use a custom cache backend:
# cached_functions.py
from update_cache.decorators import cache_function
@cache_function(backend='my_cache_alias')
def my_expensive_function():
...
You can set a global broker to delegate the cache updates in settings.py
.
DUC_DEFAULT_BROKER = 'function_cache.brokers.AsyncBroker'
Invalidate the cache:
# cached_functions.py
from update_cache.decorators import cache_function
@cache_function()
def my_expensive_function():
...
my_expensive_function.cache.invalidate()
Cache a view (only synchronous updates).
# cached_functions.py
from update_cache.decorators import cache_view
@cache_view()
def my_expensive_view():
...
View all cached entries in Django Admin:
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
Built Distribution
Hashes for django-update-cache-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdfe054ccc50c48abc77fd4ae8629dc210a536bd51c3636c12b080322317f174 |
|
MD5 | 47f828ccbf576f49891a5e296bb0f8f9 |
|
BLAKE2b-256 | dffc5082e932bcd54dcce77cf29873836b3e31391475e3fe000a7eec3e010450 |
Hashes for django_update_cache-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3bcbccd49fe5f0ff3836cc22100df6aaae2f4d4ca86ceb4062732c6440c219a |
|
MD5 | 23ff32af87410cce4734c6eaed5a611a |
|
BLAKE2b-256 | f65e8e395ed17395985d8467c6bcce18d29bc03132364e6a848144d22afe7669 |