Skip to main content

A python client for etcd - Azion's fork

Project description

python-etcd documentation

A python client for Etcd

Official documentation:

.. image::



Install etcd (0.2.rc1 or later). This version of python-etcd will only work correctly with the etcd API version 2.

This client is known to work with python 2.7 and with python 3.3 or above. It is not tested or expected to work in more outddated versions of python.

From source

.. code:: bash

$ python install


The basic methods of the client have changed compared to previous versions, to reflect the new API structure; however a compatibility layer has been maintained so that you don't necessarily need to rewrite all your existing code.

Create a client object

.. code:: python

import etcd

client = etcd.Client() # this will create a client against etcd server running on localhost on port 4001
client = etcd.Client(port=4002)
client = etcd.Client(host='', port=4003)
client = etcd.Client(host='', port=4003, allow_redirect=False) # wont let you run sensitive commands on non-leader machines, default is true
# create a client against
client = etcd.Client(host='', protocol='https', port=443, version_prefix='/etcd')
Write a key

.. code:: python

client.write('/nodes/n1', 1)
# with ttl
client.write('/nodes/n2', 2, ttl=4) # sets the ttl to 4 seconds
client.set('/nodes/n2', 1) # Equivalent, for compatibility reasons.

Read a key

.. code:: python'/nodes/n2').value'/nodes', recursive = True) #get all the values of a directory, recursively.

Delete a key

.. code:: python


Atomic Compare and Swap

.. code:: python

client.write('/nodes/n2', 2, prevValue = 4) # will set /nodes/n2 's value to 2 only if its previous value was 4 and
client.write('/nodes/n2', 2, prevExist = False) # will set /nodes/n2 's value to 2 only if the key did not exist before
client.write('/nodes/n2', 2, prevIndex = 30) # will set /nodes/n2 's value to 2 only if the key was last modified at index 30
client.test_and_set('/nodes/n2', 2, 4) #equivalent to client.write('/nodes/n2', 2, prevValue = 4)

You can also atomically update a result:

.. code:: python

result ='/foo')
print(result.value) # bar
result.value += u'bar'
updated = client.update(result) # if any other client wrote '/foo' in the meantime this will fail
print(updated.value) # barbar

Watch a key

.. code:: python'/nodes/n1', wait = True) # will wait till the key is changed, and return once its changed'/nodes/n1', wait = True, timeout=30) # will wait till the key is changed, and return once its changed, or exit with an exception after 30 seconds.'/nodes/n1', wait = True, waitIndex = 10) # get all changes on this key starting from index 10'/nodes/n1') #equivalent to'/nodes/n1', wait = True)'/nodes/n1', index = 10)

Locking module

.. code:: python

# Initialize the lock object:
# NOTE: this does not acquire a lock yet
client = etcd.Client()
lock = client.get_lock('/customer1', ttl=60)

# Use the lock object:
lock.acquire(timeout=30) #returns if lock could not be acquired within 30 seconds
lock.is_locked() # True
lock.is_locked() # False

# The lock object may also be used as a context manager:
client = etcd.Client()
lock = client.get_lock('/customer1', ttl=60)
with lock as my_lock:
lock.is_locked() # True
lock.is_locked() # False

Leader Election module

.. code:: python

# Set a leader object with a name; if no name is given, the local hostname
# is used.
# Zero or no ttl means the leader object is persistent.
client = etcd.Client()
client.election.set('/mysql', name='', ttl=120, timeout=30) # returns the etcd index

# Get the name
print(client.election.get('/mysql')) # ''
# Delete it!
print(client.election.delete('/mysql', name=''))

Get machines in the cluster

.. code:: python


Get leader of the cluster

.. code:: python


Development setup

To create a buildout,

.. code:: bash

$ python
$ bin/buildout

to test you should have etcd available in your system path:

.. code:: bash

$ bin/test

to generate documentation,

.. code:: bash

$ cd docs
$ make

Release HOWTO

To make a release

1) Update release date/version in NEWS.txt and
2) Run 'python sdist'
3) Test the generated source distribution in dist/
4) Upload to PyPI: 'python sdist register upload'



* Retry in a bigger number of exceptions

*Release date: 12-Apr-2015*

* Forward leaves_only value in get_subtree() recursive calls
* Fix README prevExists->prevExist
* Added configurable version_prefix
* Added support for recursive watch
* Better error handling support (more detailed exceptions)
* Fixed some unreliable tests
* Fix bad .format usage for Python 2.6
* Change package name to python-etcd-azion


*Release date: 4-Aug-2014*

* Fixed generated documentation version.


*Release date: 4-Aug-2014*

* Added consisten read option
* Fixed timeout parameter in read()
* Added atomic delete parameter support
* Fixed delete behaviour
* Added update method that allows atomic updated on results
* Fixed checks on write()
* Added leaves generator to EtcdResult and get_subtree for recursive fetch
* Added etcd_index to EtcdResult
* Changed ethernal -> eternal
* Updated urllib3 & pyOpenSSL libraries
* Several performance fixes
* Better parsing of etcd_index and raft_index
* Removed duplicated tests
* Added several integration and unit tests
* Use etcd v0.3.0 in travis
* Execute test using `python test` and nose


*Release date: 18-Jan-2014*

* API v2 support
* Python 3.3 compatibility


*Release data: 30-Nov-2013*

* SSL support
* Added support for subdirectories in results.
* Improve test
* Added support for reconnections, allowing death node tolerance.


*Release date: 30-Sep-2013*

* Allow fetching of multiple keys (sub-nodes)


*Release date: 18-Sep-2013*

* Initial release

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-azion-0.3.4.tar.gz (23.6 kB view hashes)

Uploaded source

Supported by

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