Skip to main content

asyncio-cancel-token: Task cancellation pattern for asyncio applications

Project description

# asyncio-cancel-token

[![Join the chat at https://gitter.im/ethereum/asyncio-cancel-token](https://badges.gitter.im/ethereum/asyncio-cancel-token.svg)](https://gitter.im/ethereum/asyncio-cancel-token?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://circleci.com/gh/ethereum/asyncio-cancel-token.svg?style=shield)](https://circleci.com/gh/ethereum/asyncio-cancel-token) [![PyPI version](https://badge.fury.io/py/asyncio-cancel-token.svg)](https://badge.fury.io/py/asyncio-cancel-token) [![Python versions](https://img.shields.io/pypi/pyversions/asyncio-cancel-token.svg)](https://pypi.python.org/pypi/asyncio-cancel-token) [![Docs build](https://readthedocs.org/projects/asyncio-cancel-token/badge/?version=latest)](http://asyncio-cancel-token.readthedocs.io/en/latest/?badge=latest)

Task cancellation pattern for asyncio applications.

Read more in the [documentation on ReadTheDocs](https://asyncio-cancel-token.readthedocs.io/). [View the change log](https://asyncio-cancel-token.readthedocs.io/en/latest/releases.html).

## Quickstart

`sh 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](https://github.com/pipermerriam/ethereum-dev-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:

`sh 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:

`sh # 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:

`sh # 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:

`sh 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:

`sh 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”

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
asyncio_cancel_token-0.1.0a2-py3-none-any.whl (5.3 kB) Copy SHA256 hash SHA256 Wheel py3
asyncio-cancel-token-0.1.0a2.tar.gz (5.1 kB) Copy SHA256 hash SHA256 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