diff options
author | Jakub Stasiak <jakub@stasiak.at> | 2020-11-02 10:56:35 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-02 10:56:35 (GMT) |
commit | 3d86d090dcbbdfdd3e5a5951cab30612d6131222 (patch) | |
tree | 3d67c14e2bf6ece554376a454fe7dde3b7fd01b9 /Doc/library | |
parent | 6e8dcdaaa49d4313bf9fab9f9923ca5828fbb10e (diff) | |
download | cpython-3d86d090dcbbdfdd3e5a5951cab30612d6131222.zip cpython-3d86d090dcbbdfdd3e5a5951cab30612d6131222.tar.gz cpython-3d86d090dcbbdfdd3e5a5951cab30612d6131222.tar.bz2 |
bpo-42230: Improve asyncio documentation regarding accepting sets vs iterables (GH-23073)
People call wait() and as_completed() with various non-set iterables,
a list should be the most common but there are others as well[1].
Considering typeshed also documents wait()[2] and as_completed()[3]
as accepting arbitrary iterables I think it's a good idea to document
the status quo better.
[1] https://github.com/aio-libs/aiokafka/pull/672
[2] https://github.com/python/typeshed/blob/620989bac572f30349b95590ebe81a73ce0fe862/stdlib/3/asyncio/tasks.pyi#L161
[3] https://github.com/python/typeshed/blob/620989bac572f30349b95590ebe81a73ce0fe862/stdlib/3/asyncio/tasks.pyi#L40
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/asyncio-task.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 99f0125..eb51c70 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -504,10 +504,10 @@ Waiting Primitives return_when=ALL_COMPLETED) Run :ref:`awaitable objects <asyncio-awaitables>` in the *aws* - set concurrently and block until the condition specified + iterable concurrently and block until the condition specified by *return_when*. - The *aws* set must not be empty. + The *aws* iterable must not be empty. Returns two sets of Tasks/Futures: ``(done, pending)``. @@ -593,9 +593,9 @@ Waiting Primitives .. function:: as_completed(aws, \*, loop=None, timeout=None) Run :ref:`awaitable objects <asyncio-awaitables>` in the *aws* - set concurrently. Return an iterator of coroutines. + iterable concurrently. Return an iterator of coroutines. Each coroutine returned can be awaited to get the earliest next - result from the set of the remaining awaitables. + result from the iterable of the remaining awaitables. Raises :exc:`asyncio.TimeoutError` if the timeout occurs before all Futures are done. |