Adjusted to use the new module synopsis support macros.

This commit is contained in:
Fred Drake 1998-07-23 17:59:49 +00:00
parent fe7f3bc2aa
commit b91e934cf1
139 changed files with 627 additions and 706 deletions

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{aifc}}
\label{module-aifc}
\stmodindex{aifc}
\declaremodule{standard}{aifc}
\modulesynopsis{Read and write audio files in AIFF or AIFC format.}
This module provides support for reading and writing AIFF and AIFF-C
files. AIFF is Audio Interchange File Format, a format for storing

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{al}}
\label{module-al}
\bimodindex{al}
\declaremodule{builtin}{al}
\modulesynopsis{Audio functions on the SGI.}
This module provides access to the audio facilities of the SGI Indy
and Indigo workstations. See section 3A of the IRIX man pages for
@ -160,8 +162,10 @@ Get status information on last error.
\section{Standard Module \module{AL}}
\nodename{AL (uppercase)}
\stmodindex{AL}
\declaremodule{standard}{AL}
\modulesynopsis{Constants used with the \module{al} module.}
This module defines symbolic constants needed to use the built-in
module \module{al} (see above); they are equivalent to those defined

View File

@ -7,30 +7,4 @@ such as files and a clock. The interfaces are generally modelled
after the \UNIX{} or \C{} interfaces but they are available on most
other systems as well. Here's an overview:
\begin{description}
\item[os]
--- Miscellaneous OS interfaces.
\item[time]
--- Time access and conversions.
\item[getopt]
--- Parser for command line options.
\item[tempfile]
--- Generate temporary file names.
\item[errno]
--- Standard errno system symbols.
\item[glob]
--- \UNIX{} shell style pathname pattern expansion.
\item[fnmatch]
--- \UNIX{} shell style pathname pattern matching.
\item[locale]
--- Internationalization services.
\end{description}
\localmoduletable

View File

@ -1,8 +1,10 @@
\chapter{Amoeba Specific Services}
\section{Built-in Module \module{amoeba}}
\label{module-amoeba}
\bimodindex{amoeba}
\declaremodule{builtin}{amoeba}
\modulesynopsis{None}
This module provides some object types and operations useful for
Amoeba applications. It is only available on systems that support

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{anydbm}}
\label{module-anydbm}
\stmodindex{anydbm}
\declaremodule{standard}{anydbm}
\modulesynopsis{Generic interface to DBM-style database modules.}
\module{anydbm} is a generic interface to variants of the DBM
database --- \module{dbhash}\refbimodindex{dbhash},
@ -45,8 +47,10 @@ strings.
\section{Standard Module \module{dumbdbm}}
\label{module-dumbdbm}
\stmodindex{dumbdbm}
\declaremodule{standard}{dumbdbm}
\modulesynopsis{None}
A simple and slow database implemented entirely in Python. This
should only be used when no other DBM-style database is available.

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{array}}
\label{module-array}
\bimodindex{array}
\declaremodule{builtin}{array}
\modulesynopsis{Efficient arrays of uniformly typed numeric values.}
\index{arrays}
This module defines a new object type which can efficiently represent

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{audioop}}
\label{module-audioop}
\bimodindex{audioop}
\declaremodule{builtin}{audioop}
\modulesynopsis{Manipulate raw audio data.}
The \module{audioop} module contains some useful operations on sound
fragments. It operates on sound fragments consisting of signed

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{base64}}
\label{module-base64}
\stmodindex{base64}
\declaremodule{standard}{base64}
\modulesynopsis{Encode/decode binary files using the MIME base64 encoding.}
\indexii{base64}{encoding}
\index{MIME!base64 encoding}

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{BaseHTTPServer}}
\label{module-BaseHTTPServer}
\stmodindex{BaseHTTPServer}
\declaremodule{standard}{BaseHTTPServer}
\modulesynopsis{Basic HTTP server (base class for SimpleHTTPServer and CGIHTTPServer).}
\indexii{WWW}{server}
\indexii{HTTP}{protocol}

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{Bastion}}
\label{module-Bastion}
\stmodindex{Bastion}
\declaremodule{standard}{Bastion}
\modulesynopsis{Providing restricted access to objects.}
% I'm concerned that the word 'bastion' won't be understood by people
% for whom English is a second language, making the module name

View File

@ -1,6 +1,9 @@
\section{Built-in Module \module{binascii}}
\label{module-binascii}
\bimodindex{binascii}
\declaremodule{builtin}{binascii}
\modulesynopsis{Tools for converting between binary and various ascii-encoded binary
representation}
The \module{binascii} module contains a number of methods to convert
between binary and various \ASCII{}-encoded binary

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{binhex}}
\label{module-binhex}
\stmodindex{binhex}
\declaremodule{standard}{binhex}
\modulesynopsis{Encode and decode files in binhex4 format.}
This module encodes and decodes files in binhex4 format, a format
allowing representation of Macintosh files in \ASCII{}. On the Macintosh,

