async-timeout
=============
.. image:: https://travis-ci.com/aio-libs/async-timeout.svg?branch=master
:target: https://travis-ci.com/aio-libs/async-timeout
.. image:: https://codecov.io/gh/aio-libs/async-timeout/branch/master/graph/badge.svg
:target: https://codecov.io/gh/aio-libs/async-timeout
.. image:: https://img.shields.io/pypi/v/async-timeout.svg
:target: https://pypi.python.org/pypi/async-timeout
.. image:: https://badges.gitter.im/Join%20Chat.svg
:target: https://gitter.im/aio-libs/Lobby
:alt: Chat on Gitter
asyncio-compatible timeout context manager.
DEPRECATED
----------
This library has effectively been upstreamed into Python 3.11+.
Therefore this library is considered deprecated and no longer actively supported.
Version 5.0+ provides dual-mode when executed on Python 3.11+:
``asyncio_timeout.Timeout`` is fully compatible with ``asyncio.Timeout`` *and* old
versions of the library.
Anyway, using upstream is highly recommended. ``asyncio_timeout`` exists only for the
sake of backward compatibility, easy supporting both old and new Python by the same
code, and easy misgration.
If rescheduling API is not important and only ``async with timeout(...): ...`` functionality is required,
a user could apply conditional import::
if sys.version_info >= (3, 11):
from asyncio import timeout, timeout_at
else:
from async_timeout import timeout, timeout_at
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(delay, *, loop=None)`` call returns a context manager
that cancels a block on *timeout* expiring::
from async_timeout import timeout
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.
Alternatively, ``timeout_at(when)`` can be used for scheduling
at the absolute time::
loop = asyncio.get_event_loop()
now = loop.time()
async with timeout_at(now + 1.5):
await inner()
Please note: it is not POSIX time but a time with
undefined starting base, e.g. the time of the system power on.
Context manager has ``.expired()`` / ``.expired`` for check if timeout happens
exactly in context manager::
async with timeout(1.5) as cm:
await inner()
print(cm.expired()) # recommended api
print(cm.expired) # compatible api
The property is ``True`` if ``inner()`` execution is cancelled by
timeout context manager.
If ``inner()`` call explicitly raises ``TimeoutError`` ``cm.expired``
is ``False``.
The scheduled deadline time is available as ``.when()`` / ``.deadline``::
async with timeout(1.5) as cm:
cm.when() # recommended api
cm.deadline # compatible api
Not finished yet timeout can be rescheduled by ``shift()``
or ``update()`` methods::
async with timeout(1.5) as cm:
# recommended api
cm.reschedule(cm.when() + 1) # add another second on waiting
# compatible api
cm.shift(1) # add another second on waiting
cm.update(loop.time() + 5) # reschedule to now+5 seconds
Rescheduling is forbidden if the timeout is expired or after exit from ``async with``
code block.
Disable scheduled timeout::
async with timeout(1.5) as cm:
cm.reschedule(None) # recommended api
cm.reject() # compatible api
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/aio-libs/async-timeout",
"name": "async-timeout",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Andrew Svetlov <andrew.svetlov@gmail.com>",
"author_email": "andrew.svetlov@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a5/ae/136395dfbfe00dfc94da3f3e136d0b13f394cba8f4841120e34226265780/async_timeout-5.0.1.tar.gz",
"platform": null,
"description": "async-timeout\n=============\n.. image:: https://travis-ci.com/aio-libs/async-timeout.svg?branch=master\n :target: https://travis-ci.com/aio-libs/async-timeout\n.. image:: https://codecov.io/gh/aio-libs/async-timeout/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/aio-libs/async-timeout\n.. image:: https://img.shields.io/pypi/v/async-timeout.svg\n :target: https://pypi.python.org/pypi/async-timeout\n.. image:: https://badges.gitter.im/Join%20Chat.svg\n :target: https://gitter.im/aio-libs/Lobby\n :alt: Chat on Gitter\n\nasyncio-compatible timeout context manager.\n\n\n\nDEPRECATED\n----------\n\nThis library has effectively been upstreamed into Python 3.11+.\n\nTherefore this library is considered deprecated and no longer actively supported.\n\nVersion 5.0+ provides dual-mode when executed on Python 3.11+:\n``asyncio_timeout.Timeout`` is fully compatible with ``asyncio.Timeout`` *and* old\nversions of the library.\n\nAnyway, using upstream is highly recommended. ``asyncio_timeout`` exists only for the\nsake of backward compatibility, easy supporting both old and new Python by the same\ncode, and easy misgration.\n\nIf rescheduling API is not important and only ``async with timeout(...): ...`` functionality is required,\na user could apply conditional import::\n\n if sys.version_info >= (3, 11):\n from asyncio import timeout, timeout_at\n else:\n from async_timeout import timeout, timeout_at\n\n\nUsage example\n-------------\n\n\nThe context manager is useful in cases when you want to apply timeout\nlogic around block of code or in cases when ``asyncio.wait_for()`` is\nnot suitable. Also it's much faster than ``asyncio.wait_for()``\nbecause ``timeout`` doesn't create a new task.\n\nThe ``timeout(delay, *, loop=None)`` call returns a context manager\nthat cancels a block on *timeout* expiring::\n\n from async_timeout import timeout\n async with timeout(1.5):\n await inner()\n\n1. If ``inner()`` is executed faster than in ``1.5`` seconds nothing\n happens.\n2. Otherwise ``inner()`` is cancelled internally by sending\n ``asyncio.CancelledError`` into but ``asyncio.TimeoutError`` is\n raised outside of context manager scope.\n\n*timeout* parameter could be ``None`` for skipping timeout functionality.\n\n\nAlternatively, ``timeout_at(when)`` can be used for scheduling\nat the absolute time::\n\n loop = asyncio.get_event_loop()\n now = loop.time()\n\n async with timeout_at(now + 1.5):\n await inner()\n\n\nPlease note: it is not POSIX time but a time with\nundefined starting base, e.g. the time of the system power on.\n\n\nContext manager has ``.expired()`` / ``.expired`` for check if timeout happens\nexactly in context manager::\n\n async with timeout(1.5) as cm:\n await inner()\n print(cm.expired()) # recommended api\n print(cm.expired) # compatible api\n\nThe property is ``True`` if ``inner()`` execution is cancelled by\ntimeout context manager.\n\nIf ``inner()`` call explicitly raises ``TimeoutError`` ``cm.expired``\nis ``False``.\n\nThe scheduled deadline time is available as ``.when()`` / ``.deadline``::\n\n async with timeout(1.5) as cm:\n cm.when() # recommended api\n cm.deadline # compatible api\n\nNot finished yet timeout can be rescheduled by ``shift()``\nor ``update()`` methods::\n\n async with timeout(1.5) as cm:\n # recommended api\n cm.reschedule(cm.when() + 1) # add another second on waiting\n # compatible api\n cm.shift(1) # add another second on waiting\n cm.update(loop.time() + 5) # reschedule to now+5 seconds\n\nRescheduling is forbidden if the timeout is expired or after exit from ``async with``\ncode block.\n\n\nDisable scheduled timeout::\n\n async with timeout(1.5) as cm:\n cm.reschedule(None) # recommended api\n cm.reject() # compatible api\n\n\n\nInstallation\n------------\n\n::\n\n $ pip install async-timeout\n\nThe library is Python 3 only!\n\n\n\nAuthors and License\n-------------------\n\nThe module is written by Andrew Svetlov.\n\nIt's *Apache 2* licensed and freely available.\n",
"bugtrack_url": null,
"license": "Apache 2",
"summary": "Timeout context manager for asyncio programs",
"version": "5.0.1",
"project_urls": {
"CI: GitHub Actions": "https://github.com/aio-libs/async-timeout/actions",
"Chat: Gitter": "https://gitter.im/aio-libs/Lobby",
"Coverage: codecov": "https://codecov.io/github/aio-libs/async-timeout",
"GitHub: issues": "https://github.com/aio-libs/async-timeout/issues",
"GitHub: repo": "https://github.com/aio-libs/async-timeout",
"Homepage": "https://github.com/aio-libs/async-timeout"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "febae2081de779ca30d473f21f5b30e0e737c438205440784c7dfc81efc2b029",
"md5": "efe854d55a96998187975472b17f7774",
"sha256": "39e3809566ff85354557ec2398b55e096c8364bacac9405a7a1fa429e77fe76c"
},
"downloads": -1,
"filename": "async_timeout-5.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "efe854d55a96998187975472b17f7774",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6233,
"upload_time": "2024-11-06T16:41:37",
"upload_time_iso_8601": "2024-11-06T16:41:37.900954Z",
"url": "https://files.pythonhosted.org/packages/fe/ba/e2081de779ca30d473f21f5b30e0e737c438205440784c7dfc81efc2b029/async_timeout-5.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a5ae136395dfbfe00dfc94da3f3e136d0b13f394cba8f4841120e34226265780",
"md5": "566a39011e87cb8044ee75369e69b327",
"sha256": "d9321a7a3d5a6a5e187e824d2fa0793ce379a202935782d555d6e9d2735677d3"
},
"downloads": -1,
"filename": "async_timeout-5.0.1.tar.gz",
"has_sig": false,
"md5_digest": "566a39011e87cb8044ee75369e69b327",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9274,
"upload_time": "2024-11-06T16:41:39",
"upload_time_iso_8601": "2024-11-06T16:41:39.600310Z",
"url": "https://files.pythonhosted.org/packages/a5/ae/136395dfbfe00dfc94da3f3e136d0b13f394cba8f4841120e34226265780/async_timeout-5.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 16:41:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aio-libs",
"github_project": "async-timeout",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "async-timeout"
}
JSON
