asyncio-channel

Asynchronous channels for communication and synchronization between asyncio coroutines.

from asyncio_channel import create_channel

# Create a new channel.
ch = create_channel()

# Put an item on the channel; block until the item is accepted.
await ch.put(x)

# Take an item from the channel; block until an item is available.
x = await ch.take()

# Do something each time an item is put on the channel.
async for x in ch:
	do_something(x)
	do_something_else(x)
# Iteration stops when the channel is closed and drained.

Also contains several utilities for piping items between channels, mixing multiple input channels, routing messages by topic, and more.

API Documentation

See the full API docs

Install

From pypi

$ pip install asyncio-channel

Setup for development

Tip: Use pyenv and virtualenv.

$ mkdir asyncio-channel-fork
$ cd asyncio-channel-fork
$ pyenv local 3.7.4
$ virtualenv .
$ . bin/activate
$ git clone https://github.com/ebb29c/asyncio-channel.git
$ cd asyncio-channel
$ make install
$ make test

Other make targets:

• test-cov: run tests with code coverage
• test-cov-html: run tests and generate html code coverage report
• test-cov-xml: run tests and genrate xml code coverage report
• lint: run linter

License

The MIT License