View File

@ -3,8 +3,10 @@
% <arw@pythonpros.com>.
\section{Standard Module \module{bisect}}
\stmodindex{bisect}
\label{module-bisect}
\declaremodule{standard}{bisect}
\modulesynopsis{None}
This module provides support for maintaining a list in sorted order

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{__builtin__}}
\label{module-builtin}
\bimodindex{__builtin__}
\declaremodule[builtin]{builtin}{__builtin__}
\modulesynopsis{The set of built-in functions.}
This module provides direct access to all `built-in' identifiers of
Python; e.g. \code{__builtin__.open} is the full name for the built-in

View File

@ -1,8 +1,10 @@
% This section was contributed by Drew Csillag <drew_csillag@geocities.com>.
\section{Standard Module \module{calendar}}
\label{module-calendar}
\stmodindex{calendar}
\declaremodule{standard}{calendar}
\modulesynopsis{None}
This module allows you to output calendars like the \UNIX{}

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{cd}}
\label{module-cd}
\bimodindex{cd}
\declaremodule{builtin}{cd}
\modulesynopsis{Interface to the CD-ROM on Silicon Graphics systems.}
This module provides an interface to the Silicon Graphics CD library.
It is available only on Silicon Graphics systems.

View File

@ -1,6 +1,9 @@
\section{Standard Module \module{cgi}}
\label{module-cgi}
\stmodindex{cgi}
\declaremodule{standard}{cgi}
\modulesynopsis{Common Gateway Interface, used to interpret forms in server-side
scripts.}
\indexii{WWW}{server}
\indexii{CGI}{protocol}
\indexii{HTTP}{protocol}

View File

@ -1,7 +1,9 @@
\section{Built-in Module \module{cmath}}
\label{module-cmath}
\declaremodule{builtin}{cmath}
\modulesynopsis{Mathematical functions for complex numbers.}
\bimodindex{cmath}
This module is always available.
It provides access to mathematical functions for complex numbers.
The functions are:

View File

@ -1,7 +1,10 @@
% Documentation by ESR
\section{Standard Module \module{cmd}}
\stmodindex{cmd}
\label{module-cmd}
\declaremodule{standard}{cmd}
\modulesynopsis{Build line-oriented command interpreters; this is used by module
\module{pdb}.}
The \class{Cmd} class provides a simple framework for writing
line-oriented command interpreters. These are often useful for

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{code}}
\label{module-code}
\stmodindex{code}
\declaremodule{standard}{code}
\modulesynopsis{Code object services.}
The \code{code} module defines operations pertaining to Python code
objects.

View File

@ -1,8 +1,10 @@
% Documentation written by Sue Williams.
\section{Standard Module \module{commands}}
\stmodindex{commands}
\label{module-commands}
\declaremodule{standard}{commands}
\modulesynopsis{Wrapper functions for \function{os.popen()}.}
The \module{commands} module contains wrapper functions for
\function{os.popen()} which take a system command as a string and

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{copy}}
\label{module-copy}
\stmodindex{copy}
\declaremodule{standard}{copy}
\modulesynopsis{Shallow and deep copy operations.}
\setindexsubitem{(copy function)}
\ttindex{copy}
\ttindex{deepcopy}

View File

@ -1,13 +1,13 @@
\section{Standard Module \module{copy_reg}}
% Note that the label is a little off; the underscore causes LaTeX to
% yell & scream.
\label{module-copyreg}
\stmodindex{copy_reg}
\declaremodule[copyreg]{standard}{copy_reg}
The \code{copy_reg} module provides support for the
\code{pickle}\refstmodindex{pickle} and
\code{cPickle}\refbimodindex{cPickle} modules. The
\code{copy}\refstmodindex{copy} module is likely to use this in the
\modulesynopsis{Register \module{pickle} support functions.}
The \module{copy_reg} module provides support for the
\module{pickle}\refstmodindex{pickle} and
\module{cPickle}\refbimodindex{cPickle} modules. The
\module{copy}\refstmodindex{copy} module is likely to use this in the
future as well. It provides configuration information about object
constructors which are not classes. Such constructors may be factory
functions or class instances.

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{crypt}}
\label{module-crypt}
\bimodindex{crypt}
\declaremodule{builtin}{crypt}
\modulesynopsis{The \cfunction{crypt()} function used to check \UNIX{} passwords.}
This module implements an interface to the \manpage{crypt}{3} routine,
which is a one-way hash function based upon a modified DES algorithm;

View File

@ -6,18 +6,7 @@ The modules described in this chapter implement various algorithms of
a cryptographic nature. They are available at the discretion of the
installation. Here's an overview:
\begin{description}
\item[md5]
--- RSA's MD5 message digest algorithm.
\item[mpz]
--- Interface to the GNU MP library for arbitrary precision arithmetic.
\item[rotor]
--- Enigma-like encryption and decryption.
\end{description}
\localmoduletable
Hardcore cypherpunks will probably find the cryptographic modules
written by Andrew Kuchling of further interest; the package adds

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{dbm}}
\label{module-dbm}
\bimodindex{dbm}
\declaremodule{builtin}{dbm}
\modulesynopsis{The standard ``database'' interface, based on ndbm.}
The \code{dbm} module provides an interface to the \UNIX{}
\code{(n)dbm} library. Dbm objects behave like mappings

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{dis}}
\stmodindex{dis}
\label{module-dis}
\declaremodule{standard}{dis}
\modulesynopsis{Disassembler.}
The \module{dis} module supports the analysis of Python byte code by
disassembling it. Since there is no Python assembler, this module

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{errno}}
\label{module-errno}
\stmodindex{errno}
\declaremodule{standard}{errno}
\modulesynopsis{Standard errno system symbols.}
This module makes available standard errno system symbols.

View File

@ -2,6 +2,7 @@
\label{module-exceptions}
\stmodindex{exceptions}
Exceptions can be class objects or string objects. While
traditionally, most exceptions have been string objects, in Python
1.5, all standard exceptions have been converted to class objects,

View File

@ -1,7 +1,9 @@
% Manual text by Jaap Vermeulen
\section{Built-in Module \module{fcntl}}
\label{module-fcntl}
\bimodindex{fcntl}
\declaremodule{builtin}{fcntl}
\modulesynopsis{The \function{fcntl()} and \function{ioctl()} system calls.}
\indexii{UNIX@\UNIX{}}{file control}
\indexii{UNIX@\UNIX{}}{I/O control}

View File

@ -1,8 +1,11 @@
% Documentation heavily adapted from module docstring.
\section{Standard Module \module{fileinput}}
\stmodindex{fileinput}
\label{module-fileinput}
\declaremodule{standard}{fileinput}
\modulesynopsis{Perl-like iteration over lines from multiple input streams, with
``save in place'' capability.}
This module implements a helper class and functions to quickly write a
loop over standard input or a list of files.

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{fl}}
\label{module-fl}
\bimodindex{fl}
\declaremodule{builtin}{fl}
\modulesynopsis{FORMS library interface for GUI applications.}
This module provides an interface to the FORMS Library\index{FORMS
Library} by Mark Overmars\index{Overmars, Mark}. The source for the
@ -463,8 +465,10 @@ FORMS objects have these data attributes; see the FORMS documentation:
\end{tableiii}
\section{Standard Module \module{FL}}
\label{module-FLuppercase}
\stmodindex{FL}
\declaremodule{standard}{FL}
\modulesynopsis{Constants used with the \module{fl} module.}
This module defines symbolic constants needed to use the built-in
module \module{fl} (see above); they are equivalent to those defined in
@ -478,8 +482,10 @@ from FL import *
\end{verbatim}
\section{Standard Module \module{flp}}
\label{module-flp}
\stmodindex{flp}
\declaremodule{standard}{flp}
\modulesynopsis{Loading functions for stored FORMS designs.}
This module defines functions that can read form definitions created
by the `form designer' (\program{fdesign}) program that comes with the

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{fm}}
\label{module-fm}
\bimodindex{fm}
\declaremodule{builtin}{fm}
\modulesynopsis{\emph{Font Manager} interface for SGI workstations.}
This module provides access to the IRIS \emph{Font Manager} library.
\index{Font Manager, IRIS}

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{fnmatch}}
\label{module-fnmatch}
\stmodindex{fnmatch}
\declaremodule{standard}{fnmatch}
\modulesynopsis{\UNIX{} shell style pathname pattern matching.}
This module provides support for \UNIX{} shell-style wildcards, which
are \emph{not} the same as regular expressions (which are documented

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{formatter}}
\label{module-formatter}
\stmodindex{formatter}
\declaremodule{standard}{formatter}
\modulesynopsis{Generic output formatter and device interface.}
This module supports two interface definitions, each with mulitple

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{ftplib}}
\label{module-ftplib}
\stmodindex{ftplib}
\declaremodule{standard}{ftplib}
\modulesynopsis{FTP protocol client (requires sockets).}
\indexii{FTP}{protocol}

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{gdbm}}
\label{module-gdbm}
\bimodindex{gdbm}
\declaremodule{builtin}{gdbm}
\modulesynopsis{GNU's reinterpretation of dbm.}
% Note that if this section appears on the same page as the first
% paragraph of the dbm module section, makeindex will produce the

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{getopt}}
\label{module-getopt}
\stmodindex{getopt}
\declaremodule{standard}{getopt}
\modulesynopsis{Parser for command line options.}
This module helps scripts to parse the command line arguments in
\code{sys.argv}.

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{gl}}
\label{module-gl}
\bimodindex{gl}
\declaremodule{builtin}{gl}
\modulesynopsis{Functions from the Silicon Graphics \emph{Graphics Library}.}
This module provides access to the Silicon Graphics
\emph{Graphics Library}.
@ -183,15 +185,22 @@ def main():
main()
\end{verbatim}
%
\section{Standard Modules \module{GL} and \module{DEVICE}}
\nodename{GL and DEVICE}
\stmodindex{GL}
\stmodindex{DEVICE}
\section{Standard Module \module{DEVICE}}
\declaremodule{standard}{DEVICE}
These modules define the constants used by the Silicon Graphics
\emph{Graphics Library}
that C programmers find in the header files
\file{<gl/gl.h>}
and
\file{<gl/device.h>}.
Read the module source files for details.
\modulesynopsis{Constants used with the \module{gl} module.}
This modules defines the constants used by the Silicon Graphics
\emph{Graphics Library} that C programmers find in the header file
\code{<gl/device.h>}.
Read the module source file for details.
\section{Standard Module \module{GL}}
\declaremodule{standard}{GL}
\modulesynopsis{Constants used with the \module{gl} module.}
This module contains constants used by the Silicon Graphics
\emph{Graphics Library} from the C header file \code{<gl/gl.h>}.
Read the module source file for details.

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{glob}}
\label{module-glob}
\stmodindex{glob}
\declaremodule{standard}{glob}
\modulesynopsis{\UNIX{} shell style pathname pattern expansion.}
The \module{glob} module finds all the pathnames matching a specified
pattern according to the rules used by the \UNIX{} shell. No tilde

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{gopherlib}}
\label{module-gopherlib}
\stmodindex{gopherlib}
\declaremodule{standard}{gopherlib}
\modulesynopsis{Gopher protocol client (requires sockets).}
\indexii{Gopher}{protocol}

