Skip to content

gh-150285: Fix too long docstrings in the concurrent package #151076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
serhiy-storchaka wants to merge 1 commit into
base: main
Choose a base branch
from
+89 −79
Open

gh-150285: Fix too long docstrings in the concurrent package #151076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 59 additions & 53 deletions Lib/concurrent/futures/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,15 +194,15 @@ def as_completed(fs, timeout=None):
"""An iterator over the given futures that yields each as it completes.

Args:
fs: The sequence of Futures (possibly created by different Executors) to
iterate over.
timeout: The maximum number of seconds to wait. If None, then there
is no limit on the wait time.
fs: The sequence of Futures (possibly created by different
Executors) to iterate over.
timeout: The maximum number of seconds to wait. If None, then
there is no limit on the wait time.

Returns:
An iterator that yields the given Futures as they complete (finished or
cancelled). If any given Futures are duplicated, they will be returned
once.
An iterator that yields the given Futures as they complete
(finished or cancelled). If any given Futures are duplicated,
they will be returned once.

Raises:
TimeoutError: If the entire result iterator could not be generated
Expand Down Expand Up @@ -258,19 +258,20 @@ def wait(fs, timeout=None, return_when=ALL_COMPLETED):
"""Wait for the futures in the given sequence to complete.

Args:
fs: The sequence of Futures (possibly created by different Executors) to
wait upon.
timeout: The maximum number of seconds to wait. If None, then there
is no limit on the wait time.
return_when: Indicates when this function should return. The options
are:
fs: The sequence of Futures (possibly created by different
Executors) to wait upon.
timeout: The maximum number of seconds to wait. If None, then
there is no limit on the wait time.
return_when: Indicates when this function should return.
The options are:

FIRST_COMPLETED - Return when any future finishes or is
cancelled.
FIRST_EXCEPTION - Return when any future finishes by raising an
exception. If no future raises an exception
exception. If no future raises an exception
then it is equivalent to ALL_COMPLETED.
ALL_COMPLETED - Return when all futures finish or are cancelled.
ALL_COMPLETED - Return when all futures finish or are
cancelled.

Returns:
A named 2-tuple of sets. The first set, named 'done', contains the
Expand Down Expand Up @@ -404,11 +405,12 @@ def add_done_callback(self, fn):

Args:
fn: A callable that will be called with this future as its only
argument when the future completes or is cancelled. The callable
will always be called by a thread in the same process in which
it was added. If the future has already completed or been
cancelled then the callable will be called immediately. These
callables are called in the order that they were added.
argument when the future completes or is cancelled. The
callable will always be called by a thread in the same
process in which it was added. If the future has already
completed or been cancelled then the callable will be
called immediately. These callables are called in the
order that they were added.
"""
with self._condition:
if self._state not in [CANCELLED, CANCELLED_AND_NOTIFIED, FINISHED]:
Expand All @@ -423,17 +425,19 @@ def result(self, timeout=None):
"""Return the result of the call that the future represents.

Args:
timeout: The number of seconds to wait for the result if the future
isn't done. If None, then there is no limit on the wait time.
timeout: The number of seconds to wait for the result if the
future isn't done. If None, then there is no limit on the
wait time.

Returns:
The result of the call that the future represents.

Raises:
CancelledError: If the future was cancelled.
TimeoutError: If the future didn't finish executing before the given
timeout.
Exception: If the call raised then that exception will be raised.
TimeoutError: If the future didn't finish executing before the
given timeout.
Exception: If the call raised then that exception will be
raised.
"""
try:
with self._condition:
Expand All @@ -459,17 +463,17 @@ def exception(self, timeout=None):

Args:
timeout: The number of seconds to wait for the exception if the
future isn't done. If None, then there is no limit on the wait
time.
future isn't done. If None, then there is no limit on the
wait time.

Returns:
The exception raised by the call that the future represents or None
if the call completed without raising.
The exception raised by the call that the future represents or
None if the call completed without raising.

Raises:
CancelledError: If the future was cancelled.
TimeoutError: If the future didn't finish executing before the given
timeout.
TimeoutError: If the future didn't finish executing before the
given timeout.
"""

with self._condition:
Expand All @@ -494,22 +498,23 @@ def set_running_or_notify_cancel(self):
Should only be used by Executor implementations and unit tests.

If the future has been cancelled (cancel() was called and returned
True) then any threads waiting on the future completing (though calls
to as_completed() or wait()) are notified and False is returned.
True) then any threads waiting on the future completing (though
calls to as_completed() or wait()) are notified and False is
returned.

If the future was not cancelled then it is put in the running state
(future calls to running() will return True) and True is returned.

This method should be called by Executor implementations before
executing the work associated with this future. If this method returns
False then the work should not be executed.
executing the work associated with this future. If this method
returns False then the work should not be executed.

Returns:
False if the Future was cancelled, True otherwise.

Raises:
RuntimeError: if this method was already called or if set_result()
or set_exception() was called.
RuntimeError: if this method was already called or if
set_result() or set_exception() was called.
"""
with self._condition:
if self._state == CANCELLED:
Expand Down Expand Up @@ -593,8 +598,9 @@ class Executor(object):
def submit(self, fn, /, *args, **kwargs):
"""Submits a callable to be executed with the given arguments.

Schedules the callable to be executed as fn(*args, **kwargs) and returns
a Future instance representing the execution of the callable.
Schedules the callable to be executed as fn(*args, **kwargs) and
returns a Future instance representing the execution of the
callable.

