Django-locking

Usage

Add 'locking' to your INSTALLED_APPS settings, and run migrate to initialise create the basic table:

python manage.py migrate

The simplest use is by using it as a context manager

from locking.models import NonBlockingLock, AlreadyLocked

with NonBlockingLock.objects.acquire_lock(obj=model_obj):
    model_obj.do_something()

Or you can keep track of the lock yourself:

try:
    lock = NonBlockingLock.objects.acquire_lock(obj=model_obj)
except AlreadyLocked:
    return False

model_obj.do_something()
lock.release()

If you have no Django model, or you want to be able to specify the lock name yourself, you can do that too:

# this will raise AlreadyLocked, if it's locked
lock = NonBlockingLock.objects.acquire_lock(lock_name='my_lock')
do_something()
lock.release()

Test

You can run the tests with

tox

Wishlist

• Add lock time-out (try to aquire a lock for up to a given TIME_OUT), like lockfile's FileLock.aquire
• Global locks (for instance on a whole Model not just an object)

Releases

v1.2.1:

Fix problem in migration to UUIDField for PostGres

v1.2.0:

Move id to UUIDField, add code quality checks and CI

v1.1.0:

Rename model to NonBlockingLock and add additional features

v1.0.1:

Corrected tests and code clean-up

v1.0.0:

Intial release.