View File

@ -1,7 +1,9 @@
\section{Built-in Module \module{grp}}
\label{module-grp}
\declaremodule{builtin}{grp}
\modulesynopsis{The group database (\function{getgrnam()} and friends).}
\bimodindex{grp}
This module provides access to the \UNIX{} group database.
It is available on all \UNIX{} versions.

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{gzip}}
\label{module-gzip}
\stmodindex{gzip}
\declaremodule{standard}{gzip}
\modulesynopsis{None}
The data compression provided by the \code{zlib} module is compatible
with that used by the GNU compression program \program{gzip}.

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{htmllib}}
\label{module-htmllib}
\stmodindex{htmllib}
\declaremodule{standard}{htmllib}
\modulesynopsis{A parser for HTML documents.}
\index{HTML}
\index{hypertext}

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{httplib}}
\label{module-httplib}
\stmodindex{httplib}
\declaremodule{standard}{httplib}
\modulesynopsis{HTTP protocol client (requires sockets).}
\indexii{HTTP}{protocol}

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{imageop}}
\label{module-imageop}
\bimodindex{imageop}
\declaremodule{builtin}{imageop}
\modulesynopsis{Manipulate raw image data.}
The \module{imageop} module contains some useful operations on images.
It operates on images consisting of 8 or 32 bit pixels stored in

