https://github.com/labd/django-cache-results

A microlibrary to ease your caching code.
https://github.com/labd/django-cache-results

cache decorator django

Last synced: 2 months ago
JSON representation

A microlibrary to ease your caching code.

• Host: GitHub
• URL: https://github.com/labd/django-cache-results
• Owner: labd
• License: apache-2.0
• Created: 2017-03-07T10:43:35.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-07T18:52:57.000Z (over 9 years ago)
• Last Synced: 2025-10-30T15:48:41.180Z (8 months ago)
• Topics: cache, decorator, django
• Language: Python
• Homepage:
• Size: 11.7 KB
• Stars: 1
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
.. image:: https://img.shields.io/travis/LabD/django-cache-results/master.svg?branch=master

    :target: http://travis-ci.org/LabD/django-cache-results

.. image:: https://img.shields.io/pypi/v/LabD.svg

    :target: https://pypi.python.org/pypi/LabD/

.. image:: https://img.shields.io/pypi/l/LabD.svg

    :target: https://pypi.python.org/pypi/LabD/

.. image:: https://img.shields.io/codecov/c/github/LabD/django-cache-results/master.svg

    :target: https://codecov.io/github/LabD/django-cache-results?branch=master

django-cache-results

======================

A microlibrary to ease your caching code.

Usage:

.. code-block:: python

    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:

.. code-block:: python

    value = some_function(1, 2)

Skipping the cache:

.. code-block:: python

    value = some_function.bypass_cache(1, 2)

Updating the cache:

.. code-block:: python

    value = some_function.refresh_cache(1, 2)

Fetch the key for manual action:

.. code-block:: python

    cache_key = some_function.cache_key(1, 2)

Installation

============

Install the module from PyPI:

.. code-block:: bash

    pip install django-cache-results

And use it in your project:

.. code-block:: python

    from cache_results import cache_results

Contributing

------------

Was there something you missed, or didn't like about this module?

Send us a pull request!

.. _documentation: http://django-cache-results.readthedocs.org/