Commit d85d0d7b authored by Fred Drake's avatar Fred Drake

Fixed a large number of small problems, mostly noted by Detlef Lannert

<lannert@lannert.rz.uni-duesseldorf.de>.
parent 3d4545c3
...@@ -2,8 +2,7 @@ ...@@ -2,8 +2,7 @@
Disassembler for Python byte code} Disassembler for Python byte code}
\declaremodule{standard}{dis} \declaremodule{standard}{dis}
\modulesynopsis{Disassembler for Python byte code, as stored in code \modulesynopsis{Disassembler for Python byte code.}
objects and \file{.pyc}/\file{.pyo} files.}
The \module{dis} module supports the analysis of Python byte code by The \module{dis} module supports the analysis of Python byte code by
...@@ -35,7 +34,7 @@ the following command can be used to get the disassembly of ...@@ -35,7 +34,7 @@ the following command can be used to get the disassembly of
19 RETURN_VALUE 19 RETURN_VALUE
\end{verbatim} \end{verbatim}
The \module{dis} module defines the following functions: The \module{dis} module defines the following functions and constants:
\begin{funcdesc}{dis}{\optional{bytesource}} \begin{funcdesc}{dis}{\optional{bytesource}}
Disassemble the \var{bytesource} object. \var{bytesource} can denote Disassemble the \var{bytesource} object. \var{bytesource} can denote
...@@ -75,7 +74,7 @@ for compatibility with earlier Python releases. ...@@ -75,7 +74,7 @@ for compatibility with earlier Python releases.
\end{funcdesc} \end{funcdesc}
\begin{datadesc}{opname} \begin{datadesc}{opname}
Sequence of a operation names, indexable using the byte code. Sequence of operation names, indexable using the byte code.
\end{datadesc} \end{datadesc}
\begin{datadesc}{cmp_op} \begin{datadesc}{cmp_op}
...@@ -87,7 +86,7 @@ Sequence of byte codes that have a constant parameter. ...@@ -87,7 +86,7 @@ Sequence of byte codes that have a constant parameter.
\end{datadesc} \end{datadesc}
\begin{datadesc}{hasname} \begin{datadesc}{hasname}
Sequence of byte codes that access a attribute by name. Sequence of byte codes that access an attribute by name.
\end{datadesc} \end{datadesc}
\begin{datadesc}{hasjrel} \begin{datadesc}{hasjrel}
...@@ -99,7 +98,7 @@ Sequence of byte codes that have an absolute jump target. ...@@ -99,7 +98,7 @@ Sequence of byte codes that have an absolute jump target.
\end{datadesc} \end{datadesc}
\begin{datadesc}{haslocal} \begin{datadesc}{haslocal}
Sequence of byte codes that access a a local variable. Sequence of byte codes that access a local variable.
\end{datadesc} \end{datadesc}
\begin{datadesc}{hascompare} \begin{datadesc}{hascompare}
...@@ -196,11 +195,11 @@ Implements \code{TOS = TOS1[TOS]}. ...@@ -196,11 +195,11 @@ Implements \code{TOS = TOS1[TOS]}.
\end{opcodedesc} \end{opcodedesc}
\begin{opcodedesc}{BINARY_LSHIFT}{} \begin{opcodedesc}{BINARY_LSHIFT}{}
Implements \code{TOS = TOS1 << TOS}. Implements \code{TOS = TOS1 <\code{}< TOS}.
\end{opcodedesc} \end{opcodedesc}
\begin{opcodedesc}{BINARY_RSHIFT}{} \begin{opcodedesc}{BINARY_RSHIFT}{}
Implements \code{TOS = TOS1 >> TOS}. Implements \code{TOS = TOS1 >\code{}> TOS}.
\end{opcodedesc} \end{opcodedesc}
\begin{opcodedesc}{BINARY_AND}{} \begin{opcodedesc}{BINARY_AND}{}
...@@ -245,11 +244,11 @@ Implements in-place \code{TOS = TOS1 - TOS}. ...@@ -245,11 +244,11 @@ Implements in-place \code{TOS = TOS1 - TOS}.
\end{opcodedesc} \end{opcodedesc}
\begin{opcodedesc}{INPLACE_LSHIFT}{} \begin{opcodedesc}{INPLACE_LSHIFT}{}
Implements in-place \code{TOS = TOS1 << TOS}. Implements in-place \code{TOS = TOS1 <\code{}< TOS}.
\end{opcodedesc} \end{opcodedesc}
\begin{opcodedesc}{INPLACE_RSHIFT}{} \begin{opcodedesc}{INPLACE_RSHIFT}{}
Implements in-place \code{TOS = TOS1 >> TOS}. Implements in-place \code{TOS = TOS1 >\code{}> TOS}.
\end{opcodedesc} \end{opcodedesc}
\begin{opcodedesc}{INPLACE_AND}{} \begin{opcodedesc}{INPLACE_AND}{}
......
...@@ -70,14 +70,14 @@ Load a module that was previously found by \function{find_module()} (or by ...@@ -70,14 +70,14 @@ Load a module that was previously found by \function{find_module()} (or by
an otherwise conducted search yielding compatible results). This an otherwise conducted search yielding compatible results). This
function does more than importing the module: if the module was function does more than importing the module: if the module was
already imported, it is equivalent to a already imported, it is equivalent to a
\function{reload()}\bifuncindex{reload}! The \function{reload()}\bifuncindex{reload}! The \var{name} argument
\var{name} argument indicates the full module name (including the indicates the full module name (including the package name, if this is
package name, if this is a submodule of a package). The \var{file} a submodule of a package). The \var{file} argument is an open file,
argument is an open file, and \var{filename} is the corresponding and \var{filename} is the corresponding file name; these can be
file name; these can be \code{None} and \code{''}, respectively, when \code{None} and \code{''}, respectively, when the module is not being
the module is not being loaded from a file. The \var{description} loaded from a file. The \var{description} argument is a tuple, as
argument is a tuple as returned by \function{find_module()} describing would be returned by \function{get_suffixes()}, describing what kind
what kind of module must be loaded. of module must be loaded.
If the load is successful, the return value is the module object; If the load is successful, the return value is the module object;
otherwise, an exception (usually \exception{ImportError}) is raised. otherwise, an exception (usually \exception{ImportError}) is raised.
......
...@@ -49,5 +49,6 @@ object (see the \refmodule{rfc822} module). Depending on the mailbox ...@@ -49,5 +49,6 @@ object (see the \refmodule{rfc822} module). Depending on the mailbox
implementation the \var{fp} attribute of this object may be a true implementation the \var{fp} attribute of this object may be a true
file object or a class instance simulating a file object, taking care file object or a class instance simulating a file object, taking care
of things like message boundaries if multiple mail messages are of things like message boundaries if multiple mail messages are
contained in a single file, etc. contained in a single file, etc. If no more messages are available,
this method returns \code{None}.
\end{methoddesc} \end{methoddesc}
...@@ -61,15 +61,15 @@ open file \var{output}. The block size is currently fixed at 8192. ...@@ -61,15 +61,15 @@ open file \var{output}. The block size is currently fixed at 8192.
\end{seealso} \end{seealso}
\subsection{Additional Methods of Message objects} \subsection{Additional Methods of Message Objects
\nodename{mimetools.Message Methods} \label{mimetools-message-objects}}
The \class{Message} class defines the following methods in The \class{Message} class defines the following methods in
addition to the \class{rfc822.Message} methods: addition to the \class{rfc822.Message} methods:
\begin{methoddesc}{getplist}{} \begin{methoddesc}{getplist}{}
Return the parameter list of the \code{content-type} header. This is Return the parameter list of the \code{content-type} header. This is
a list if strings. For parameters of the form a list of strings. For parameters of the form
\samp{\var{key}=\var{value}}, \var{key} is converted to lower case but \samp{\var{key}=\var{value}}, \var{key} is converted to lower case but
\var{value} is not. For example, if the message contains the header \var{value} is not. For example, if the message contains the header
\samp{Content-type: text/html; spam=1; Spam=2; Spam} then \samp{Content-type: text/html; spam=1; Spam=2; Spam} then
......
...@@ -27,12 +27,12 @@ callable, and \var{instance} must be an instance object or ...@@ -27,12 +27,12 @@ callable, and \var{instance} must be an instance object or
\code{None}. \code{None}.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{function}{code, globals\optional{, name\optional{argdefs}}} \begin{funcdesc}{function}{code, globals\optional{, name\optional{, argdefs}}}
Returns a (Python) function with the given code and globals. If Returns a (Python) function with the given code and globals. If
\var{name} is given, it must be a string or \code{None}. If it is a \var{name} is given, it must be a string or \code{None}. If it is a
string, the function will have the given name, otherwise the function string, the function will have the given name, otherwise the function
name will be taken from \code{\var{code}.co_name}. If name will be taken from \code{\var{code}.co_name}. If
\var{argdefs} is given, it must be a tuple and will be used to the \var{argdefs} is given, it must be a tuple and will be used to
determine the default values of parameters. determine the default values of parameters.
\end{funcdesc} \end{funcdesc}
......
...@@ -180,7 +180,7 @@ parentheses, and indicates the start and end of a group; the contents ...@@ -180,7 +180,7 @@ parentheses, and indicates the start and end of a group; the contents
of a group can be retrieved after a match has been performed, and can of a group can be retrieved after a match has been performed, and can
be matched later in the string with the \regexp{\e \var{number}} special be matched later in the string with the \regexp{\e \var{number}} special
sequence, described below. To match the literals \character{(} or sequence, described below. To match the literals \character{(} or
\character{')}, use \regexp{\e(} or \regexp{\e)}, or enclose them \character{)}, use \regexp{\e(} or \regexp{\e)}, or enclose them
inside a character class: \regexp{[(] [)]}. inside a character class: \regexp{[(] [)]}.
\item[\code{(?...)}] This is an extension notation (a \character{?} \item[\code{(?...)}] This is an extension notation (a \character{?}
......
...@@ -22,7 +22,7 @@ the tail part, it uses the empty string (on Macintosh or Windows) or ...@@ -22,7 +22,7 @@ the tail part, it uses the empty string (on Macintosh or Windows) or
it uses first \file{lib/python\shortversion/site-packages} and then it uses first \file{lib/python\shortversion/site-packages} and then
\file{lib/site-python} (on \UNIX{}). For each of the distinct \file{lib/site-python} (on \UNIX{}). For each of the distinct
head-tail combinations, it sees if it refers to an existing directory, head-tail combinations, it sees if it refers to an existing directory,
and if so, adds to \code{sys.path}, and also inspected for path and if so, adds to \code{sys.path}, and also inspects the path for
configuration files. configuration files.
\indexii{site-python}{directory} \indexii{site-python}{directory}
\indexii{site-packages}{directory} \indexii{site-packages}{directory}
......
...@@ -13,7 +13,7 @@ can add new behaviors to dictionaries. ...@@ -13,7 +13,7 @@ can add new behaviors to dictionaries.
The \module{UserDict} module defines the \class{UserDict} class: The \module{UserDict} module defines the \class{UserDict} class:
\begin{classdesc}{UserDict}{\optional{initialdata}} \begin{classdesc}{UserDict}{\optional{initialdata}}
Return a class instance that simulates a dictionary. The instance's Class that simulates a dictionary. The instance's
contents are kept in a regular dictionary, which is accessible via the contents are kept in a regular dictionary, which is accessible via the
\member{data} attribute of \class{UserDict} instances. If \member{data} attribute of \class{UserDict} instances. If
\var{initialdata} is provided, \member{data} is initialized with its \var{initialdata} is provided, \member{data} is initialized with its
...@@ -47,7 +47,7 @@ can add new behaviors to lists. ...@@ -47,7 +47,7 @@ can add new behaviors to lists.
The \module{UserList} module defines the \class{UserList} class: The \module{UserList} module defines the \class{UserList} class:
\begin{classdesc}{UserList}{\optional{list}} \begin{classdesc}{UserList}{\optional{list}}
Return a class instance that simulates a list. The instance's Class that simulates a list. The instance's
contents are kept in a regular list, which is accessible via the contents are kept in a regular list, which is accessible via the
\member{data} attribute of \class{UserList} instances. The instance's \member{data} attribute of \class{UserList} instances. The instance's
contents are initially set to a copy of \var{list}, defaulting to the contents are initially set to a copy of \var{list}, defaulting to the
...@@ -104,7 +104,7 @@ to real string or Unicode objects; this is especially the case for ...@@ -104,7 +104,7 @@ to real string or Unicode objects; this is especially the case for
The \module{UserString} module defines the following classes: The \module{UserString} module defines the following classes:
\begin{classdesc}{UserString}{\optional{sequence}} \begin{classdesc}{UserString}{\optional{sequence}}
Return a class instance that simulates a string or a Unicode string Class that simulates a string or a Unicode string
object. The instance's content is kept in a regular string or Unicode object. The instance's content is kept in a regular string or Unicode
string object, which is accessible via the \member{data} attribute of string object, which is accessible via the \member{data} attribute of
\class{UserString} instances. The instance's contents are initially \class{UserString} instances. The instance's contents are initially
......
...@@ -274,7 +274,7 @@ the tag name was \code{'http://www.w3.org/TR/REC-html40 html'}, and ...@@ -274,7 +274,7 @@ the tag name was \code{'http://www.w3.org/TR/REC-html40 html'}, and
the tag \code{<html:a href='http://frob.com'>} inside the above the tag \code{<html:a href='http://frob.com'>} inside the above
mentioned element is treated as if the tag name were mentioned element is treated as if the tag name were
\code{'http://www.w3.org/TR/REC-html40 a'} and the attribute name as \code{'http://www.w3.org/TR/REC-html40 a'} and the attribute name as
if it were \code{'http://www.w3.org/TR/REC-html40 src'}. if it were \code{'http://www.w3.org/TR/REC-html40 href'}.
An older draft of the XML Namespaces proposal is also recognized, but An older draft of the XML Namespaces proposal is also recognized, but
triggers a warning. triggers a warning.
......
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