Skip to main content

A distributed lock recipe for etcd

Project description

## Python Lock library for ETCD 2.0

Since ETCD 0.4, all [the built in modules were removed](https://groups.google.com/d/msg/etcd-dev/ubcPWuL8wSg/7GeaxSHhIb0J), including the locking module. The API still provides an atomic compare-and-swap method to implement locking, thus providing the core functionality to create semaphores and mutexes. This library is built on top of that, matching the API that was in [python-etcd](https://github.com/jplana/python-etcd) before it was removed as much as possible.

[![Circle CI](https://circleci.com/gh/appuri/python-etcd-lock.svg?style=shield)](https://circleci.com/gh/appuri/python-etcd-lock)

#### Simple Usage

```python
import etcd
from etcdlock import Lock

lock = Lock(etcd.Client(), 'path/to/my/key')
while lock
# lock is acquired
# lock will renew itself by default until released
# do work
request = ....

# check if we still have the lock
if lock.is_locked() is False:
return
```

#### Explicit Usage

```python
import etcd
from etcdlock import Lock

client = client = etcd.Client(host='api.example.com', protocol='https', port=443, version_prefix='/etcd')
lock = Lock(client, 'path/to/my/key', ttl=30, renewSecondsPrior=)
if lock.acquire(timeout=20):
t = Thread(target=someheavywork)
t.run()
t.wait()
lock.renew()
# some other work
lock.release() # not recommended, use a context manager
else
# failed to acquire the lock in 20 seconds
pass
```

Please see [the tests](https://github.com/appuri/python-etcd-lock/blob/master/tests/lock_tests.py) while the documentation is lacking, thanks.

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

python-etcd-lock-0.0.4.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_etcd_lock-0.0.4-py2.7.egg (6.2 kB view details)

Uploaded Egg

File details

Details for the file python-etcd-lock-0.0.4.tar.gz.

File metadata

File hashes

Hashes for python-etcd-lock-0.0.4.tar.gz
Algorithm Hash digest
SHA256 99df4deb2b0d54b907b631292b65aa0d81b928af4f458be6fafcc4a3d5d91c8b
MD5 77123c63a6e99b74b7bb735d8aa5913c
BLAKE2b-256 26c4798459d31bb41c3bc39e70f6f6cb3b676fc5e96b18552f9471ae57b4ad3b

See more details on using hashes here.

File details

Details for the file python_etcd_lock-0.0.4-py2.7.egg.

File metadata

File hashes

Hashes for python_etcd_lock-0.0.4-py2.7.egg
Algorithm Hash digest
SHA256 7daf5a633a9c56c9181eefc908fb8e3a0e025edaa7f80130d5e6df35c9508d28
MD5 f5228af0755e903cc6e52ee829fad4ad
BLAKE2b-256 d426457c958a899a4c831f12e9fcd70e62e34dbbe425efb5c1ca15b06a2ee087

See more details on using hashes here.

Supported by

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