View File

@ -4,8 +4,10 @@
% The imaplib module was written by Piers Lauder.
\section{Standard Module \module{imaplib}}
\stmodindex{imaplib}
\label{module-imaplib}
\declaremodule{standard}{imaplib}
\modulesynopsis{IMAP4 protocol client (requires sockets).}
\indexii{IMAP4}{protocol}
This module defines a class, \class{IMAP4}, which encapsulates a

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{imgfile}}
\label{module-imgfile}
\bimodindex{imgfile}
\declaremodule{builtin}{imgfile}
\modulesynopsis{Support for SGI imglib files.}
The \module{imgfile} module allows Python programs to access SGI imglib image
files (also known as \file{.rgb} files). The module is far from

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{imghdr}}
\label{module-imghdr}
\stmodindex{imghdr}
\declaremodule{standard}{imghdr}
\modulesynopsis{Determine the type of image contained in a file or byte stream.}
The \module{imghdr} module determines the type of image contained in a
file or byte stream.

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{imp}}
\label{module-imp}
\bimodindex{imp}
\declaremodule{builtin}{imp}
\modulesynopsis{Access the implementation of the \keyword{import} statement.}
\index{import}
This module provides an interface to the mechanisms used to implement

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{jpeg}}
\label{module-jpeg}
\bimodindex{jpeg}
\declaremodule{builtin}{jpeg}
\modulesynopsis{Read and write image files in compressed JPEG format.}
The module \module{jpeg} provides access to the jpeg compressor and
decompressor written by the Independent JPEG Group%

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{keyword}}
\label{module-keyword}
\stmodindex{keyword}
\declaremodule{standard}{keyword}
\modulesynopsis{Test whether a string is a keyword in the Python language.}
This module allows a Python program to determine if a string is a
keyword. A single function is provided:

