mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-04 11:49:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Issue #21376: document asyncio.TimeoutError

Browse source
This commit is contained in:
Victor Stinner 2014-05-29 00:04:57 +02:00
parent 12c575f2f6
commit 28d0ae48e9
1 changed files with 17 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Doc/library/asyncio-task.rst
View file

@ -142,6 +142,18 @@ InvalidStateError
The operation is not allowed in this state. The operation is not allowed in this state.
TimeoutError
------------
.. exception:: TimeoutError
The operation exceeded the given deadline.
.. note::
This exception is different from the builtin :exc:`TimeoutError` exception!
Future Future
------ ------
@ -400,7 +412,8 @@ Task functions
Return an iterator whose values, when waited for, are :class:`Future` Return an iterator whose values, when waited for, are :class:`Future`
instances. instances.
Raises :exc:`TimeoutError` if the timeout occurs before all Futures are done. Raises :exc:`asyncio.TimeoutError` if the timeout occurs before all Futures
are done.
Example:: Example::
@ -521,8 +534,8 @@ Task functions
.. note:: .. note::
This does not raise :exc:`TimeoutError`! Futures that aren't done when This does not raise :exc:`asyncio.TimeoutError`! Futures that aren't done
the timeout occurs are returned in the second set. when the timeout occurs are returned in the second set.
.. function:: wait_for(fut, timeout, \*, loop=None) .. function:: wait_for(fut, timeout, \*, loop=None)
@ -534,7 +547,7 @@ Task functions
Coroutine will be wrapped in :class:`Task`. Coroutine will be wrapped in :class:`Task`.
Returns result of the Future or coroutine. When a timeout occurs, it Returns result of the Future or coroutine. When a timeout occurs, it
cancels the task and raises :exc:`TimeoutError`. To avoid the task cancels the task and raises :exc:`asyncio.TimeoutError`. To avoid the task
cancellation, wrap it in :func:`shield`. cancellation, wrap it in :func:`shield`.
This function is a :ref:`coroutine <coroutine>`. This function is a :ref:`coroutine <coroutine>`.