async-timeout-3.0.1/0000775000372000037200000000000013357052431015161 5ustar travistravis00000000000000async-timeout-3.0.1/LICENSE0000664000372000037200000002613513357052370016177 0ustar travistravis00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} 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. async-timeout-3.0.1/MANIFEST.in0000664000372000037200000000020313357052370016714 0ustar travistravis00000000000000include LICENSE include CHANGES.rst include README.rst graft async_timeout graft tests global-exclude *.pyc global-exclude *.cache async-timeout-3.0.1/setup.py0000664000372000037200000000250313357052370016675 0ustar travistravis00000000000000import pathlib import re import sys from setuptools import setup here = pathlib.Path(__file__).parent fname = here / 'async_timeout' / '__init__.py' with fname.open() as fp: try: version = re.findall(r"^__version__ = '([^']+)'$", fp.read(), re.M)[0] except IndexError: raise RuntimeError('Unable to determine version.') def read(name): fname = here / name with fname.open() as f: return f.read() setup(name='async-timeout', version=version, description=("Timeout context manager for asyncio programs"), long_description='\n\n'.join([read('README.rst'), read('CHANGES.rst')]), classifiers=[ 'License :: OSI Approved :: Apache Software License', 'Intended Audience :: Developers', 'Programming Language :: Python', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Topic :: Internet :: WWW/HTTP', 'Framework :: AsyncIO', ], author='Andrew Svetlov', author_email='andrew.svetlov@gmail.com', url='https://github.com/aio-libs/async_timeout/', license='Apache 2', packages=['async_timeout'], python_requires='>=3.5.3', include_package_data=True) async-timeout-3.0.1/README.rst0000664000372000037200000000363313357052370016657 0ustar travistravis00000000000000async-timeout ============= .. image:: https://travis-ci.org/aio-libs/async-timeout.svg?branch=master :target: https://travis-ci.org/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. 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. async-timeout-3.0.1/PKG-INFO0000664000372000037200000001207013357052431016256 0ustar travistravis00000000000000Metadata-Version: 1.2 Name: async-timeout Version: 3.0.1 Summary: Timeout context manager for asyncio programs Home-page: https://github.com/aio-libs/async_timeout/ Author: Andrew Svetlov Author-email: andrew.svetlov@gmail.com License: Apache 2 Description: async-timeout ============= .. image:: https://travis-ci.org/aio-libs/async-timeout.svg?branch=master :target: https://travis-ci.org/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. 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. Platform: UNKNOWN Classifier: License :: OSI Approved :: Apache Software License Classifier: Intended Audience :: Developers Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Topic :: Internet :: WWW/HTTP Classifier: Framework :: AsyncIO Requires-Python: >=3.5.3 async-timeout-3.0.1/CHANGES.rst0000664000372000037200000000257013357052370016771 0ustar travistravis00000000000000CHANGES ======= 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. async-timeout-3.0.1/tests/0000775000372000037200000000000013357052431016323 5ustar travistravis00000000000000async-timeout-3.0.1/tests/test_py35.py0000664000372000037200000000201213357052370020531 0ustar travistravis00000000000000import asyncio import pytest from async_timeout import timeout pytestmark = pytest.mark.asyncio async def test_async_timeout(loop): with pytest.raises(asyncio.TimeoutError): async with timeout(0.01, loop=loop) as cm: await asyncio.sleep(10, loop=loop) assert cm.expired async def test_async_no_timeout(loop): async with timeout(1, loop=loop) as cm: await asyncio.sleep(0, loop=loop) assert not cm.expired async def test_async_zero(loop): with pytest.raises(asyncio.TimeoutError): async with timeout(0, loop=loop) as cm: await asyncio.sleep(10, loop=loop) assert cm.expired async def test_async_zero_coro_not_started(loop): coro_started = False async def coro(): nonlocal coro_started coro_started = True with pytest.raises(asyncio.TimeoutError): async with timeout(0, loop=loop) as cm: await asyncio.sleep(0, loop=loop) await coro() assert cm.expired assert coro_started is False async-timeout-3.0.1/tests/test_timeout.py0000664000372000037200000001463513357052370021435 0ustar travistravis00000000000000import asyncio import os import time import pytest from async_timeout import timeout from asyncio import ensure_future def create_future(loop): """Compatibility wrapper for the loop.create_future() call introduced in 3.5.2.""" if hasattr(loop, 'create_future'): return loop.create_future() else: return asyncio.Future(loop=loop) @pytest.mark.asyncio async def test_timeout(loop): canceled_raised = False async def long_running_task(): try: await asyncio.sleep(10, loop=loop) except asyncio.CancelledError: nonlocal canceled_raised canceled_raised = True raise with pytest.raises(asyncio.TimeoutError): with timeout(0.01, loop=loop) as t: await long_running_task() assert t._loop is loop assert canceled_raised, 'CancelledError was not raised' @pytest.mark.asyncio async def test_timeout_finish_in_time(loop): async def long_running_task(): await asyncio.sleep(0.01, loop=loop) return 'done' with timeout(0.1, loop=loop): resp = await long_running_task() assert resp == 'done' def test_timeout_global_loop(loop): asyncio.set_event_loop(loop) async def run(): with timeout(10) as t: await asyncio.sleep(0.01) assert t._loop is loop loop.run_until_complete(run()) @pytest.mark.asyncio async def test_timeout_disable(loop): async def long_running_task(): await asyncio.sleep(0.1, loop=loop) return 'done' t0 = loop.time() with timeout(None, loop=loop): resp = await long_running_task() assert resp == 'done' dt = loop.time() - t0 assert 0.09 < dt < 0.13, dt def test_timeout_is_none_no_task(loop): with timeout(None, loop=loop) as cm: assert cm._task is None @pytest.mark.asyncio async def test_timeout_enable_zero(loop): with pytest.raises(asyncio.TimeoutError): with timeout(0, loop=loop) as cm: await asyncio.sleep(0.1, loop=loop) assert cm.expired @pytest.mark.asyncio async def test_timeout_enable_zero_coro_not_started(loop): coro_started = False async def coro(): nonlocal coro_started coro_started = True with pytest.raises(asyncio.TimeoutError): with timeout(0, loop=loop) as cm: await asyncio.sleep(0, loop=loop) await coro() assert cm.expired assert coro_started is False @pytest.mark.asyncio async def test_timeout_not_relevant_exception(loop): await asyncio.sleep(0, loop=loop) with pytest.raises(KeyError): with timeout(0.1, loop=loop): raise KeyError @pytest.mark.asyncio async def test_timeout_canceled_error_is_not_converted_to_timeout(loop): await asyncio.sleep(0, loop=loop) with pytest.raises(asyncio.CancelledError): with timeout(0.001, loop=loop): raise asyncio.CancelledError @pytest.mark.asyncio async def test_timeout_blocking_loop(loop): async def long_running_task(): time.sleep(0.1) return 'done' with timeout(0.01, loop=loop): result = await long_running_task() assert result == 'done' @pytest.mark.asyncio async def test_for_race_conditions(loop): fut = create_future(loop) loop.call_later(0.1, fut.set_result('done')) with timeout(0.2, loop=loop): resp = await fut assert resp == 'done' @pytest.mark.asyncio async def test_timeout_time(loop): foo_running = None start = loop.time() with pytest.raises(asyncio.TimeoutError): with timeout(0.1, loop=loop): foo_running = True try: await asyncio.sleep(0.2, loop=loop) finally: foo_running = False dt = loop.time() - start if not (0.09 < dt < 0.11) and os.environ.get('APPVEYOR'): pytest.xfail('appveyor sometimes is toooo sloooow') assert 0.09 < dt < 0.11 assert not foo_running def test_raise_runtimeerror_if_no_task(loop): with pytest.raises(RuntimeError): with timeout(0.1, loop=loop): pass @pytest.mark.asyncio async def test_outer_coro_is_not_cancelled(loop): has_timeout = False async def outer(): nonlocal has_timeout try: with timeout(0.001, loop=loop): await asyncio.sleep(1, loop=loop) except asyncio.TimeoutError: has_timeout = True task = ensure_future(outer(), loop=loop) await task assert has_timeout assert not task.cancelled() assert task.done() @pytest.mark.asyncio async def test_cancel_outer_coro(loop): fut = create_future(loop) async def outer(): fut.set_result(None) await asyncio.sleep(1, loop=loop) task = ensure_future(outer(), loop=loop) await fut task.cancel() with pytest.raises(asyncio.CancelledError): await task assert task.cancelled() assert task.done() @pytest.mark.asyncio async def test_timeout_suppress_exception_chain(loop): with pytest.raises(asyncio.TimeoutError) as ctx: with timeout(0.01, loop=loop): await asyncio.sleep(10, loop=loop) assert not ctx.value.__suppress_context__ @pytest.mark.asyncio async def test_timeout_expired(loop): with pytest.raises(asyncio.TimeoutError): with timeout(0.01, loop=loop) as cm: await asyncio.sleep(10, loop=loop) assert cm.expired @pytest.mark.asyncio async def test_timeout_inner_timeout_error(loop): with pytest.raises(asyncio.TimeoutError): with timeout(0.01, loop=loop) as cm: raise asyncio.TimeoutError assert not cm.expired @pytest.mark.asyncio async def test_timeout_inner_other_error(loop): with pytest.raises(RuntimeError): with timeout(0.01, loop=loop) as cm: raise RuntimeError assert not cm.expired @pytest.mark.asyncio async def test_timeout_remaining(loop): with timeout(None, loop=loop) as cm: assert cm.remaining is None t = timeout(1.0, loop=loop) assert t.remaining is None with timeout(1.0, loop=loop) as cm: await asyncio.sleep(0.1, loop=loop) assert cm.remaining < 1.0 with pytest.raises(asyncio.TimeoutError): with timeout(0.1, loop=loop) as cm: await asyncio.sleep(0.5, loop=loop) assert cm.remaining == 0.0 def test_cancel_without_starting(loop): tm = timeout(1, loop=loop) tm._cancel_task() tm._cancel_task() # double call should success async-timeout-3.0.1/tests/conftest.py0000664000372000037200000000011413357052370020520 0ustar travistravis00000000000000import pytest @pytest.fixture def loop(event_loop): return event_loop async-timeout-3.0.1/async_timeout/0000775000372000037200000000000013357052431020044 5ustar travistravis00000000000000async-timeout-3.0.1/async_timeout/py.typed0000664000372000037200000000001313357052370021537 0ustar travistravis00000000000000Placeholderasync-timeout-3.0.1/async_timeout/__init__.py0000664000372000037200000000710613357052370022163 0ustar travistravis00000000000000import asyncio import sys from types import TracebackType from typing import Optional, Type, Any # noqa __version__ = '3.0.1' PY_37 = sys.version_info >= (3, 7) class timeout: """timeout context manager. Useful in cases when you want to apply timeout logic around block of code or in cases when asyncio.wait_for is not suitable. For example: >>> with timeout(0.001): ... async with aiohttp.get('https://github.com') as r: ... await r.text() timeout - value in seconds or None to disable timeout logic loop - asyncio compatible event loop """ def __init__(self, timeout: Optional[float], *, loop: Optional[asyncio.AbstractEventLoop] = None) -> None: self._timeout = timeout if loop is None: loop = asyncio.get_event_loop() self._loop = loop self._task = None # type: Optional[asyncio.Task[Any]] self._cancelled = False self._cancel_handler = None # type: Optional[asyncio.Handle] self._cancel_at = None # type: Optional[float] def __enter__(self) -> 'timeout': return self._do_enter() def __exit__(self, exc_type: Type[BaseException], exc_val: BaseException, exc_tb: TracebackType) -> Optional[bool]: self._do_exit(exc_type) return None async def __aenter__(self) -> 'timeout': return self._do_enter() async def __aexit__(self, exc_type: Type[BaseException], exc_val: BaseException, exc_tb: TracebackType) -> None: self._do_exit(exc_type) @property def expired(self) -> bool: return self._cancelled @property def remaining(self) -> Optional[float]: if self._cancel_at is not None: return max(self._cancel_at - self._loop.time(), 0.0) else: return None def _do_enter(self) -> 'timeout': # Support Tornado 5- without timeout # Details: https://github.com/python/asyncio/issues/392 if self._timeout is None: return self self._task = current_task(self._loop) if self._task is None: raise RuntimeError('Timeout context manager should be used ' 'inside a task') if self._timeout <= 0: self._loop.call_soon(self._cancel_task) return self self._cancel_at = self._loop.time() + self._timeout self._cancel_handler = self._loop.call_at( self._cancel_at, self._cancel_task) return self def _do_exit(self, exc_type: Type[BaseException]) -> None: if exc_type is asyncio.CancelledError and self._cancelled: self._cancel_handler = None self._task = None raise asyncio.TimeoutError if self._timeout is not None and self._cancel_handler is not None: self._cancel_handler.cancel() self._cancel_handler = None self._task = None return None def _cancel_task(self) -> None: if self._task is not None: self._task.cancel() self._cancelled = True def current_task(loop: asyncio.AbstractEventLoop) -> 'asyncio.Task[Any]': if PY_37: task = asyncio.current_task(loop=loop) # type: ignore else: task = asyncio.Task.current_task(loop=loop) if task is None: # this should be removed, tokio must use register_task and family API if hasattr(loop, 'current_task'): task = loop.current_task() # type: ignore return task async-timeout-3.0.1/setup.cfg0000664000372000037200000000077513357052431017013 0ustar travistravis00000000000000[tool:pytest] addopts = --cov=async_timeout --cov-report=term --cov-report=html --cov-branch [metadata] license_file = LICENSE [mypy-pytest] ignore_missing_imports = true [mypy] python_version = 3.6 warn_unused_ignores = True warn_redundant_casts = True warn_no_return = True strict_optional = True show_traceback = True show_column_numbers = True no_implicit_optional = True disallow_incomplete_defs = True disallow_any_generics = True ignore_missing_imports = True [egg_info] tag_build = tag_date = 0 async-timeout-3.0.1/async_timeout.egg-info/0000775000372000037200000000000013357052431021536 5ustar travistravis00000000000000async-timeout-3.0.1/async_timeout.egg-info/SOURCES.txt0000664000372000037200000000047513357052431023430 0ustar travistravis00000000000000CHANGES.rst LICENSE MANIFEST.in README.rst setup.cfg setup.py async_timeout/__init__.py async_timeout/py.typed async_timeout.egg-info/PKG-INFO async_timeout.egg-info/SOURCES.txt async_timeout.egg-info/dependency_links.txt async_timeout.egg-info/top_level.txt tests/conftest.py tests/test_py35.py tests/test_timeout.pyasync-timeout-3.0.1/async_timeout.egg-info/dependency_links.txt0000664000372000037200000000000113357052431025604 0ustar travistravis00000000000000 async-timeout-3.0.1/async_timeout.egg-info/PKG-INFO0000664000372000037200000001207013357052431022633 0ustar travistravis00000000000000Metadata-Version: 1.2 Name: async-timeout Version: 3.0.1 Summary: Timeout context manager for asyncio programs Home-page: https://github.com/aio-libs/async_timeout/ Author: Andrew Svetlov Author-email: andrew.svetlov@gmail.com License: Apache 2 Description: async-timeout ============= .. image:: https://travis-ci.org/aio-libs/async-timeout.svg?branch=master :target: https://travis-ci.org/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. 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. Platform: UNKNOWN Classifier: License :: OSI Approved :: Apache Software License Classifier: Intended Audience :: Developers Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Topic :: Internet :: WWW/HTTP Classifier: Framework :: AsyncIO Requires-Python: >=3.5.3 async-timeout-3.0.1/async_timeout.egg-info/top_level.txt0000664000372000037200000000001613357052431024265 0ustar travistravis00000000000000async_timeout