View File

@ -1,7 +1,9 @@
\section{Standard Module \module{locale}}
\stmodindex{locale}
\declaremodule{standard}{locale}
\modulesynopsis{Internationalization services.}
\label{module-locale}
The \code{locale} module opens access to the \POSIX{} locale database
and functionality. The \POSIX{} locale mechanism allows applications

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{mailbox}}
\label{module-mailbox}
\stmodindex{mailbox}
\declaremodule{standard}{mailbox}
\modulesynopsis{Read various mailbox formats.}
This module defines a number of classes that allow easy and uniform

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{mailcap}}
\label{module-mailcap}
\stmodindex{mailcap}
\declaremodule{standard}{mailcap}
\modulesynopsis{Mailcap file handling.}
Mailcap files are used to configure how MIME-aware applications such
as mail readers and Web browsers react to files with different MIME

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{__main__}}
\label{module-main}
\bimodindex{__main__}
\declaremodule[main]{builtin}{__main__}
\modulesynopsis{The environment where the top-level script is run.}
This module represents the (otherwise anonymous) scope in which the
interpreter's main program executes --- commands read either from
standard input or from a script file.

View File

@ -1,6 +1,9 @@
\section{Built-in Module \module{marshal}}
\label{module-marshal}
\bimodindex{marshal}
\declaremodule{builtin}{marshal}
\modulesynopsis{Convert Python objects to streams of bytes and back (with
different constraints).}
This module contains functions that can read and write Python
values in a binary format. The format is specific to Python, but

View File

@ -1,7 +1,9 @@
\section{Built-in Module \module{math}}
\label{module-math}
\declaremodule{builtin}{math}
\modulesynopsis{Mathematical functions (\function{sin()} etc.).}
\bimodindex{math}
This module is always available.
It provides access to the mathematical functions defined by the \C{}
standard.

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{md5}}
\label{module-md5}
\bimodindex{md5}
\declaremodule{builtin}{md5}
\modulesynopsis{RSA's MD5 message digest algorithm.}
This module implements the interface to RSA's MD5 message digest
\index{message digest, MD5}

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{mimetools}}
\label{module-mimetools}
\stmodindex{mimetools}
\declaremodule{standard}{mimetools}
\modulesynopsis{Tools for parsing MIME style message bodies.}
This module defines a subclass of the \class{rfc822.Message} class and

View File

@ -3,8 +3,10 @@
% mimetypes module.
\section{Standard Module \module{mimetypes}}
\label{module-mimetypes}
\stmodindex{mimetypes}
\declaremodule{standard}{mimetypes}
\modulesynopsis{Mapping of filename extensions to MIME types.}
\indexii{MIME}{content type}
The \module{mimetypes} converts between a filename or URL and the MIME

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{mimify}}
\label{module-mimify}
\stmodindex{mimify}
\declaremodule{standard}{mimify}
\modulesynopsis{Mimification and unmimification of mail messages.}
The mimify module defines two functions to convert mail messages to
and from MIME format. The mail message can be either a simple message

View File

@ -4,29 +4,4 @@
The modules described in this chapter provide miscellaneous services
that are available in all Python versions. Here's an overview:
\begin{description}
\item[math]
--- Mathematical functions (\function{sin()} etc.).
\item[cmath]
--- Mathematical functions for complex numbers.
\item[whrandom]
--- Floating point pseudo-random number generator.
\item[random]
--- Generate pseudo-random numbers with various common distributions.
\item[array]
--- Efficient arrays of uniformly typed numeric values.
\item[fileinput]
--- Perl-like iteration over lines from multiple input streams, with
``save in place'' capability.
\item[cmd]
--- Build line-oriented command interpreters; this is used by module
\module{pdb}.
\end{description}
\localmoduletable

View File

