django-cache-helper

Overview

django-cache-helper is a simple tool for making caching functions, methods, and class methods a little bit easier. It is largely based off of django-cache-utils, however, since cache-utils did not support caching model methods by instance and carried other features I didn't need, django-cache-helper was created.

In order to cache and invalidate a function/method/class_method/static_method:

Support

How to Cache

# Caching a function
@cached(60*60)  # 60 Minutes
def foo(bar):
	return bar

class Incrementer:

    @cached_instance_method(60 * 60)
    def instance_increment_by(self, num):
        return num

    @classmethod
    @cached_class_method(60 * 60)
    def class_increment_by(cls, num):
        return num

    @staticmethod
    @cached(60 * 60)
    def get_datetime():
        return datetime.utcnow()

How to invalidate a cache

foo(1)
foo.invalidate(1)

Incrementer.instance_increment_by(1)
Incrementer.instance_increment_by.invalidate(1)

Incrementer.class_increment_by(1)
Incrementer.class_increment_by.invalidate(1)

Incrementer.get_datetime()
Incrementer.get_datetime.invalidate()

How to run tests

1. Create and activate a new Python virtual environment using the package manager of your choice (e.g., pyenv-virtualenv, virtualenv, etc.).

2. Install requirements.

   pip install -r requirements.txt
   

3. Install the django_cache_helper package in editable mode

   pip install -e .
   

4. Run tests using manage.py:

   cd test_project
   python manage.py test
   

Note that the current test suite generates some expected warnings, which are manually suppressed in the test code.

Contributors ✨

Thanks goes to these wonderful people.

Kevin Fox

Tom Jakeway

Ara Anjargolian

Hyuckin David Lim

James