Returns:
A Future representing the given call.
Expand All @@ -607,25 +613,25 @@ def map(self, fn, *iterables, timeout=None, chunksize=1, buffersize=None):
Args:
fn: A callable that will take as many arguments as there are
passed iterables.
timeout: The maximum number of seconds to wait. If None, then there
is no limit on the wait time.
chunksize: The size of the chunks the iterable will be broken into
before being passed to a child process. This argument is only
used by ProcessPoolExecutor; it is ignored by
timeout: The maximum number of seconds to wait. If None, then
there is no limit on the wait time.
chunksize: The size of the chunks the iterable will be broken
into before being passed to a child process. This argument
is only used by ProcessPoolExecutor; it is ignored by
ThreadPoolExecutor.
buffersize: The number of submitted tasks whose results have not
yet been yielded. If the buffer is full, iteration over the
yet been yielded. If the buffer is full, iteration over the
iterables pauses until a result is yielded from the buffer.
If None, all input elements are eagerly collected, and a task is
submitted for each.
If None, all input elements are eagerly collected, and
a task is submitted for each.

Returns:
An iterator equivalent to: map(func, *iterables) but the calls may
be evaluated out-of-order.
An iterator equivalent to: map(func, *iterables) but the calls
may be evaluated out-of-order.

Raises:
TimeoutError: If the entire result iterator could not be generated
before the given timeout.
TimeoutError: If the entire result iterator could not be
generated before the given timeout.
Exception: If fn(*args) raises for any values.
"""
if buffersize is not None and not isinstance(buffersize, int):
Expand Down Expand Up @@ -679,8 +685,8 @@ def shutdown(self, wait=True, *, cancel_futures=False):

Args:
wait: If True then shutdown will not return until all running
futures have finished executing and the resources used by the
executor have been reclaimed.
futures have finished executing and the resources used by
the executor have been reclaimed.
cancel_futures: If True then shutdown will cancel all pending
futures. Futures that are completed or running will not be
cancelled.
Expand Down
4 changes: 2 additions & 2 deletions Lib/concurrent/futures/interpreter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ def __init__(self, max_workers=None, thread_name_prefix='',
"""Initializes a new InterpreterPoolExecutor instance.

Args:
max_workers: The maximum number of interpreters that can be used to
execute the given calls.
max_workers: The maximum number of interpreters that can be used
to execute the given calls.
thread_name_prefix: An optional name prefix to give our threads.
initializer: A callable or script used to initialize
each worker interpreter.
Expand Down
49 changes: 26 additions & 23 deletions Lib/concurrent/futures/process.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -656,19 +656,21 @@ def __init__(self, max_workers=None, mp_context=None,

Args:
max_workers: The maximum number of processes that can be used to
execute the given calls. If None or not given then as many
worker processes will be created as the machine has processors.
mp_context: A multiprocessing context to launch the workers created
using the multiprocessing.get_context('start method') API. This
object should provide SimpleQueue, Queue and Process.
execute the given calls. If None or not given then as many
worker processes will be created as the machine has
processors.
mp_context: A multiprocessing context to launch the workers
created using the multiprocessing.get_context('start method')
API. This object should provide SimpleQueue, Queue and
Process.
initializer: A callable used to initialize worker processes.
initargs: A tuple of arguments to pass to the initializer.
max_tasks_per_child: The maximum number of tasks a worker process
can complete before it will exit and be replaced with a fresh
worker process. The default of None means worker process will
live as long as the executor. Requires a non-'fork' mp_context
start method. When given, we default to using 'spawn' if no
mp_context is supplied.
max_tasks_per_child: The maximum number of tasks a worker
process can complete before it will exit and be replaced
with a fresh worker process. The default of None means
worker process will live as long as the executor. Requires
a non-'fork' mp_context start method. When given, we
default to using 'spawn' if no mp_context is supplied.
"""
_check_system_limits()

Expand Down Expand Up @@ -838,24 +840,25 @@ def map(self, fn, *iterables, timeout=None, chunksize=1, buffersize=None):
Args:
fn: A callable that will take as many arguments as there are
passed iterables.
timeout: The maximum number of seconds to wait. If None, then there
is no limit on the wait time.
chunksize: If greater than one, the iterables will be chopped into
chunks of size chunksize and submitted to the process pool.
If set to one, the items in the list will be sent one at a time.
timeout: The maximum number of seconds to wait. If None, then
there is no limit on the wait time.
chunksize: If greater than one, the iterables will be chopped
into chunks of size chunksize and submitted to the process
pool. If set to one, the items in the list will be sent
one at a time.
buffersize: The number of submitted tasks whose results have not
yet been yielded. If the buffer is full, iteration over the
yet been yielded. If the buffer is full, iteration over the
iterables pauses until a result is yielded from the buffer.
If None, all input elements are eagerly collected, and a task is
submitted for each.
If None, all input elements are eagerly collected, and
a task is submitted for each.

Returns:
An iterator equivalent to: map(func, *iterables) but the calls may
be evaluated out-of-order.
An iterator equivalent to: map(func, *iterables) but the calls
may be evaluated out-of-order.

Raises:
TimeoutError: If the entire result iterator could not be generated
before the given timeout.
TimeoutError: If the entire result iterator could not be
generated before the given timeout.
Exception: If fn(*args) raises for any values.
"""
if chunksize < 1:
Expand Down
3 changes: 2 additions & 1 deletion Lib/concurrent/interpreters/_queues.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,8 @@ def put(self, obj, block=True, timeout=None, *,
underlying data is actually shared. Furthermore, some types
can be sent through a queue more efficiently than others. This
group includes various immutable types like int, str, bytes, and
tuple (if the items are likewise efficiently shareable). See interpreters.is_shareable().
tuple (if the items are likewise efficiently shareable).
See interpreters.is_shareable().

"unbounditems" controls the behavior of Queue.get() for the given
object if the current interpreter (calling put()) is later
Expand Down
Loading