Skip to main content

A cacheable Django model

Project description

django cacheable model

A cacheable model for django.

  • A generic way of creating cache keys from Django model fields
  • Retrieve django models from cache with field values (cache on the way if cache missed)
  • Retrieve all the model instances (suitable for small set of models)
  • Support for cache aliases

See usage example below

1. Install

pip install django_cacheable_model

2. Configuration

  • DEFAULT_CACHE_ALIAS the default cache name to use from settings.CACHES. If not set default alias is name "default" and must be configured in CACHES.
  • CACHE_SET_MANY_LIMIT is chunk size for calls to cache.set_many.
    when all_ins_from_cache brings in all entries from cache, it will set each object
    in chunks to control request size. Default is 5 i.e if there are 10 instances of a model
    from db this config will set each of the models to the cache in two groups of 5
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

CACHE_DEFAULT_ALIAS = 'example_cache_alias'
CACHE_SET_MANY_LIMIT = 10
CACHES = {
   ...,
    'example_cache_alias': {
        'BACKEND': 'django.core.cache.backends.memcached.PyMemcacheCache',
        'LOCATION': 'memcached:11211',
    },
    ...
}

3. Usage

See samples in example_django_project views.py and models.py.

3.1. Create a model that inherits from CacheableModel

class Question(CacheableModel):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')


class Choice(CacheableModel):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    choice_text = models.CharField(max_length=200)
    votes = models.IntegerField(default=0)

3.2. Use cache operations from django_cacheable_model.utils

from django_cacheable_model.utils import all_ins_from_cache, model_ins_from_cache

# Get all instances of model from cache (use for smaller set of models)
context['choices'] = all_ins_from_cache(Choice)

# Get all instances with select_related and order_by
choices = all_ins_from_cache(Choice,
                             select_related=('question',),
                             order_by_fields=('-id',))

# Get a single model. Note this method returns a list of matching objects
context['choice'] = model_ins_from_cache(Choice, {'id': 5})[-1]

4. License

Apache2 License

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

django_cacheable_model-1.2.7.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

django_cacheable_model-1.2.7-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file django_cacheable_model-1.2.7.tar.gz.

File metadata

File hashes

Hashes for django_cacheable_model-1.2.7.tar.gz
Algorithm Hash digest
SHA256 56925ea7ccafe66ec033edcbb3fb95d99f77a4940c052dc8fca6ba3bb2c02fbd
MD5 0cc5b9c202fbcb77b20e49f43fa1d601
BLAKE2b-256 31ad74cd28aa3a361114ddca4a47e8494f88f0b94168584b4a644bbd87cd525a

See more details on using hashes here.

File details

Details for the file django_cacheable_model-1.2.7-py3-none-any.whl.

File metadata

File hashes

Hashes for django_cacheable_model-1.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a9d71f1b5e4c14b8e6090e9b266e10090725ff2c20600e8bc08d05b790c4caff
MD5 d467f2712b3ec87d163970b43d51954e
BLAKE2b-256 aa782caae61d993ede91d2f403802caf495e288a4325d4ef30ac8c5545df30ba

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page