Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

issue23962 - Reference the correct TimeoutError in concurrent.futures documentation. 

Patch contributed by Ryder Lewis.
This commit is contained in:
Senthil Kumaran 2016-01-18 18:45:00 -08:00
parent 8f19e8e1c5
commit 9e9f850f99
1 changed files with 27 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Doc/library/concurrent.futures.rst
View File

@ -42,7 +42,7 @@ Executor Objects
Equivalent to :func:`map(func, *iterables) <map>` except *func* is executed Equivalent to :func:`map(func, *iterables) <map>` except *func* is executed
asynchronously and several calls to *func* may be made concurrently. The asynchronously and several calls to *func* may be made concurrently. The
returned iterator raises a :exc:`TimeoutError` if returned iterator raises a :exc:`concurrent.futures.TimeoutError` if
:meth:`~iterator.__next__` is called and the result isn't available :meth:`~iterator.__next__` is called and the result isn't available
after *timeout* seconds from the original call to :meth:`Executor.map`. after *timeout* seconds from the original call to :meth:`Executor.map`.
*timeout* can be an int or a float. If *timeout* is not specified or *timeout* can be an int or a float. If *timeout* is not specified or
@ -274,11 +274,12 @@ The :class:`Future` class encapsulates the asynchronous execution of a callable.
Return the value returned by the call. If the call hasn't yet completed Return the value returned by the call. If the call hasn't yet completed
then this method will wait up to *timeout* seconds. If the call hasn't then this method will wait up to *timeout* seconds. If the call hasn't
completed in *timeout* seconds, then a :exc:`TimeoutError` will be completed in *timeout* seconds, then a
raised. *timeout* can be an int or float. If *timeout* is not specified :exc:`concurrent.futures.TimeoutError` will be raised. *timeout* can be
or ``None``, there is no limit to the wait time. an int or float. If *timeout* is not specified or ``None``, there is no
limit to the wait time.
If the future is cancelled before completing then :exc:`CancelledError` If the future is cancelled before completing then :exc:`.CancelledError`
will be raised. will be raised.
If the call raised, this method will raise the same exception. If the call raised, this method will raise the same exception.
@ -287,11 +288,12 @@ The :class:`Future` class encapsulates the asynchronous execution of a callable.
Return the exception raised by the call. If the call hasn't yet Return the exception raised by the call. If the call hasn't yet
completed then this method will wait up to *timeout* seconds. If the completed then this method will wait up to *timeout* seconds. If the
call hasn't completed in *timeout* seconds, then a :exc:`TimeoutError` call hasn't completed in *timeout* seconds, then a
will be raised. *timeout* can be an int or float. If *timeout* is not :exc:`concurrent.futures.TimeoutError` will be raised. *timeout* can be
specified or ``None``, there is no limit to the wait time. an int or float. If *timeout* is not specified or ``None``, there is no
limit to the wait time.
If the future is cancelled before completing then :exc:`CancelledError` If the future is cancelled before completing then :exc:`.CancelledError`
will be raised. will be raised.
If the call completed without raising, ``None`` is returned. If the call completed without raising, ``None`` is returned.
@ -391,13 +393,12 @@ Module Functions
Returns an iterator over the :class:`Future` instances (possibly created by Returns an iterator over the :class:`Future` instances (possibly created by
different :class:`Executor` instances) given by *fs* that yields futures as different :class:`Executor` instances) given by *fs* that yields futures as
they complete (finished or were cancelled). Any futures given by *fs* that they complete (finished or were cancelled). Any futures given by *fs* that
are duplicated will be returned once. Any futures that completed are duplicated will be returned once. Any futures that completed before
before :func:`as_completed` is called will be yielded first. The returned :func:`as_completed` is called will be yielded first. The returned iterator
iterator raises a :exc:`TimeoutError` if :meth:`~iterator.__next__` is raises a :exc:`concurrent.futures.TimeoutError` if :meth:`~iterator.__next__`
called and the result isn't available after *timeout* seconds from the is called and the result isn't available after *timeout* seconds from the
original call to :func:`as_completed`. *timeout* can be an int or float. original call to :func:`as_completed`. *timeout* can be an int or float. If
If *timeout* is not specified or ``None``, there is no limit to the wait *timeout* is not specified or ``None``, there is no limit to the wait time.
time.
.. seealso:: .. seealso::
@ -410,6 +411,16 @@ Module Functions
Exception classes Exception classes
----------------- -----------------
.. currentmodule:: concurrent.futures
.. exception:: CancelledError
Raised when a future is cancelled.
.. exception:: TimeoutError
Raised when a future operation exceeds the given timeout.
.. currentmodule:: concurrent.futures.process .. currentmodule:: concurrent.futures.process
.. exception:: BrokenProcessPool .. exception:: BrokenProcessPool