diff options
Diffstat (limited to 'Doc/library/queue.rst')
-rw-r--r-- | Doc/library/queue.rst | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst index ceede52..aafd717 100644 --- a/Doc/library/queue.rst +++ b/Doc/library/queue.rst @@ -1,14 +1,18 @@ - -:mod:`Queue` --- A synchronized queue class +:mod:`queue` --- A synchronized queue class =========================================== .. module:: Queue + :synopsis: Old name for the queue module. + +.. module:: queue :synopsis: A synchronized queue class. .. note:: - The :mod:`Queue` module has been renamed to `queue` in Python 3.0. + The :mod:`Queue` module has been renamed to :mod:`queue` in Python 3.0. It + is importable under both names in Python 2.6 and the rest of the 2.x series. + -The :mod:`Queue` module implements multi-producer, multi-consumer queues. +The :mod:`queue` module implements multi-producer, multi-consumer queues. It is especially useful in threaded programming when information must be exchanged safely between multiple threads. The :class:`Queue` class in this module implements all the required locking semantics. It depends on the @@ -22,7 +26,7 @@ the first retrieved (operating like a stack). With a priority queue, the entries are kept sorted (using the :mod:`heapq` module) and the lowest valued entry is retrieved first. -The :mod:`Queue` module defines the following classes and exceptions: +The :mod:`queue` module defines the following classes and exceptions: .. class:: Queue(maxsize) |