labd/django-cache-results

A microlibrary to ease your caching code.

django-cache-results

A microlibrary to ease your caching code.

Usage:

def key_function(arg1, arg2):
    return f"prefix.{arg1}.{arg2}"

@cache_results(key_function=key_function)
def some_function(arg1, arg2):
    return "COMPLEX DATA"

Normal usage:

value = some_function(1, 2)

Skipping the cache:

value = some_function.bypass_cache(1, 2)

Updating the cache:

value = some_function.refresh_cache(1, 2)

Fetch the key for manual action:

cache_key = some_function.cache_key(1, 2)

Installation

Install the module from PyPI:

pip install django-cache-results

And use it in your project:

from cache_results import cache_results

Contributing

Was there something you missed, or didn't like about this module? Send us a pull request!