redis_lock

exception redis_lock.AlreadyAcquired

exception redis_lock.AlreadyStarted

exception redis_lock.InvalidTimeout

class redis_lock.Lock(redis_client, name, expire=None, id=None, auto_renewal=False, strict=True, signal_expire=1000)

A Lock context manager implemented via redis SETNX/BLPOP.

acquire(blocking=True, timeout=None)

Parameters:

• blocking – Boolean value specifying whether lock should be blocking or not.
• timeout – An integer value specifying the maximum number of seconds to block.

extend(expire=None)

Extends expiration time of the lock.

Parameters:expire – New expiration time. If None - expire provided during lock initialization will be taken.

locked()

Return true if the lock is acquired.

Checks that lock with same name already exists. This method returns true, even if lock have another id.

release()

Releases the lock, that was acquired with the same object.

Note

If you want to release a lock that you acquired in a different place you have two choices:

• Use Lock("name", id=id_from_other_place).release()
• Use Lock("name").reset()

reset()

Forcibly deletes the lock. Use this with care.

exception redis_lock.NotAcquired

exception redis_lock.NotExpirable

exception redis_lock.TimeoutNotUsable

exception redis_lock.TimeoutTooLarge

redis_lock.reset_all(redis_client)

Forcibly deletes all locks if its remains (like a crash reason). Use this with care.

Parameters:redis_client – An instance of StrictRedis.