Skip to main content

Asyncio client for Zookeeper.

Project description

Asyncio zookeeper client

PyPi version Build Status

Based on wglass/zoonado implementation


Have no major bugs in client/session/connection, but recipes are just ported and require more tests. So you can expect that recipes with tests are working.


$ pip install aiozk

Quick Example

import asyncio
from aiozk import ZKClient

async def run():
    zk = ZKClient('localhost')
    await zk.start()
    await zk.create('/foo', data=b'bazz', ephemeral=True)
    await zk.set_data('/foo', 'new bazz')
    await zk.close()

loop = asyncio.get_event_loop()


You may use recipes, similar to zoonado, kazoo, and other libs:

# assuming zk is aiozk.ZKClient

barrier ='/barrier_name')
await barrier.create()
await barrier.lift()
await barrier.wait()

Full list of recipes

To understand ideas behind recipes please read this and even more recipes here. Make sure you're familiar with all recipes before doing something new by yourself, especially when it involves more than few zookeeper calls.


NB: please ensure that you're using recent docker-compose version. You can get it by running

pip install --user -U docker-compose

Run tests

# you should have access to docker

docker-compose build

Testing approach

Most of tests are integration tests and running on real zookeeper instances. We've chosen zookeeper 3.5 version since it has an ability to dynamic reconfiguration and we're going to do all connecting/reconnecting/watches tests on zk docker cluster as this gives us the ability to restart any server and see what happens.

# first terminal: launch zookeeper cluster
docker-compose rm -fv && docker-compose build zk && docker-compose scale zk=7 && docker-compose up zk_seed zk

# it will launch cluster in this terminal and remain. last lines should be like this:

zk_6       | Servers: 'server.1=;\nserver.2=;\nserver.3=;\nserver.4=;\nserver.5=;\nserver.6=;'
zk_6       | CONFIG: server.1=;
zk_6       | server.2=;
zk_6       | server.3=;
zk_6       | server.4=;
zk_6       | server.5=;
zk_6       | server.6=;
zk_6       | server.7=;
zk_6       |
zk_6       |
zk_6       | Reconfiguring...
zk_6       | ethernal loop
zk_7       | Servers: 'server.1=;\nserver.2=;\nserver.3=;\nserver.4=;\nserver.5=;\nserver.6=;\nserver.7=;'
zk_7       | CONFIG: server.1=;
zk_7       | server.2=;
zk_7       | server.3=;
zk_7       | server.4=;
zk_7       | server.5=;
zk_7       | server.6=;
zk_7       | server.7=;
zk_7       | server.8=;
zk_7       |
zk_7       |
zk_7       | Reconfiguring...
zk_7       | ethernal loop

Run tests:

docker-compose run --no-deps aiozk
# last lines will be about testing results

............lot of lines ommited........
Ran 3 tests in 1.059s


Recipes testing

It seems that usually recipes require several things to be tested:

  • That recipe flow is working as expected
  • Timeouts: reproduce every timeout with meaningful values (timeout 0.5s and block for 0.6s)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aiozk, version 0.16.0
Filename, size & hash File type Python version Upload date
aiozk-0.16.0.tar.gz (32.3 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page