Rename Queue module to queue.

Updated documentation to use new name.
Merged revisions 63077 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r63077 | alexandre.vassalotti | 2008-05-11 15:39:48 -0400 (Sun, 11 May 2008) | 3 lines

  Added stub for the Queue module to be renamed in 3.0.
  Use the 3.0 module name to avoid spurious warnings.
........
This commit is contained in:
Alexandre Vassalotti 2008-05-11 19:59:59 +00:00
parent 4e3e21e2cf
commit f260e443ac
12 changed files with 49 additions and 33 deletions

View file

@ -1,12 +1,12 @@
:mod:`Queue` --- A synchronized queue class
:mod:`queue` --- A synchronized queue class
===========================================
.. module:: Queue
.. module:: queue
:synopsis: A synchronized queue class.
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
@ -20,7 +20,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)

View file

@ -8,7 +8,7 @@
This module constructs higher-level threading interfaces on top of the lower
level :mod:`thread` module.
See also the :mod:`Queue` module.
See also the :mod:`queue` module.
The :mod:`dummy_threading` module is provided for situations where
:mod:`threading` cannot be used because :mod:`thread` is missing.

View file

@ -485,7 +485,7 @@ The :keyword:`raise` statement
If no expressions are present, :keyword:`raise` re-raises the last exception
that was active in the current scope. If no exception is active in the current
scope, a :exc:`TypeError` exception is raised indicating that this is an error
(if running under IDLE, a :exc:`Queue.Empty` exception is raised instead).
(if running under IDLE, a :exc:`queue.Empty` exception is raised instead).
Otherwise, :keyword:`raise` evaluates the first expression as the exception
object. It must be either a subclass or an instance of :class:`BaseException`.

View file

@ -198,7 +198,7 @@ variables, and semaphores.
While those tools are powerful, minor design errors can result in problems that
are difficult to reproduce. So, the preferred approach to task coordination is
to concentrate all access to a resource in a single thread and then use the
:mod:`Queue` module to feed that thread with requests from other threads.
:mod:`queue` module to feed that thread with requests from other threads.
Applications using :class:`Queue` objects for inter-thread communication and
coordination are easier to design, more readable, and more reliable.