1 Star 0 Fork 0

OpenFound/python-async_timeout

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

async-timeout

https://travis-ci.com/aio-libs/async-timeout.svg?branch=master 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.

Copyright 2016-2020 aio-libs collaboration. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
README
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

语言

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/foundos_1/python-async_timeout.git
git@gitee.com:foundos_1/python-async_timeout.git
foundos_1
python-async_timeout
python-async_timeout
master

搜索帮助