@ -5,25 +5,4 @@ The modules described in this chapter implement various algorithms or
interfaces that are mainly useful for multimedia applications. They
are available at the discretion of the installation. Here's an overview:
\begin{description}
\item[audioop]
--- Manipulate raw audio data.
\item[imageop]
--- Manipulate raw image data.
\item[aifc]
--- Read and write audio files in AIFF or AIFC format.
\item[jpeg]
--- Read and write image files in compressed JPEG format.
\item[rgbimg]
--- Read and write image files in ``SGI RGB'' format (the module is
\emph{not} SGI specific though)!
\item[imghdr]
--- Determine the type of image contained in a file or byte stream.
\end{description}
\localmoduletable

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{mpz}}
\label{module-mpz}
\bimodindex{mpz}
\declaremodule{builtin}{mpz}
\modulesynopsis{Interface to the GNU MP library for arbitrary precision arithmetic.}
This is an optional module. It is only available when Python is
configured to include it, which requires that the GNU MP software is

View File

@ -1,7 +1,9 @@
% Documentation by ESR
\section{Standard Module \module{multifile}}
\stmodindex{multiFile}
\label{module-multifile}
\declaremodule[multifile]{standard}{multiFile}
\modulesynopsis{None}
The \class{MultiFile} object enables you to treat sections of a text
file as file-like input objects, with \code{''} being returned by

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{ni}}
\label{module-ni}
\stmodindex{ni}
\declaremodule{standard}{ni}
\modulesynopsis{None}
\strong{Warning: This module is obsolete.} As of Python 1.5a4,
package support (with different semantics for \code{__init__} and no

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{nntplib}}
\label{module-nntplib}
\stmodindex{nntplib}
\declaremodule{standard}{nntplib}
\modulesynopsis{NNTP protocol client (requires sockets).}
\indexii{NNTP}{protocol}
\index{Network News Transfer Protocol}

View File

@ -1,8 +1,10 @@
% Contributed by Skip Montanaro, from the module's doc strings.
\section{Built-in Module \module{operator}}
\label{module-operator}
\bimodindex{operator}
\declaremodule{builtin}{operator}
\modulesynopsis{All Python's standard operators as built-in functions.}
The \module{operator} module exports a set of functions implemented in C
corresponding to the intrinsic operators of Python. For example,

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{os}}
\label{module-os}
\stmodindex{os}
\declaremodule{standard}{os}
\modulesynopsis{Miscellaneous OS interfaces.}
This module provides a more portable way of using operating system
(OS) dependent functionality than importing an OS dependent built-in

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{panel}}
\label{module-panel}
\stmodindex{panel}
\declaremodule{standard}{panel}
\modulesynopsis{None}
\strong{Please note:} The FORMS library, to which the
\code{fl}\refbimodindex{fl} module described above interfaces, is a
@ -30,8 +32,10 @@ or
\code{panel.defpanellist()}.
\section{Standard Module \module{panelparser}}
\label{module-panelparser}
\stmodindex{panelparser}
\declaremodule{standard}{panelparser}
\modulesynopsis{None}
This module defines a self-contained parser for S-expressions as output
by the Panel Editor (which is written in Scheme so it can't help writing
@ -46,8 +50,10 @@ For more details, read the module file.
% XXXXJH should be funcdesc, I think
\section{Built-in Module \module{pnl}}
\label{module-pnl}
\bimodindex{pnl}
\declaremodule{builtin}{pnl}
\modulesynopsis{None}
This module provides access to the
\emph{Panel Library}

View File

@ -10,8 +10,11 @@
%
\section{Built-in Module \module{parser}}
\label{module-parser}
\bimodindex{parser}
\declaremodule{builtin}{parser}
\modulesynopsis{Retrieve and submit parse trees from and to the runtime support
environment.}
\index{parsing!Python source code}
The \module{parser} module provides an interface to Python's internal

View File

@ -1,6 +1,8 @@
\chapter{The Python Debugger}
\label{module-pdb}
\stmodindex{pdb}
\declaremodule{standard}{pdb}
\modulesynopsis{None}
\index{debugging}

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{pickle}}
\label{module-pickle}
\stmodindex{pickle}
\declaremodule{standard}{pickle}
\modulesynopsis{Convert Python objects to streams of bytes and back.}
\index{persistency}
\indexii{persistent}{objects}
\indexii{serializing}{objects}
@ -273,8 +275,10 @@ registration}
\section{Built-in Module \module{cPickle}}
\bimodindex{cPickle}
\label{module-cPickle}
\declaremodule{builtin}{cPickle}
\modulesynopsis{Faster version of \module{pickle}, but not subclassable.}
% This section was written by Fred L. Drake, Jr. <fdrake@acm.org>

View File

@ -3,8 +3,10 @@
% Drake, Jr. <fdrake@acm.org>.
\section{Standard Module \module{popen2}}
\label{module-popen2}
\stmodindex{popen2}
\declaremodule{standard}{popen2}
\modulesynopsis{None}
This module allows you to spawn processes and connect their
input/output/error pipes and obtain their return codes.

View File

