Skip to main content

Join the chat at https://gitter.im/ethereum/asyncio-cancel-token Build Status PyPI version Python versions Docs build

Task cancellation pattern for asyncio applications.

Read more in the documentation on ReadTheDocs. View the change log.

Quickstart

pip install asyncio-cancel-token

Developer Setup

If you would like to hack on asyncio-cancel-token, please check out the Ethereum Development Tactical Manual for information on how we do:

  • Testing

  • Pull Requests

  • Code Style

  • Documentation

Development Environment Setup

You can set up your dev environment with:

git clone git@github.com:ethereum/asyncio-cancel-token.git
cd asyncio-cancel-token
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]

Testing Setup

During development, you might like to have tests run on every file save.

Show flake8 errors on file change:

# Test flake8
when-changed -v -s -r -1 cancel_token/ tests/ -c "clear; flake8 cancel_token tests && echo 'flake8 success' || echo 'error'"

Run multi-process tests in one command, but without color:

# in the project root:
pytest --numprocesses=4 --looponfail --maxfail=1
# the same thing, succinctly:
pytest -n 4 -f --maxfail=1

Run in one thread, with color and desktop notifications:

cd venv
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on asyncio-cancel-token failed'" ../tests ../cancel_token

Release setup

For Debian-like systems:

apt install pandoc

To release a new version:

make release bump=$$VERSION_PART_TO_BUMP$$

How to bumpversion

The version format for this repo is {major}.{minor}.{patch} for stable, and {major}.{minor}.{patch}-{stage}.{devnum} for unstable (stage can be alpha or beta).

To issue the next version in line, specify which part to bump, like make release bump=minor or make release bump=devnum.

If you are in a beta version, make release bump=stage will switch to a stable.

To issue an unstable version when the current version is stable, specify the new version explicitly, like make release bump="--new-version 4.0.0-alpha.1 devnum"

Download files

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

Source Distribution

asyncio-cancel-token-0.2.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

asyncio_cancel_token-0.2.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file asyncio-cancel-token-0.2.0.tar.gz.

File metadata

  • Download URL: asyncio-cancel-token-0.2.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

File hashes

Hashes for asyncio-cancel-token-0.2.0.tar.gz
Algorithm Hash digest
SHA256 98d9a658971bdf028d457fd1221f9fc416ce085ecfb8dbcbc17561021d2b0075
MD5 93f3cd8fdd7f8da27ea2e58306acffd8
BLAKE2b-256 6ac7d2d30e52cf51867aada068d543bbb1a781768ae11fde11242ffb04260d3d

See more details on using hashes here.

File details

Details for the file asyncio_cancel_token-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: asyncio_cancel_token-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

File hashes

Hashes for asyncio_cancel_token-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee382b3162dda267b3529a006643a4fe317c854fd8c541f73e1b5837d9ada009
MD5 2e76a4753e5f4737573b99a768e9c669
BLAKE2b-256 e4544c673a787de14e3f4161b906239a3efe241c2c8e98332069174854dded8d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 files

Supported by

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