]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.15] gh-152614: Add raises to `QueueShutDown` in `asyncio.Queue.put_no_wait` and...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sat, 11 Jul 2026 12:46:14 +0000 (14:46 +0200)
committerGitHub <noreply@github.com>
Sat, 11 Jul 2026 12:46:14 +0000 (18:16 +0530)
gh-152614: Add raises to `QueueShutDown` in `asyncio.Queue.put_no_wait` and `asyncio.Queue.get_nowait` documentation methods (GH-152681)
(cherry picked from commit d1a5b54abaca2b443c7642ef3a7be8e1cd077ae3)

Co-authored-by: Duprat <yduprat@gmail.com>
Doc/library/asyncio-queue.rst

index a9735ae80652df67354780c1e190e2911c333d25..5e3f531f4e482e4bebddc9fd6eb542a66f523196 100644 (file)
@@ -71,6 +71,8 @@ Queue
       Return an item if one is immediately available, else raise
       :exc:`QueueEmpty`.
 
+      Raises :exc:`QueueShutDown` if the queue has been shut down and is empty.
+
    .. method:: join()
       :async:
 
@@ -96,6 +98,8 @@ Queue
 
       If no free slot is immediately available, raise :exc:`QueueFull`.
 
+      Raises :exc:`QueueShutDown` if the queue has been shut down.
+
    .. method:: qsize()
 
       Return the number of items in the queue.
@@ -188,8 +192,9 @@ Exceptions
 
 .. exception:: QueueShutDown
 
-   Exception raised when :meth:`~Queue.put` or :meth:`~Queue.get` is
-   called on a queue which has been shut down.
+   Exception raised when :meth:`~Queue.put`, :meth:`~Queue.put_nowait`,
+   :meth:`~Queue.get` or :meth:`~Queue.get_nowait` is called
+   on a queue which has been shut down.
 
    .. versionadded:: 3.13