@ -4,8 +4,10 @@
%the imaplib ``chapter''.
\section{Standard Module \module{poplib}}
\stmodindex{poplib}
\label{module-poplib}
\declaremodule{standard}{poplib}
\modulesynopsis{POP3 protocol client (requires sockets).}
\indexii{POP3}{protocol}
This module defines a class, \class{POP3}, which encapsulates a

View File

@ -1,6 +1,9 @@
\section{Built-in Module \module{posix}}
\label{module-posix}
\bimodindex{posix}
\declaremodule{builtin}{posix}
\modulesynopsis{The most common \POSIX{} system calls (normally used via module
\module{os}).}
This module provides access to operating system functionality that is
standardized by the \C{} Standard and the \POSIX{} standard (a thinly

View File

@ -1,7 +1,9 @@
% Manual text and implementation by Jaap Vermeulen
\section{Standard Module \module{posixfile}}
\label{module-posixfile}
\bimodindex{posixfile}
\declaremodule{builtin}{posixfile}
\modulesynopsis{A file-like object with support for locking.}
\indexii{\POSIX{}}{file object}
\emph{Note:} This module will become obsolete in a future release.

View File

@ -1,6 +1,7 @@
\section{Standard Module \module{posixpath}}
\label{module-posixpath}
\stmodindex{posixpath}
\declaremodule{standard}{posixpath}
\modulesynopsis{Common \POSIX{} pathname manipulations.}
This module implements some useful functions on \POSIX{} pathnames.

View File

@ -1,8 +1,10 @@
%% Author: Fred L. Drake, Jr. <fdrake@acm.org>
\section{Standard Module \module{pprint}}
\stmodindex{pprint}
\label{module-pprint}
\declaremodule{standard}{pprint}
\modulesynopsis{Data pretty printer.}
The \module{pprint} module provides a capability to ``pretty-print''
arbitrary Python data structures in a form which can be used as input

View File

@ -255,8 +255,10 @@ of algorithms to be directly compared to iterative implementations.
\section{Reference Manual}
\stmodindex{profile}
\label{module-profile}
\declaremodule{standard}{profile}
\modulesynopsis{None}
The primary entry point for the profiler is the global function

View File

@ -1,7 +1,9 @@
\section{Built-in Module \module{pwd}}
\label{module-pwd}
\declaremodule{builtin}{pwd}
\modulesynopsis{The password database (\function{getpwnam()} and friends).}
\bimodindex{pwd}
This module provides access to the \UNIX{} password database.
It is available on all \UNIX{} versions.

View File

@ -5,80 +5,4 @@ The modules described in this chapter provide a wide range of services
related to the Python interpreter and its interaction with its
environment. Here's an overview:
\begin{description}
\item[sys]
--- Access system specific parameters and functions.
\item[types]
--- Names for all built-in types.
\item[UserDict]
--- Class wrapper for dictionary objects.
\item[UserList]
--- Class wrapper for list objects.
\item[operator]
--- All Python's standard operators as built-in functions.
\item[traceback]
--- Print or retrieve a stack traceback.
\item[pickle]
--- Convert Python objects to streams of bytes and back.
\item[cPickle]
--- Faster version of \module{pickle}, but not subclassable.
\item[copy_reg]
--- Register \module{pickle} support functions.
\item[shelve]
--- Python object persistency.
\item[copy]
--- Shallow and deep copy operations.
\item[marshal]
--- Convert Python objects to streams of bytes and back (with
different constraints).
\item[imp]
--- Access the implementation of the \keyword{import} statement.
\item[parser]
--- Retrieve and submit parse trees from and to the runtime support
environment.
\item[symbol]
--- Constants representing internal nodes of the parse tree.
\item[token]
--- Constants representing terminal nodes of the parse tree.
\item[keyword]
--- Test whether a string is a keyword in the Python language.
\item[code]
--- Code object services.
\item[pprint]
--- Data pretty printer.
\item[dis]
--- Disassembler.
\item[site]
--- A standard way to reference site-specific modules.
\item[user]
--- A standard way to reference user-specific modules.
\item[__builtin__]
--- The set of built-in functions.
\item[__main__]
--- The environment where the top-level script is run.
\end{description}
\localmoduletable

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{Queue}}
\stmodindex{Queue}
\label{module-Queue}
\declaremodule{standard}{Queue}
\modulesynopsis{A stynchronized queue class.}
The \module{Queue} module implements a multi-producer, multi-consumer

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{quopri}}
\label{module-quopri}
\stmodindex{quopri}
\declaremodule{standard}{quopri}
\modulesynopsis{Encode/decode binary files using the MIME quoted-printable encoding.}
This module performs quoted-printable transport encoding and decoding,
as defined in \rfc{1521}: ``MIME (Multipurpose Internet Mail Extensions)

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{rand}}
\label{module-rand}
\stmodindex{rand}
\declaremodule{standard}{rand}
\modulesynopsis{None}
The \code{rand} module simulates the C library's \code{rand()}
interface, though the results aren't necessarily compatible with any

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{random}}
\label{module-random}
\stmodindex{random}
\declaremodule{standard}{random}
\modulesynopsis{Generate pseudo-random numbers with various common distributions.}
This module implements pseudo-random number generators for various
distributions: on the real line, there are functions to compute normal

