mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-03 13:45:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Documented the new error_callback keyword argument to multiprocessing.Pool's apply_async and map_async

Browse source
This commit is contained in:
Ask Solem 2010-11-09 21:36:56 +00:00
parent 9bc35682de
commit 1d3b89397b
1 changed files with 19 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

24
Doc/library/multiprocessing.rst
View file

@ -1582,14 +1582,21 @@ with the :class:`Pool` class.
suited for performing work in parallel. Additionally, the passed in suited for performing work in parallel. Additionally, the passed in
function is only executed in one of the workers of the pool. function is only executed in one of the workers of the pool.
.. method:: apply_async(func[, args[, kwds[, callback]]]) .. method:: apply_async(func[, args[, kwds[, callback[, error_callback]]]])
A variant of the :meth:`apply` method which returns a result object. A variant of the :meth:`apply` method which returns a result object.
If *callback* is specified then it should be a callable which accepts a If *callback* is specified then it should be a callable which accepts a
single argument. When the result becomes ready *callback* is applied to single argument. When the result becomes ready *callback* is applied to
it (unless the call failed). *callback* should complete immediately since it, that is unless the call failed, in which case the *error_callback*
otherwise the thread which handles the results will get blocked. is applied instead
If *error_callback* is specified then it should be a callable which
accepts a single argument. If the target function fails, then
the *error_callback* is called with the exception instance.
Callbacks should complete immediately since otherwise the thread which
handles the results will get blocked.
.. method:: map(func, iterable[, chunksize]) .. method:: map(func, iterable[, chunksize])
@ -1606,8 +1613,15 @@ with the :class:`Pool` class.
If *callback* is specified then it should be a callable which accepts a If *callback* is specified then it should be a callable which accepts a
single argument. When the result becomes ready *callback* is applied to single argument. When the result becomes ready *callback* is applied to
it (unless the call failed). *callback* should complete immediately since it, that is unless the call failed, in which case the *error_callback*
otherwise the thread which handles the results will get blocked. is applied instead
If *error_callback* is specified then it should be a callable which
accepts a single argument. If the target function fails, then
the *error_callback* is called with the exception instance.
Callbacks should complete immediately since otherwise the thread which
handles the results will get blocked.
.. method:: imap(func, iterable[, chunksize]) .. method:: imap(func, iterable[, chunksize])