diff options
| author | Laurie O <laurie_opperman@hotmail.com> | 2024-04-08 14:50:54 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-08 14:50:54 (GMT) |
| commit | e16062dd3428a5846344e0a8c6ee2f352d34ce1b (patch) | |
| tree | 8031a3fe204bd6aeeb66febd2be9a3f976a356c6 | |
| parent | 26a680a58524fe39eecb243e37adfa6e157466f6 (diff) | |
| download | cpython-e16062dd3428a5846344e0a8c6ee2f352d34ce1b.zip cpython-e16062dd3428a5846344e0a8c6ee2f352d34ce1b.tar.gz cpython-e16062dd3428a5846344e0a8c6ee2f352d34ce1b.tar.bz2 | |
gh-96471: Correct documentation for asyncio queue shutdown (#117621)
| -rw-r--r-- | Doc/library/asyncio-queue.rst | 7 | ||||
| -rw-r--r-- | Doc/whatsnew/3.13.rst | 2 | ||||
| -rw-r--r-- | Lib/asyncio/queues.py | 6 |
3 files changed, 9 insertions, 6 deletions
diff --git a/Doc/library/asyncio-queue.rst b/Doc/library/asyncio-queue.rst index 030d431..9b579cc 100644 --- a/Doc/library/asyncio-queue.rst +++ b/Doc/library/asyncio-queue.rst @@ -106,9 +106,10 @@ Queue raise once the queue is empty. Set *immediate* to true to make :meth:`~Queue.get` raise immediately instead. - All blocked callers of :meth:`~Queue.put` will be unblocked. If - *immediate* is true, also unblock callers of :meth:`~Queue.get` - and :meth:`~Queue.join`. + All blocked callers of :meth:`~Queue.put` and :meth:`~Queue.get` + will be unblocked. If *immediate* is true, a task will be marked + as done for each remaining item in the queue, which may unblock + callers of :meth:`~Queue.join`. .. versionadded:: 3.13 diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst index 9e40bf0..0fe2daf 100644 --- a/Doc/whatsnew/3.13.rst +++ b/Doc/whatsnew/3.13.rst @@ -298,7 +298,7 @@ asyncio * Add :meth:`asyncio.Queue.shutdown` (along with :exc:`asyncio.QueueShutDown`) for queue termination. - (Contributed by Laurie Opperman in :gh:`104228`.) + (Contributed by Laurie Opperman and Yves Duprat in :gh:`104228`.) base64 ------ diff --git a/Lib/asyncio/queues.py b/Lib/asyncio/queues.py index b815670..2f38651 100644 --- a/Lib/asyncio/queues.py +++ b/Lib/asyncio/queues.py @@ -256,8 +256,9 @@ class Queue(mixins._LoopBoundMixin): By default, gets will only raise once the queue is empty. Set 'immediate' to True to make gets raise immediately instead. - All blocked callers of put() will be unblocked, and also get() - and join() if 'immediate'. + All blocked callers of put() and get() will be unblocked. If + 'immediate', a task is marked as done for each item remaining in + the queue, which may unblock callers of join(). """ self._is_shutdown = True if immediate: @@ -267,6 +268,7 @@ class Queue(mixins._LoopBoundMixin): self._unfinished_tasks -= 1 if self._unfinished_tasks == 0: self._finished.set() + # All getters need to re-check queue-empty to raise ShutDown while self._getters: getter = self._getters.popleft() if not getter.done(): |