summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>2014-01-26 01:38:31 (GMT)
committerGuido van Rossum <guido@python.org>2014-01-26 01:38:31 (GMT)
commit9ad116bcd05cf9b98f544916633641933a0db95c (patch)
tree3e23a9f5efda81b5ebf650b70257a83aa71639fb /Doc
parentd6fb2c76299d33da31b33948bacbda691da1d473 (diff)
downloadcpython-9ad116bcd05cf9b98f544916633641933a0db95c.zip
cpython-9ad116bcd05cf9b98f544916633641933a0db95c.tar.gz
cpython-9ad116bcd05cf9b98f544916633641933a0db95c.tar.bz2
Document asyncio.QueueFull/Empty.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/asyncio-sync.rst20
1 files changed, 18 insertions, 2 deletions
diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst
index 5ac9f34..e125951 100644
--- a/Doc/library/asyncio-sync.rst
+++ b/Doc/library/asyncio-sync.rst
@@ -286,7 +286,7 @@ Queue
Remove and return an item from the queue.
Return an item if one is immediately available, else raise
- :exc:`~queue.Empty`.
+ :exc:`QueueEmpty`.
.. method:: put(item)
@@ -301,7 +301,7 @@ Queue
Put an item into the queue without blocking.
- If no free slot is immediately available, raise :exc:`~queue.Full`.
+ If no free slot is immediately available, raise :exc:`QueueFull`.
.. method:: qsize()
@@ -367,3 +367,19 @@ JoinableQueue
Raises :exc:`ValueError` if called more times than there were items
placed in the queue.
+
+Exceptions
+^^^^^^^^^^
+
+.. exception:: QueueEmpty
+
+ Exception raised when non-blocking :meth:`~Queue.get` (or
+ :meth:`~Queue.get_nowait`) is called
+ on a :class:`Queue` object which is empty.
+
+
+.. exception:: QueueFull
+
+ Exception raised when non-blocking :meth:`~Queue.put` (or
+ :meth:`~Queue.put_nowait`) is called
+ on a :class:`Queue` object which is full.