Fix-up docs for socketserver and queue renaming.

This commit is contained in:
Georg Brandl 2008-05-12 10:03:16 +00:00
parent bb141bb1f4
commit 7a148c2357
6 changed files with 20 additions and 18 deletions

View File

@ -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)

View File

@ -1,10 +1,16 @@
:mod:`socketserver` --- A framework for network servers
=======================================================
.. module:: SocketServer
:synopsis: Old name for the socketserver module.
.. module:: socketserver
:synopsis: A framework for network servers.
.. versionadded:: 2.6
.. note::
The :mod:`SocketServer` module has been renamed to :mod:`socketserver` in
Python 3.0. It is importable under both names in Python 2.6 and the rest of
the 2.x series.
The :mod:`socketserver` module simplifies the task of writing network servers.

View File

@ -1,8 +0,0 @@
:mod:`SocketServer` --- A framework for network servers
=======================================================
.. module:: SocketServer
:synopsis: A framework for network servers.
The :mod:`SocketServer` module has been renamed to :mod:`socketserver`
in Python 3.0. The old name is now deprecated.

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:`mutex` and :mod:`Queue` modules.
See also the :mod:`mutex` and :mod:`queue` modules.
The :mod:`dummy_threading` module is provided for situations where
:mod:`threading` cannot be used because :mod:`thread` is missing.

View File

@ -534,7 +534,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 expressions to get three objects,
using ``None`` as the value of omitted expressions. The first two objects are

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.