Skip to main content

A simple lock extension for django's cache.

Project description


PyPI Build Status Donate with Bitcoin

A simple lock extension for django's cache to prevent concurrent editing.


Install django-cache-lock by using pip

pip install django-cache-lock

Quick Start

You can work with django-cache-lock by using with-statement or decorator.

from django_lock import lock

with lock("global"):

def foo():

A shortcut to lock model instance

from django.db import models
from django_lock import model_lock

class Foo(models.Model):
    bar = models.CharField(max_length=8)

    def lock_pk(self):

    @lock_model("bar", blocking=False)
    def lock_bar(self):

    def nolock(self):

foo = Foo()
with lock_model(foo, blocking=False):


key default desc
DJANGOLOCK_PREFIX "lock:" lock's key prefix stored in cache
DJANGOLOCK_SLEEP 0.1 default interval time to acquire a lock if a lock is holded by others
DJANGOLOCK_RELEASEONDEL True release lock when __del__ is called if True

Advanced usage

For more usages, please read the code.

Supported backends

  • django.core.cache.backends.db
  • django.core.cache.backends.file
  • django.core.cache.backends.locmem
  • django.core.cache.backends.memcached
  • django-redis
  • django-redis-cache


locmem backend

  • DO NOT USE locmem backend in a product environment.

memcached backend

  • Memcached does not support milliseconds expire time, and its' expire time is not very exact. So memcached lock's timeout time is not as exact as other backends.

redis backend

  • We didn't test distributed redis lock.


  • use memcached's cas to release lock
  • reacquire and extend lock
  • database backend cache support

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-cache-lock, version 0.2.5
Filename, size File type Python version Upload date Hashes
Filename, size django_cache_lock-0.2.5-py2.py3-none-any.whl (7.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size django-cache-lock-0.2.5.tar.gz (7.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page