(original) (raw)

changeset: 99973:673d1ccea050 branch: 3.5 parent: 99971:a9fca95f119a user: Senthil Kumaran senthil@uthcode.com date: Mon Jan 18 18:45:00 2016 -0800 files: Doc/library/concurrent.futures.rst description: issue23962 - Reference the correct TimeoutError in concurrent.futures documentation. Patch contributed by Ryder Lewis. diff -r a9fca95f119a -r 673d1ccea050 Doc/library/concurrent.futures.rst --- a/Doc/library/concurrent.futures.rst Tue Jan 19 01:10:58 2016 +0000 +++ b/Doc/library/concurrent.futures.rst Mon Jan 18 18:45:00 2016 -0800 @@ -42,7 +42,7 @@ Equivalent to :func:`map(func, *iterables) ` except *func* is executed 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 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 @@ -274,11 +274,12 @@ 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 - completed in *timeout* seconds, then a :exc:`TimeoutError` will be - raised. *timeout* can be an int or float. If *timeout* is not specified - or ``None``, there is no limit to the wait time. + completed in *timeout* seconds, then a + :exc:`concurrent.futures.TimeoutError` will be raised. *timeout* can be + 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. If the call raised, this method will raise the same exception. @@ -287,11 +288,12 @@ 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 - call hasn't completed in *timeout* seconds, then a :exc:`TimeoutError` - will be raised. *timeout* can be an int or float. If *timeout* is not - specified or ``None``, there is no limit to the wait time. + call hasn't completed in *timeout* seconds, then a + :exc:`concurrent.futures.TimeoutError` will be raised. *timeout* can be + 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. If the call completed without raising, ``None`` is returned. @@ -391,13 +393,12 @@ Returns an iterator over the :class:`Future` instances (possibly created by different :class:`Executor` instances) given by *fs* that yields futures as they complete (finished or were cancelled). Any futures given by *fs* that - are duplicated will be returned once. Any futures that completed - before :func:`as_completed` is called will be yielded first. The returned - iterator raises a :exc:`TimeoutError` if :meth:`~iterator.__next__` 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. - If *timeout* is not specified or ``None``, there is no limit to the wait - time. + are duplicated will be returned once. Any futures that completed before + :func:`as_completed` is called will be yielded first. The returned iterator + raises a :exc:`concurrent.futures.TimeoutError` if :meth:`~iterator.__next__` + 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. If + *timeout* is not specified or ``None``, there is no limit to the wait time. .. seealso:: @@ -410,6 +411,16 @@ 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 .. exception:: BrokenProcessPool/senthil@uthcode.com