Commit 4ef33292 authored by Fred Drake's avatar Fred Drake

Logical markup.

Correct misuse of indexsubutem.

Describe the Queue class using {classdesc}{Queue}, not {funcdesc}{__init__}.
parent 8aee0e03
\section{Standard Module \sectcode{Queue}} \section{Standard Module \sectcode{Queue}}
\stmodindex{Queue} \stmodindex{Queue}
\label{module-Queue} \label{module-Queue}
% ==== 2. ====
% Give a short overview of what the module does.
% If it is platform specific, mention this.
% Mention other important restrictions or general operating principles.
% For example:
The \code{Queue} module implements a multi-producer, multi-consumer The \module{Queue} module implements a multi-producer, multi-consumer
FIFO queue. It is especially useful in threads programming when FIFO queue. It is especially useful in threads programming when
information must be exchanged safely between multiple threads. The information must be exchanged safely between multiple threads. The
\code{Queue} class in this module implements all the required locking \class{Queue} class in this module implements all the required locking
semantics. It depends on the availability of thread support in semantics. It depends on the availability of thread support in
Python. Python.
The \code{Queue} module defines the following exception: The \module{Queue} module defines the following class and exception:
\setindexsubitem{(in module Queue)}
\begin{classdesc}{Queue}{maxsize}
Constructor for the class. \var{maxsize} is an integer that sets the
upperbound limit on the number of items that can be placed in the
queue. Insertion will block once this size has been reached, until
queue items are consumed. If \var{maxsize} is less than or equal to
zero, the queue size is infinite.
\end{classdesc}
\begin{excdesc}{Empty} \begin{excdesc}{Empty}
Exception raised when non-blocking get (e.g. \code{get_nowait()}) is Exception raised when non-blocking get (e.g. \method{get_nowait()}) is
called on a Queue object which is empty, or for which the emptyiness called on a \class{Queue} object which is empty, or for which the
cannot be determined (i.e. because the appropriate locks cannot be emptyiness cannot be determined (i.e. because the appropriate locks
acquired). cannot be acquired).
\end{excdesc} \end{excdesc}
\subsection{Queue Objects} \subsection{Queue Objects}
\label{QueueObjects}
Class \code{Queue} implements queue objects and has the methods Class \class{Queue} implements queue objects and has the methods
described below. This class can be derived from in order to implement described below. This class can be derived from in order to implement
other queue organizations (e.g. stack) but the inheritable interface other queue organizations (e.g. stack) but the inheritable interface
is not described here. See the source code for details. The public is not described here. See the source code for details. The public
interface methods are: methods are:
\setindexsubitem{(__init__ method)} \setindexsubitem{(Queue method)}
\begin{funcdesc}{__init__}{maxsize}
Constructor for the class. \var{maxsize} is an integer that sets the
upperbound limit on the number of items that can be placed in the
queue. Insertion will block once this size has been reached, until
queue items are consumed. If \var{maxsize} is less than or equal to
zero, the queue size is infinite.
\end{funcdesc}
\setindexsubitem{(qsize method)}
\begin{funcdesc}{qsize}{} \begin{funcdesc}{qsize}{}
Returns the approximate size of the queue. Because of multithreading Returns the approximate size of the queue. Because of multithreading
semantics, this number is not reliable. semantics, this number is not reliable.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(empty method)}
\begin{funcdesc}{empty}{} \begin{funcdesc}{empty}{}
Returns 1 if the queue is empty, 0 otherwise. Because of Returns \code{1} if the queue is empty, \code{0} otherwise. Because
multithreading semantics, this is not reliable. of multithreading semantics, this is not reliable.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(full method)}
\begin{funcdesc}{full}{} \begin{funcdesc}{full}{}
Returns 1 if the queue is full, 0 otherwise. Because of Returns \code{1} if the queue is full, \code{0} otherwise. Because of
multithreading semantics, this is not reliable. multithreading semantics, this is not reliable.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(put method)}
\begin{funcdesc}{put}{item} \begin{funcdesc}{put}{item}
Puts \var{item} into the queue. Puts \var{item} into the queue.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(get method)}
\begin{funcdesc}{get}{} \begin{funcdesc}{get}{}
Gets and returns an item from the queue, blocking if necessary until Gets and returns an item from the queue, blocking if necessary until
one is available. one is available.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(get_nowait method)}
\begin{funcdesc}{get_nowait}{} \begin{funcdesc}{get_nowait}{}
Gets and returns an item from the queue if one is immediately Gets and returns an item from the queue if one is immediately
available. Raises an \code{Empty} exception if the queue is empty or available. Raises an \exception{Empty} exception if the queue is
if the queue's emptiness cannot be determined. empty or if the queue's emptiness cannot be determined.
\end{funcdesc} \end{funcdesc}
\section{Standard Module \sectcode{Queue}} \section{Standard Module \sectcode{Queue}}
\stmodindex{Queue} \stmodindex{Queue}
\label{module-Queue} \label{module-Queue}
% ==== 2. ====
% Give a short overview of what the module does.
% If it is platform specific, mention this.
% Mention other important restrictions or general operating principles.
% For example:
The \code{Queue} module implements a multi-producer, multi-consumer The \module{Queue} module implements a multi-producer, multi-consumer
FIFO queue. It is especially useful in threads programming when FIFO queue. It is especially useful in threads programming when
information must be exchanged safely between multiple threads. The information must be exchanged safely between multiple threads. The
\code{Queue} class in this module implements all the required locking \class{Queue} class in this module implements all the required locking
semantics. It depends on the availability of thread support in semantics. It depends on the availability of thread support in
Python. Python.
The \code{Queue} module defines the following exception: The \module{Queue} module defines the following class and exception:
\setindexsubitem{(in module Queue)}
\begin{classdesc}{Queue}{maxsize}
Constructor for the class. \var{maxsize} is an integer that sets the
upperbound limit on the number of items that can be placed in the
queue. Insertion will block once this size has been reached, until
queue items are consumed. If \var{maxsize} is less than or equal to
zero, the queue size is infinite.
\end{classdesc}
\begin{excdesc}{Empty} \begin{excdesc}{Empty}
Exception raised when non-blocking get (e.g. \code{get_nowait()}) is Exception raised when non-blocking get (e.g. \method{get_nowait()}) is
called on a Queue object which is empty, or for which the emptyiness called on a \class{Queue} object which is empty, or for which the
cannot be determined (i.e. because the appropriate locks cannot be emptyiness cannot be determined (i.e. because the appropriate locks
acquired). cannot be acquired).
\end{excdesc} \end{excdesc}
\subsection{Queue Objects} \subsection{Queue Objects}
\label{QueueObjects}
Class \code{Queue} implements queue objects and has the methods Class \class{Queue} implements queue objects and has the methods
described below. This class can be derived from in order to implement described below. This class can be derived from in order to implement
other queue organizations (e.g. stack) but the inheritable interface other queue organizations (e.g. stack) but the inheritable interface
is not described here. See the source code for details. The public is not described here. See the source code for details. The public
interface methods are: methods are:
\setindexsubitem{(__init__ method)} \setindexsubitem{(Queue method)}
\begin{funcdesc}{__init__}{maxsize}
Constructor for the class. \var{maxsize} is an integer that sets the
upperbound limit on the number of items that can be placed in the
queue. Insertion will block once this size has been reached, until
queue items are consumed. If \var{maxsize} is less than or equal to
zero, the queue size is infinite.
\end{funcdesc}
\setindexsubitem{(qsize method)}
\begin{funcdesc}{qsize}{} \begin{funcdesc}{qsize}{}
Returns the approximate size of the queue. Because of multithreading Returns the approximate size of the queue. Because of multithreading
semantics, this number is not reliable. semantics, this number is not reliable.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(empty method)}
\begin{funcdesc}{empty}{} \begin{funcdesc}{empty}{}
Returns 1 if the queue is empty, 0 otherwise. Because of Returns \code{1} if the queue is empty, \code{0} otherwise. Because
multithreading semantics, this is not reliable. of multithreading semantics, this is not reliable.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(full method)}
\begin{funcdesc}{full}{} \begin{funcdesc}{full}{}
Returns 1 if the queue is full, 0 otherwise. Because of Returns \code{1} if the queue is full, \code{0} otherwise. Because of
multithreading semantics, this is not reliable. multithreading semantics, this is not reliable.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(put method)}
\begin{funcdesc}{put}{item} \begin{funcdesc}{put}{item}
Puts \var{item} into the queue. Puts \var{item} into the queue.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(get method)}
\begin{funcdesc}{get}{} \begin{funcdesc}{get}{}
Gets and returns an item from the queue, blocking if necessary until Gets and returns an item from the queue, blocking if necessary until
one is available. one is available.
\end{funcdesc} \end{funcdesc}
\setindexsubitem{(get_nowait method)}
\begin{funcdesc}{get_nowait}{} \begin{funcdesc}{get_nowait}{}
Gets and returns an item from the queue if one is immediately Gets and returns an item from the queue if one is immediately
available. Raises an \code{Empty} exception if the queue is empty or available. Raises an \exception{Empty} exception if the queue is
if the queue's emptiness cannot be determined. empty or if the queue's emptiness cannot be determined.
\end{funcdesc} \end{funcdesc}
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment