Need help with redlock?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

glasslion
162 Stars 40 Forks MIT License 96 Commits 9 Opened issues

Description

Distributed locks with Redis and Python

Services available

!
?

Need anything else?

Contributors list

# 245,631
CSS
Shell
tamperm...
greasem...
41 commits
# 2,236
Django
linter-...
python-...
python-...
11 commits
# 56,479
python3
Kivy
python-...
aws-ssm
4 commits
# 62,014
Django
Redis
task-qu...
rabbitm...
3 commits
# 84,092
Shell
CSS
python3
task-ma...
2 commits
# 87,666
Shell
Perl
preload
fault-i...
2 commits
# 484,499
Python
HTML
Shell
2 commits
# 136,140
Perl
Shell
raku
audioco...
1 commit
# 5,370
Telegra...
web-scr...
PHP
captcha...
1 commit

RedLock logo

RedLock - Distributed locks with Redis and Python

Build Status

This library implements the RedLock algorithm introduced by @antirez

Yet another ...

There are already a few redis based lock implementations in the Python world, e.g. retools, redis-lock.

However, these libraries can only work with single-master redis server. When the Redis master goes down, your application has to face a single point of failure. We can't rely on the master-slave replication, because Redis replication is asynchronous.

This is an obvious race condition with the master-slave replication model : 1. Client A acquires the lock into the master. 2. The master crashes before the write to the key is transmitted to the slave. 3. The slave gets promoted to master. 4. Client B acquires the lock to the same resource A already holds a lock for. SAFETY VIOLATION!

A quick introduction to the RedLock algorithm

To resolve this problem, the Redlock algorithm assume we have

N
Redis masters. These nodes are totally independent (no replications). In order to acquire the lock, the client will try to acquire the lock in all the N instances sequentially. If and only if the client was able to acquire the lock in the majority (
(N+1)/2
)of the instances, the lock is considered to be acquired.

The detailed description of the RedLock algorithm can be found in the Redis documentation: Distributed locks with Redis.

APIs

The

redlock.RedLock
class shares a similar API with the
threading.Lock
class in the Python Standard Library.

Basic Usage

from redlock import RedLock
# By default, if no redis connection details are
# provided, RedLock uses redis://127.0.0.1:6379/0
lock =  RedLock("distributed_lock")
lock.acquire()
do_something()
lock.release()

With Statement / Context Manager

As with

threading.Lock
,
redlock.RedLock
objects are context managers thus support the With Statement. This way is more pythonic and recommended.
from redlock import RedLock
with RedLock("distributed_lock"):
    do_something()

Specify multiple Redis nodes

from redlock import RedLock
with RedLock("distributed_lock",
              connection_details=[
                {'host': 'xxx.xxx.xxx.xxx', 'port': 6379, 'db': 0},
                {'host': 'xxx.xxx.xxx.xxx', 'port': 6379, 'db': 0},
                {'host': 'xxx.xxx.xxx.xxx', 'port': 6379, 'db': 0},
                {'host': 'xxx.xxx.xxx.xxx', 'port': 6379, 'db': 0},
              ]
            ):
    do_something()

The

connection_details
parameter expects a list of keyword arguments for initializing Redis clients. Other acceptable Redis client arguments can be found on the redis-py doc.

Reuse Redis clients with the RedLockFactory

Usually the connection details of the Redis nodes are fixed.

RedLockFactory
can help reuse them, create multiple RedLocks but only initialize the clients once.
from redlock import RedLockFactory
factory = RedLockFactory(
    connection_details=[
        {'host': 'xxx.xxx.xxx.xxx'},
        {'host': 'xxx.xxx.xxx.xxx'},
        {'host': 'xxx.xxx.xxx.xxx'},
        {'host': 'xxx.xxx.xxx.xxx'},
    ])

with factory.create_lock("distributed_lock"): do_something()

with factory.create_lock("another_lock"): do_something()

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.