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:

async with timeout(1.5):
    await 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.

Context manager has .expired property for check if timeout happens exactly in context manager:

async with timeout(1.5) as cm:
    await inner()
print(cm.expired)

The property is True is inner() execution is cancelled by timeout context manager.

If inner() call explicitly raises TimeoutError cm.expired is False.

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.3.0 (2017-08-23)

  • Don’t suppress nested exception on timeout. Exception context points on cancelled line with suspended await (#13)

  • Introduce .timeout property (#16)

  • Add methods for using as async context manager (#9)

1.2.1 (2017-05-02)

  • Support unpublished event loop’s “current_task” api.

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.3.0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

async_timeout-1.3.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for async-timeout-1.3.0.tar.gz
Algorithm Hash digest
SHA256 f4651f122a9877049930ce31a8422bc202a47937627295fe5e411b2c2083481f
MD5 a3c010b25cfad96538578bb3c153ce5e
BLAKE2b-256 57e952dfa4243a5b796f5a9c74452b43156ae5fbd45b125cc2dd3e1635797f2c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for async_timeout-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 087a26de8b926d41087c56bb7f70d9b5480c119e4b56589d431206d24508a131
MD5 134ef71541562af54fff18663b9b8d80
BLAKE2b-256 90bb2dc6e9a9c2e9958c4f2028b4d391734a63209da03d15cca72dd70063c4f5

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