Skip to content

A python client for etcd

License

Notifications You must be signed in to change notification settings

chet/python-etcd

Repository files navigation

python-etcd documentation

A python client for Etcd https://github.com/coreos/etcd

Official documentation: http://python-etcd.readthedocs.org/

https://travis-ci.org/jplana/python-etcd.png?branch=masterhttps://coveralls.io/repos/jplana/python-etcd/badge.svg?branch=master&service=github

Installation

Pre-requirements

Install etcd (2.0.1 or later). This version of python-etcd will only work correctly with the etcd version 2.0.x or later. If you are running an older version of etcd, please use python-etcd 0.3.3 or earlier.

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 outdated versions of python.

From source

$ python setup.py install

Usage

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

importetcdclient=etcd.Client() # this will create a client against etcd server running on localhost on port 4001client=etcd.Client(port=4002) client=etcd.Client(host='127.0.0.1', port=4003) client=etcd.Client(host='127.0.0.1', port=4003, allow_redirect=False) # wont let you run sensitive commands on non-leader machines, default is true# If you have defined a SRV record for _etcd._tcp.example.com pointing to the clientsclient=etcd.Client(srv_domain='example.com', protocol="https") # create a client against https://api.example.com:443/etcdclient=etcd.Client(host='api.example.com', protocol='https', port=443, version_prefix='/etcd')

Write a key

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

Read a key

client.read('/nodes/n2').valueclient.read('/nodes', recursive=True) #get all the values of a directory, recursively.client.get('/nodes/n2').value# raises etcd.EtcdKeyNotFound when key not foundtry: client.read('/invalid/path') exceptetcd.EtcdKeyNotFound: # do somethingprint"error"

Delete a key

client.delete('/nodes/n1')

Atomic Compare and Swap

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

You can also atomically update a result:

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

Watch a key

client.read('/nodes/n1', wait=True) # will wait till the key is changed, and return once its changedclient.read('/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.client.read('/nodes/n1', wait=True, waitIndex=10) # get all changes on this key starting from index 10client.watch('/nodes/n1') #equivalent to client.read('/nodes/n1', wait = True)client.watch('/nodes/n1', index=10)

Locking module

# Initialize the lock object:# NOTE: this does not acquire a lock yetclient=etcd.Client() # Or you can custom lock prefix, default is '/_locks/'client=etcd.Client(lock_prefix='/my_etcd_root/_locks') lock=etcd.Lock(client, 'my_lock_name') # Use the lock object:lock.acquire(blocking=True, # will block until the lock is acquiredlock_ttl=None) # lock will live until we release itlock.is_acquired# Truelock.acquire(lock_ttl=60) # renew a locklock.release() # release an existing locklock.is_acquired# False# The lock object may also be used as a context manager:client=etcd.Client() withetcd.Lock(client, 'customer1') asmy_lock: do_stuff() my_lock.is_acquired# Truemy_lock.acquire(lock_ttl=60) my_lock.is_acquired# False

Get machines in the cluster

client.machines

Get leader of the cluster

client.leader

Generate a sequential key in a directory

x=client.write("/dir/name", "value", append=True) print("generated key: "+x.key) print("stored value: "+x.value)

List contents of a directory

#stick a couple values in the directoryclient.write("/dir/name", "value1", append=True) client.write("/dir/name", "value2", append=True) directory=client.get("/dir/name") # loop through directory childrenforresultindirectory.children: print(result.key+": "+result.value) # or just get the first child valueprint(directory.children.next().value)

Development setup

To create a buildout,

$ python bootstrap.py $ bin/buildout

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

$ bin/test

to generate documentation,

$ cd docs $ make

Release HOWTO

To make a release

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

About

A python client for etcd

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python99.7%
  • Shell0.3%