django-model-cache's Introduction

django-model-cache

An easy-to-use cache for Django models.

This code has been developed and used in a production environment for one year.

How to use

There follows some examples of use. For further examples, see tests/simple/tests.py.

from django.db import models
from django_model_cache import CacheController
import uuid


class Brand(models.Model):
    name = models.CharField(max_length=128)

    cache = CacheController(timeout=None)


class Product(models.Model):
    code = models.UUIDField(default=uuid.uuid4, editable=False, unique=True)
    brand = models.ForeignKey('Brand')
    name = models.CharField(max_length=255)

    cache = CacheController(fields=['code', ('brand_id', 'name')], related_fields=['brand'], timeout=None)

    class Meta:
        unique_together = ('name', 'brand')


# Get a product by pk.
product = Product.cache.get(pk=1)

# Get a product by a unique key.
product = Product.cache.get(code='A001')

# Load the related models.
product.load_related()

How to test

Just run tox or install the dependencies and run cd tests/ && ./manage.py test.

django-model-cache's People

Contributors

Stargazers

Watchers

django-model-cache's Issues

Django version compatibility

I have had a bit of a play with the code trying to get it to work but on 2.1 I am getting the following error:

Traceback (most recent call last):
  File "<console>", line 1, in <module>
  File "/home/bla/.virtualenvs/virty/lib/python3.6/site-packages/django/db/models/manager.py", line 192, in __get__
    return cls._meta.managers_map[self.manager.name]

Even though CacheController doesn't inherit from models.Manager it appears to be treated as a manager. I tried making CacheController inherit and various variations on that but I keep getting the same error.
Could this be a Django 2.1+ thing

Recommend Projects