Skip to main content

Timeout context manager for asyncio programs

Project description

async-timeout

asyncio-compatible timeout context manager.

Usage example

The context manager is useful in cases when you want to apply timeout logic around block of code or in cases when asyncio.wait_for() is not suitable. Also it’s much faster than asyncio.wait_for() because timeout doesn’t create a new task.

The timeout(timeout, *, loop=None) call returns a context manager that cancels a block on timeout expiring:

with timeout(1.5):
    yield from inner()
  1. If inner() is executed faster than in 1.5 seconds nothing happens.

  2. Otherwise inner() is cancelled internally by sending asyncio.CancelledError into but asyncio.TimeoutError is raised outside of context manager scope.

timeout parameter could be None for skipping timeout functionality.

Installation

$ pip install async-timeout

The library is Python 3 only!

Authors and License

The module is written by Andrew Svetlov.

It’s Apache 2 licensed and freely available.

CHANGES

1.2.0 (2017-03-11)

  • Extra check on context manager exit

  • 0 is no-op timeout

1.1.0 (2016-10-20)

  • Rename to async-timeout

1.0.0 (2016-09-09)

  • The first release.

Project details


Download files

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

Source Distribution

async-timeout-1.2.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

async_timeout-1.2.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file async-timeout-1.2.0.tar.gz.

File metadata

File hashes

Hashes for async-timeout-1.2.0.tar.gz
Algorithm Hash digest
SHA256 0652d108c0156ae5ac94d99f53a6bdd039b0c076346ff8f58c9a1551fac17a19
MD5 b9fc198be2e415e6786da596091abe40
BLAKE2b-256 55673870ef0811ee3e40b67d776b3144743f34a2a2d094690af83a1c5390806e

See more details on using hashes here.

Provenance

File details

Details for the file async_timeout-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for async_timeout-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2507257417470f41e40ae9265d0abdbff6d936b6e0d5831132d35714c9cd433d
MD5 7a6982b042a7551dfeba74d475460e77
BLAKE2b-256 dd6ad63e04d23f64b1ccb633dce6e42e5bf3d58095f601b91337b4fdfa6b90a9

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page