]> granicus.if.org Git - python/commitdiff
Document asyncio.QueueFull/Empty.
authorGuido van Rossum <guido@python.org>
Sun, 26 Jan 2014 01:38:31 +0000 (17:38 -0800)
committerGuido van Rossum <guido@python.org>
Sun, 26 Jan 2014 01:38:31 +0000 (17:38 -0800)
Doc/library/asyncio-sync.rst

index 5ac9f34d23047d1cbf9e38f15428fb5c3c6d72e5..e125951a225005467e1b62869933418af0094db4 100644 (file)
@@ -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.