mirror of
https://github.com/python/cpython.git
synced 2026-07-25 11:22:45 -04:00
[3.15] gh-152614: Add raises to QueueShutDown in asyncio.Queue.put_no_wait and asyncio.Queue.get_nowait documentation methods (GH-152681) (#153565)
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 d1a5b54aba)
Co-authored-by: Duprat <yduprat@gmail.com>
This commit is contained in:
committed by
GitHub
parent
487ac27295
commit
f237c8610f
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user