Skip to main content

Timeout context manager for asyncio programs

Project description

async-timeout

https://travis-ci.org/aio-libs/async-timeout.svg?branch=master https://codecov.io/gh/aio-libs/async-timeout/branch/master/graph/badge.svg https://img.shields.io/pypi/v/async-timeout.svg Chat on Gitter

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 if 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

3.0.1 (2018-10-09)

  • More aggressive typing (#48)

3.0.0 (2018-05-05)

  • Drop Python 3.4, the minimal supported version is Python 3.5.3

  • Provide type annotations

2.0.1 (2018-03-13)

  • Fix PendingDeprecationWarning on Python 3.7 (#33)

2.0.0 (2017-10-09)

  • Changed timeout <= 0 behaviour

    • Backward incompatibility change, prior this version 0 was shortcut for None

    • when timeout <= 0 TimeoutError raised faster

1.4.0 (2017-09-09)

  • Implement remaining property (#20)

    • If timeout is not started yet or started unconstrained: remaining is None

    • If timeout is expired: remaining is 0.0

    • All others: roughly amount of time before TimeoutError is triggered

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

Uploaded Source

Built Distribution

async_timeout-3.0.1-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: async-timeout-3.0.1.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3

File hashes

Hashes for async-timeout-3.0.1.tar.gz
Algorithm Hash digest
SHA256 0c3c816a028d47f659d6ff5c745cb2acf1f966da1fe5c19c77a70282b25f4c5f
MD5 305c4fa529f2485c403d0dbe14390175
BLAKE2b-256 a178aae1545aba6e87e23ecab8d212b58bb70e72164b67eb090b81bb17ad38e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: async_timeout-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3

File hashes

Hashes for async_timeout-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4291ca197d287d274d0b6cb5d6f8f8f82d434ed288f962539ff18cc9012f9ea3
MD5 17e95b1778c2c32036bcc5664e815ab8
BLAKE2b-256 e11e5a4441be21b0726c4464f3f23c8b19628372f606755a9d2e46c187e65ec4

See more details on using hashes here.

Supported by

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