View File

@ -1,7 +1,9 @@
\section{Built-in Module \module{re}}
\label{module-re}
\declaremodule{builtin}{re}
\modulesynopsis{New Perl-style regular expression search and match operations.}
\bimodindex{re}
This module provides regular expression matching operations similar to
those found in Perl. It's 8-bit clean: the strings being processed

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{regex}}
\label{module-regex}
\bimodindex{regex}
\declaremodule{builtin}{regex}
\modulesynopsis{Regular expression search and match operations.}
This module provides regular expression matching operations similar to
those found in Emacs.

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{regsub}}
\label{module-regsub}
\stmodindex{regsub}
\declaremodule{standard}{regsub}
\modulesynopsis{Substitution and splitting operations that use regular expressions.}
This module defines a number of functions useful for working with
regular expressions (see built-in module \code{regex}).

View File

@ -1,7 +1,10 @@
\section{Built-in Module \module{resource}}
\label{module-resource}
\declaremodule{builtin}{resource}
\modulesynopsis{An interface to provide resource usage information on the current
process.}
\bimodindex{resource}
This module provides basic mechanisms for measuring and controlling
system resources utilized by a program.

View File

@ -63,15 +63,7 @@ class and instance object attribute \code{__dict__} are unavailable.
Two modules provide the framework for setting up restricted execution
environments:
\begin{description}
\item[rexec]
--- Basic restricted execution framework.
\item[Bastion]
--- Providing restricted access to objects.
\end{description}
\localmoduletable
\begin{seealso}
\seetext{Andrew Kuchling, ``Restricted Execution HOWTO.'' Available

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{rexec}}
\label{module-rexec}
\stmodindex{rexec}
\declaremodule{standard}{rexec}
\modulesynopsis{Basic restricted execution framework.}
This module contains the \class{RExec} class, which supports

View File

@ -1,7 +1,9 @@
\section{Standard Module \module{rfc822}}
\label{module-rfc822}
\stmodindex{rfc822}
\declaremodule{standard}{rfc822}
\modulesynopsis{Parse \rfc{822} style mail headers.}
%\index{RFC!RFC 822}
This module defines a class, \class{Message}, which represents a
collection of ``email headers'' as defined by the Internet standard

View File

@ -1,6 +1,9 @@
\section{Built-in Module \module{rgbimg}}
\label{module-rgbimg}
\bimodindex{rgbimg}
\declaremodule{builtin}{rgbimg}
\modulesynopsis{Read and write image files in ``SGI RGB'' format (the module is
\emph{not} SGI specific though)!}
The \module{rgbimg} module allows Python programs to access SGI imglib image
files (also known as \file{.rgb} files). The module is far from

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{rotor}}
\label{module-rotor}
\bimodindex{rotor}
\declaremodule{builtin}{rotor}
\modulesynopsis{Enigma-like encryption and decryption.}
This module implements a rotor-based encryption algorithm, contributed by
Lance Ellinghouse\index{Ellinghouse, Lance}. The design is derived

View File

@ -1,6 +1,8 @@
\section{Built-in Module \module{select}}
\label{module-select}
\bimodindex{select}
\declaremodule{builtin}{select}
\modulesynopsis{Wait for I/O completion on multiple streams.}
This module provides access to the function \cfunction{select()}
available in most \UNIX{} versions. It defines the following:

View File

@ -3,3 +3,5 @@
The modules described in this chapter provide interfaces to features
that are unique to SGI's IRIX operating system (versions 4 and 5).
\localmoduletable

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{sgmllib}}
\label{module-sgmllib}
\stmodindex{sgmllib}
\declaremodule{standard}{sgmllib}
\modulesynopsis{Only as much of an SGML parser as needed to parse HTML.}
\index{SGML}
This module defines a class \class{SGMLParser} which serves as the

View File

@ -1,6 +1,8 @@
\section{Standard Module \module{shelve}}
\label{module-shelve}
\stmodindex{shelve}
\declaremodule{standard}{shelve}
\modulesynopsis{Python object persistency.}
A ``shelf'' is a persistent, dictionary-like object. The difference
with ``dbm'' databases is that the values (not the keys!) in a shelf

Some files were not shown because too many files have changed in this diff Show More