mirror of
https://github.com/python/cpython.git
synced 2025-08-02 16:13:13 +00:00
SF Patch #1093896: miscellaneous doc typos
This commit is contained in:
parent
f871d833dd
commit
68804315e0
60 changed files with 103 additions and 102 deletions
|
@ -277,7 +277,7 @@ set_all(PyObject *target, PyObject *item)
|
||||||
The situation is slightly different for function return values.
|
The situation is slightly different for function return values.
|
||||||
While passing a reference to most functions does not change your
|
While passing a reference to most functions does not change your
|
||||||
ownership responsibilities for that reference, many functions that
|
ownership responsibilities for that reference, many functions that
|
||||||
return a referece to an object give you ownership of the reference.
|
return a reference to an object give you ownership of the reference.
|
||||||
The reason is simple: in many cases, the returned object is created
|
The reason is simple: in many cases, the returned object is created
|
||||||
on the fly, and the reference you get is the only reference to the
|
on the fly, and the reference you get is the only reference to the
|
||||||
object. Therefore, the generic functions that return object
|
object. Therefore, the generic functions that return object
|
||||||
|
|
|
@ -134,7 +134,7 @@ that \var{TYPE} refers to any C type.
|
||||||
In addition, the following macro sets are provided for calling the
|
In addition, the following macro sets are provided for calling the
|
||||||
Python memory allocator directly, without involving the C API functions
|
Python memory allocator directly, without involving the C API functions
|
||||||
listed above. However, note that their use does not preserve binary
|
listed above. However, note that their use does not preserve binary
|
||||||
compatibility accross Python versions and is therefore deprecated in
|
compatibility across Python versions and is therefore deprecated in
|
||||||
extension modules.
|
extension modules.
|
||||||
|
|
||||||
\cfunction{PyMem_MALLOC()}, \cfunction{PyMem_REALLOC()}, \cfunction{PyMem_FREE()}.
|
\cfunction{PyMem_MALLOC()}, \cfunction{PyMem_REALLOC()}, \cfunction{PyMem_FREE()}.
|
||||||
|
|
6
Doc/dist/dist.tex
vendored
6
Doc/dist/dist.tex
vendored
|
@ -34,7 +34,7 @@
|
||||||
build/release/install mechanics.
|
build/release/install mechanics.
|
||||||
\end{abstract}
|
\end{abstract}
|
||||||
|
|
||||||
% The ugly "%begin{latexonly}" pseudo-environment supresses the table
|
% The ugly "%begin{latexonly}" pseudo-environment suppresses the table
|
||||||
% of contents for HTML generation.
|
% of contents for HTML generation.
|
||||||
%
|
%
|
||||||
%begin{latexonly}
|
%begin{latexonly}
|
||||||
|
@ -965,7 +965,7 @@ inplace=1
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
|
|
||||||
This will affect all builds of this module distribution, whether or not
|
This will affect all builds of this module distribution, whether or not
|
||||||
you explcitly specify \command{build\_ext}. If you include
|
you explicitly specify \command{build\_ext}. If you include
|
||||||
\file{setup.cfg} in your source distribution, it will also affect
|
\file{setup.cfg} in your source distribution, it will also affect
|
||||||
end-user builds---which is probably a bad idea for this option, since
|
end-user builds---which is probably a bad idea for this option, since
|
||||||
always building extensions in-place would break installation of the
|
always building extensions in-place would break installation of the
|
||||||
|
@ -2521,7 +2521,7 @@ output debug symbols in (or alongside) the object file(s).
|
||||||
\var{extra_preargs} and \var{extra_postargs} are implementation- dependent.
|
\var{extra_preargs} and \var{extra_postargs} are implementation- dependent.
|
||||||
On platforms that have the notion of a command-line (e.g. \UNIX,
|
On platforms that have the notion of a command-line (e.g. \UNIX,
|
||||||
DOS/Windows), they are most likely lists of strings: extra
|
DOS/Windows), they are most likely lists of strings: extra
|
||||||
command-line arguments to prepand/append to the compiler command
|
command-line arguments to prepend/append to the compiler command
|
||||||
line. On other platforms, consult the implementation class
|
line. On other platforms, consult the implementation class
|
||||||
documentation. In any event, they are intended as an escape hatch
|
documentation. In any event, they are intended as an escape hatch
|
||||||
for those occasions when the abstract compiler framework doesn't
|
for those occasions when the abstract compiler framework doesn't
|
||||||
|
|
|
@ -204,7 +204,7 @@ text contributions are more than welcome as well.
|
||||||
For ``central processing unit.'' Many style guides say this
|
For ``central processing unit.'' Many style guides say this
|
||||||
should be spelled out on the first use (and if you must use it,
|
should be spelled out on the first use (and if you must use it,
|
||||||
do so!). For the Python documentation, this abbreviation should
|
do so!). For the Python documentation, this abbreviation should
|
||||||
be avoided since there's no reasonable way to predict which occurance
|
be avoided since there's no reasonable way to predict which occurrence
|
||||||
will be the first seen by the reader. It is better to use the
|
will be the first seen by the reader. It is better to use the
|
||||||
word ``processor'' instead.
|
word ``processor'' instead.
|
||||||
|
|
||||||
|
@ -471,7 +471,7 @@ This \UNIX\ is also followed by a space.
|
||||||
|
|
||||||
\LaTeX{} provides a variety of environments even without the
|
\LaTeX{} provides a variety of environments even without the
|
||||||
additional markup provided by the Python-specific document classes
|
additional markup provided by the Python-specific document classes
|
||||||
introducted in the next section. The following environments are
|
introduced in the next section. The following environments are
|
||||||
provided as part of standard \LaTeX{} and are being used in the
|
provided as part of standard \LaTeX{} and are being used in the
|
||||||
standard Python documentation; descriptions will be added here as
|
standard Python documentation; descriptions will be added here as
|
||||||
time allows.
|
time allows.
|
||||||
|
@ -651,7 +651,7 @@ verbatim
|
||||||
\end{envdesc}
|
\end{envdesc}
|
||||||
|
|
||||||
\begin{envdesc}{excclassdesc}{\p{name}\p{constructor parameters}}
|
\begin{envdesc}{excclassdesc}{\p{name}\p{constructor parameters}}
|
||||||
Descibe an exception defined by a class. \var{constructor
|
Describe an exception defined by a class. \var{constructor
|
||||||
parameters} should not include the \var{self} parameter or
|
parameters} should not include the \var{self} parameter or
|
||||||
the parentheses used in the call syntax. To describe an
|
the parentheses used in the call syntax. To describe an
|
||||||
exception class without describing the parameters to its
|
exception class without describing the parameters to its
|
||||||
|
@ -830,7 +830,7 @@ verbatim
|
||||||
with release \var{version}. The text given as \var{what to do}
|
with release \var{version}. The text given as \var{what to do}
|
||||||
should recommend something to use instead. It should be
|
should recommend something to use instead. It should be
|
||||||
complete sentences. The entire deprecation notice will be
|
complete sentences. The entire deprecation notice will be
|
||||||
presented as a separate paragraph; it should either preceed or
|
presented as a separate paragraph; it should either precede or
|
||||||
succeed the description of the deprecated feature.
|
succeed the description of the deprecated feature.
|
||||||
\end{macrodesc}
|
\end{macrodesc}
|
||||||
|
|
||||||
|
@ -1122,7 +1122,7 @@ verbatim
|
||||||
|
|
||||||
\begin{envdesc}{notice}{\op{type}}
|
\begin{envdesc}{notice}{\op{type}}
|
||||||
Label some paragraphs as being worthy of additional attention from
|
Label some paragraphs as being worthy of additional attention from
|
||||||
the reader. What sort of attention is warrented can be indicated
|
the reader. What sort of attention is warranted can be indicated
|
||||||
by specifying the \var{type} of the notice. The only values
|
by specifying the \var{type} of the notice. The only values
|
||||||
defined for \var{type} are \code{note} and \code{warning}; these
|
defined for \var{type} are \code{note} and \code{warning}; these
|
||||||
are equivalent in intent to the inline markup of the same name.
|
are equivalent in intent to the inline markup of the same name.
|
||||||
|
@ -1660,7 +1660,7 @@ verbatim
|
||||||
\begin{envdesc}{productionlist}{\op{language}}
|
\begin{envdesc}{productionlist}{\op{language}}
|
||||||
This environment is used to enclose a group of productions. The
|
This environment is used to enclose a group of productions. The
|
||||||
two macros are only defined within this environment. If a
|
two macros are only defined within this environment. If a
|
||||||
document descibes more than one language, the optional parameter
|
document describes more than one language, the optional parameter
|
||||||
\var{language} should be used to distinguish productions between
|
\var{language} should be used to distinguish productions between
|
||||||
languages. The value of the parameter should be a short name
|
languages. The value of the parameter should be a short name
|
||||||
that can be used as part of a filename; colons or other
|
that can be used as part of a filename; colons or other
|
||||||
|
@ -1731,7 +1731,7 @@ verbatim
|
||||||
a complete sequence of menu selections, including selecting
|
a complete sequence of menu selections, including selecting
|
||||||
submenus and choosing a specific operation, or any subsequence of
|
submenus and choosing a specific operation, or any subsequence of
|
||||||
such a sequence. The names of individual selections should be
|
such a sequence. The names of individual selections should be
|
||||||
separated by occurances of \macro{sub}.
|
separated by occurrences of \macro{sub}.
|
||||||
|
|
||||||
For example, to mark the selection ``\menuselection{Start \sub
|
For example, to mark the selection ``\menuselection{Start \sub
|
||||||
Programs}'', use this markup:
|
Programs}'', use this markup:
|
||||||
|
@ -2080,7 +2080,7 @@ mydoc.ps: mydoc.tex mygraphic.eps
|
||||||
fairly rough.
|
fairly rough.
|
||||||
|
|
||||||
The timeframe for the conversion is not clear since there doesn't
|
The timeframe for the conversion is not clear since there doesn't
|
||||||
seem to be much time available to work on this, but the appearant
|
seem to be much time available to work on this, but the apparent
|
||||||
benefits are growing more substantial at a moderately rapid pace.
|
benefits are growing more substantial at a moderately rapid pace.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -23,7 +23,7 @@ Let's create an extension module called \samp{spam} (the favorite food
|
||||||
of Monty Python fans...) and let's say we want to create a Python
|
of Monty Python fans...) and let's say we want to create a Python
|
||||||
interface to the C library function \cfunction{system()}.\footnote{An
|
interface to the C library function \cfunction{system()}.\footnote{An
|
||||||
interface for this function already exists in the standard module
|
interface for this function already exists in the standard module
|
||||||
\module{os} --- it was chosen as a simple and straightfoward example.}
|
\module{os} --- it was chosen as a simple and straightforward example.}
|
||||||
This function takes a null-terminated character string as argument and
|
This function takes a null-terminated character string as argument and
|
||||||
returns an integer. We want this function to be callable from Python
|
returns an integer. We want this function to be callable from Python
|
||||||
as follows:
|
as follows:
|
||||||
|
@ -1002,8 +1002,8 @@ on, it must be turned into an owned reference by calling
|
||||||
\cfunction{Py_INCREF()}.
|
\cfunction{Py_INCREF()}.
|
||||||
|
|
||||||
The object reference returned from a C function that is called from
|
The object reference returned from a C function that is called from
|
||||||
Python must be an owned reference --- ownership is tranferred from the
|
Python must be an owned reference --- ownership is transferred from
|
||||||
function to its caller.
|
the function to its caller.
|
||||||
|
|
||||||
|
|
||||||
\subsection{Thin Ice
|
\subsection{Thin Ice
|
||||||
|
@ -1147,7 +1147,7 @@ apply. If the main program (the Python interpreter) is compiled and
|
||||||
linked by the C compiler, global or static objects with constructors
|
linked by the C compiler, global or static objects with constructors
|
||||||
cannot be used. This is not a problem if the main program is linked
|
cannot be used. This is not a problem if the main program is linked
|
||||||
by the \Cpp{} compiler. Functions that will be called by the
|
by the \Cpp{} compiler. Functions that will be called by the
|
||||||
Python interpreter (in particular, module initalization functions)
|
Python interpreter (in particular, module initialization functions)
|
||||||
have to be declared using \code{extern "C"}.
|
have to be declared using \code{extern "C"}.
|
||||||
It is unnecessary to enclose the Python header files in
|
It is unnecessary to enclose the Python header files in
|
||||||
\code{extern "C" \{...\}} --- they use this form already if the symbol
|
\code{extern "C" \{...\}} --- they use this form already if the symbol
|
||||||
|
|
|
@ -44,7 +44,7 @@
|
||||||
%\end{abstract}
|
%\end{abstract}
|
||||||
|
|
||||||
|
|
||||||
% The ugly "%begin{latexonly}" pseudo-environment supresses the table
|
% The ugly "%begin{latexonly}" pseudo-environment suppresses the table
|
||||||
% of contents for HTML generation.
|
% of contents for HTML generation.
|
||||||
%
|
%
|
||||||
%begin{latexonly}
|
%begin{latexonly}
|
||||||
|
|
|
@ -299,7 +299,7 @@ Stmt([Return(Mul((Name('x'), Const(2))))])
|
||||||
|
|
||||||
The visitor pattern is ... The \refmodule{compiler} package uses a
|
The visitor pattern is ... The \refmodule{compiler} package uses a
|
||||||
variant on the visitor pattern that takes advantage of Python's
|
variant on the visitor pattern that takes advantage of Python's
|
||||||
introspection features to elminiate the need for much of the visitor's
|
introspection features to eliminate the need for much of the visitor's
|
||||||
infrastructure.
|
infrastructure.
|
||||||
|
|
||||||
The classes being visited do not need to be programmed to accept
|
The classes being visited do not need to be programmed to accept
|
||||||
|
|
|
@ -10,7 +10,7 @@ contains only 7-bit \ASCII{} characters.
|
||||||
Of course, as email has been deployed worldwide, it has become
|
Of course, as email has been deployed worldwide, it has become
|
||||||
internationalized, such that language specific character sets can now
|
internationalized, such that language specific character sets can now
|
||||||
be used in email messages. The base standard still requires email
|
be used in email messages. The base standard still requires email
|
||||||
messages to be transfered using only 7-bit \ASCII{} characters, so a
|
messages to be transferred using only 7-bit \ASCII{} characters, so a
|
||||||
slew of RFCs have been written describing how to encode email
|
slew of RFCs have been written describing how to encode email
|
||||||
containing non-\ASCII{} characters into \rfc{2822}-compliant format.
|
containing non-\ASCII{} characters into \rfc{2822}-compliant format.
|
||||||
These RFCs include \rfc{2045}, \rfc{2046}, \rfc{2047}, and \rfc{2231}.
|
These RFCs include \rfc{2045}, \rfc{2046}, \rfc{2047}, and \rfc{2231}.
|
||||||
|
|
|
@ -16,7 +16,7 @@ serialize them somehow, typically using marshal.dumps or pickle.dumps.
|
||||||
|
|
||||||
Starting with Python 2.3 the \module{bsddb} module requires the
|
Starting with Python 2.3 the \module{bsddb} module requires the
|
||||||
Berkeley DB library version 3.2 or later (it is known to work with 3.2
|
Berkeley DB library version 3.2 or later (it is known to work with 3.2
|
||||||
thru 4.3 at the time of this writing).
|
through 4.3 at the time of this writing).
|
||||||
|
|
||||||
\begin{seealso}
|
\begin{seealso}
|
||||||
\seeurl{http://pybsddb.sourceforge.net/}{Website with documentation
|
\seeurl{http://pybsddb.sourceforge.net/}{Website with documentation
|
||||||
|
|
|
@ -50,7 +50,7 @@ Open the CD-ROM device. The return value is an opaque player object;
|
||||||
methods of the player object are described below. The device is the
|
methods of the player object are described below. The device is the
|
||||||
name of the SCSI device file, e.g. \code{'/dev/scsi/sc0d4l0'}, or
|
name of the SCSI device file, e.g. \code{'/dev/scsi/sc0d4l0'}, or
|
||||||
\code{None}. If omitted or \code{None}, the hardware inventory is
|
\code{None}. If omitted or \code{None}, the hardware inventory is
|
||||||
consulted to locate a CD-ROM drive. The \var{mode}, if not omited,
|
consulted to locate a CD-ROM drive. The \var{mode}, if not omitted,
|
||||||
should be the string \code{'r'}.
|
should be the string \code{'r'}.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
|
|
|
@ -136,7 +136,7 @@ purposes, a good reference should be the following:
|
||||||
|
|
||||||
\begin{seealso}
|
\begin{seealso}
|
||||||
\seetext{Kahan, W: Branch cuts for complex elementary functions;
|
\seetext{Kahan, W: Branch cuts for complex elementary functions;
|
||||||
or, Much ado about nothings's sign bit. In Iserles, A.,
|
or, Much ado about nothing's sign bit. In Iserles, A.,
|
||||||
and Powell, M. (eds.), \citetitle{The state of the art in
|
and Powell, M. (eds.), \citetitle{The state of the art in
|
||||||
numerical analysis}. Clarendon Press (1987) pp165-211.}
|
numerical analysis}. Clarendon Press (1987) pp165-211.}
|
||||||
\end{seealso}
|
\end{seealso}
|
||||||
|
|
|
@ -977,7 +977,7 @@ listed as operand type in the table.
|
||||||
\lineiv{unicode_internal}
|
\lineiv{unicode_internal}
|
||||||
{}
|
{}
|
||||||
{Unicode string}
|
{Unicode string}
|
||||||
{Return the internal represenation of the operand}
|
{Return the internal representation of the operand}
|
||||||
|
|
||||||
\lineiv{uu_codec}
|
\lineiv{uu_codec}
|
||||||
{uu}
|
{uu}
|
||||||
|
|
|
@ -58,7 +58,7 @@ for the parser is better.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{classdesc}{Compile}{}
|
\begin{classdesc}{Compile}{}
|
||||||
Instances of this class have \method{__call__()} methods indentical in
|
Instances of this class have \method{__call__()} methods identical in
|
||||||
signature to the built-in function \function{compile()}, but with the
|
signature to the built-in function \function{compile()}, but with the
|
||||||
difference that if the instance compiles program text containing a
|
difference that if the instance compiles program text containing a
|
||||||
\module{__future__} statement, the instance 'remembers' and compiles
|
\module{__future__} statement, the instance 'remembers' and compiles
|
||||||
|
|
|
@ -414,7 +414,7 @@ Both RFC 2965 and Netscape cookies are covered. RFC 2965 handling is
|
||||||
switched off by default.
|
switched off by default.
|
||||||
|
|
||||||
The easiest way to provide your own policy is to override this class
|
The easiest way to provide your own policy is to override this class
|
||||||
and call its methods in your overriden implementations before adding
|
and call its methods in your overridden implementations before adding
|
||||||
your own additional checks:
|
your own additional checks:
|
||||||
|
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
|
|
|
@ -1173,7 +1173,7 @@ there are normally at least four function keys (\constant{KEY_F1},
|
||||||
\constant{KEY_F2}, \constant{KEY_F3}, \constant{KEY_F4}) available,
|
\constant{KEY_F2}, \constant{KEY_F3}, \constant{KEY_F4}) available,
|
||||||
and the arrow keys mapped to \constant{KEY_UP}, \constant{KEY_DOWN},
|
and the arrow keys mapped to \constant{KEY_UP}, \constant{KEY_DOWN},
|
||||||
\constant{KEY_LEFT} and \constant{KEY_RIGHT} in the obvious way. If
|
\constant{KEY_LEFT} and \constant{KEY_RIGHT} in the obvious way. If
|
||||||
your machine has a PC keybboard, it is safe to expect arrow keys and
|
your machine has a PC keyboard, it is safe to expect arrow keys and
|
||||||
twelve function keys (older PC keyboards may have only ten function
|
twelve function keys (older PC keyboards may have only ten function
|
||||||
keys); also, the following keypad mappings are standard:
|
keys); also, the following keypad mappings are standard:
|
||||||
|
|
||||||
|
|
|
@ -431,7 +431,7 @@ of the other sequences.
|
||||||
Each tuple is of the form \code{(\var{tag}, \var{i1}, \var{i2},
|
Each tuple is of the form \code{(\var{tag}, \var{i1}, \var{i2},
|
||||||
\var{j1}, \var{j2})}. The first tuple has \code{\var{i1} ==
|
\var{j1}, \var{j2})}. The first tuple has \code{\var{i1} ==
|
||||||
\var{j1} == 0}, and remaining tuples have \var{i1} equal to the
|
\var{j1} == 0}, and remaining tuples have \var{i1} equal to the
|
||||||
\var{i2} from the preceeding tuple, and, likewise, \var{j1} equal to
|
\var{i2} from the preceding tuple, and, likewise, \var{j1} equal to
|
||||||
the previous \var{j2}.
|
the previous \var{j2}.
|
||||||
|
|
||||||
The \var{tag} values are strings, with these meanings:
|
The \var{tag} values are strings, with these meanings:
|
||||||
|
|
|
@ -1347,7 +1347,7 @@ initialized by the constructor, and should not be modified directly.
|
||||||
|
|
||||||
\begin{memberdesc}{indent}
|
\begin{memberdesc}{indent}
|
||||||
The example's indentation in the containing string, i.e., the
|
The example's indentation in the containing string, i.e., the
|
||||||
number of space characters that preceed the example's first
|
number of space characters that precede the example's first
|
||||||
prompt.
|
prompt.
|
||||||
\end{memberdesc}
|
\end{memberdesc}
|
||||||
|
|
||||||
|
|
|
@ -278,7 +278,7 @@ Raised when an \keyword{assert} statement fails.
|
||||||
when reading the initial script or standard input (also
|
when reading the initial script or standard input (also
|
||||||
interactively).
|
interactively).
|
||||||
|
|
||||||
Instances of this class have atttributes \member{filename},
|
Instances of this class have attributes \member{filename},
|
||||||
\member{lineno}, \member{offset} and \member{text} for easier access
|
\member{lineno}, \member{offset} and \member{text} for easier access
|
||||||
to the details. \function{str()} of the exception instance returns
|
to the details. \function{str()} of the exception instance returns
|
||||||
only the message.
|
only the message.
|
||||||
|
|
|
@ -70,12 +70,12 @@ Print (to \code{sys.stdout}) a comparison between \var{a} and \var{b}.
|
||||||
|
|
||||||
\begin{methoddesc}[dircmp]{report_partial_closure}{}
|
\begin{methoddesc}[dircmp]{report_partial_closure}{}
|
||||||
Print a comparison between \var{a} and \var{b} and common immediate
|
Print a comparison between \var{a} and \var{b} and common immediate
|
||||||
subdirctories.
|
subdirectories.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}[dircmp]{report_full_closure}{}
|
\begin{methoddesc}[dircmp]{report_full_closure}{}
|
||||||
Print a comparison between \var{a} and \var{b} and common
|
Print a comparison between \var{a} and \var{b} and common
|
||||||
subdirctories (recursively).
|
subdirectories (recursively).
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
|
|
||||||
|
@ -84,7 +84,7 @@ be used to get various bits of information about the directory trees
|
||||||
being compared.
|
being compared.
|
||||||
|
|
||||||
Note that via \method{__getattr__()} hooks, all attributes are
|
Note that via \method{__getattr__()} hooks, all attributes are
|
||||||
computed lazilly, so there is no speed penalty if only those
|
computed lazily, so there is no speed penalty if only those
|
||||||
attributes which are lightweight to compute are used.
|
attributes which are lightweight to compute are used.
|
||||||
|
|
||||||
\begin{memberdesc}[dircmp]{left_list}
|
\begin{memberdesc}[dircmp]{left_list}
|
||||||
|
|
|
@ -169,7 +169,7 @@ class C:
|
||||||
argument is it -- the future statements in effect around the call to
|
argument is it -- the future statements in effect around the call to
|
||||||
compile are ignored.
|
compile are ignored.
|
||||||
|
|
||||||
Future statemants are specified by bits which can be bitwise or-ed
|
Future statements are specified by bits which can be bitwise or-ed
|
||||||
together to specify multiple statements. The bitfield required to
|
together to specify multiple statements. The bitfield required to
|
||||||
specify a given feature can be found as the \member{compiler_flag}
|
specify a given feature can be found as the \member{compiler_flag}
|
||||||
attribute on the \class{_Feature} instance in the
|
attribute on the \class{_Feature} instance in the
|
||||||
|
|
|
@ -40,7 +40,7 @@ control how the database is opened:
|
||||||
|
|
||||||
\begin{itemize}
|
\begin{itemize}
|
||||||
\item \code{'f'} --- Open the database in fast mode. Writes to the database
|
\item \code{'f'} --- Open the database in fast mode. Writes to the database
|
||||||
will not be syncronized.
|
will not be synchronized.
|
||||||
\item \code{'s'} --- Synchronized mode. This will cause changes to the database
|
\item \code{'s'} --- Synchronized mode. This will cause changes to the database
|
||||||
will be immediately written to the file.
|
will be immediately written to the file.
|
||||||
\item \code{'u'} --- Do not lock database.
|
\item \code{'u'} --- Do not lock database.
|
||||||
|
|
|
@ -59,7 +59,7 @@ both the globals and locals for the script.
|
||||||
Profile a single call of a callable.
|
Profile a single call of a callable.
|
||||||
Additional positional and keyword arguments may be passed
|
Additional positional and keyword arguments may be passed
|
||||||
along; the result of the call is returned, and exceptions are
|
along; the result of the call is returned, and exceptions are
|
||||||
allowed to propogate cleanly, while ensuring that profiling is
|
allowed to propagate cleanly, while ensuring that profiling is
|
||||||
disabled on the way out.
|
disabled on the way out.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
|
|
|
@ -413,7 +413,7 @@ msgnums = M.search(None, '(FROM "LDJ")')
|
||||||
\code{uid search} corresponds to \code{search}. The \code{thread}
|
\code{uid search} corresponds to \code{search}. The \code{thread}
|
||||||
command first searches the mailbox for messages that match the given
|
command first searches the mailbox for messages that match the given
|
||||||
searching criteria using the charset argument for the interpretation
|
searching criteria using the charset argument for the interpretation
|
||||||
of strings in the searching criteria. It thren returns the matching
|
of strings in the searching criteria. It then returns the matching
|
||||||
messages threaded according to the specified threading algorithm.
|
messages threaded according to the specified threading algorithm.
|
||||||
|
|
||||||
This is an \samp{IMAP4rev1} extension command. \versionadded{2.4}
|
This is an \samp{IMAP4rev1} extension command. \versionadded{2.4}
|
||||||
|
|
|
@ -40,7 +40,7 @@ scaled to the given \var{x} and \var{y} sizes. If the \var{filter} and
|
||||||
simply dropping or duplicating pixels, so the result will be less than
|
simply dropping or duplicating pixels, so the result will be less than
|
||||||
perfect, especially for computer-generated images.
|
perfect, especially for computer-generated images.
|
||||||
|
|
||||||
Alternatively, you can specify a filter to use to smoothen the image
|
Alternatively, you can specify a filter to use to smooth the image
|
||||||
after scaling. The filter forms supported are \code{'impulse'},
|
after scaling. The filter forms supported are \code{'impulse'},
|
||||||
\code{'box'}, \code{'triangle'}, \code{'quadratic'} and
|
\code{'box'}, \code{'triangle'}, \code{'quadratic'} and
|
||||||
\code{'gaussian'}. If a filter is specified \var{blur} is an optional
|
\code{'gaussian'}. If a filter is specified \var{blur} is an optional
|
||||||
|
|
|
@ -57,7 +57,7 @@ open file \var{output}. The block size is currently fixed at 8192.
|
||||||
|
|
||||||
|
|
||||||
\begin{seealso}
|
\begin{seealso}
|
||||||
\seemodule{email}{Comprehensive email handling package; supercedes
|
\seemodule{email}{Comprehensive email handling package; supersedes
|
||||||
the \module{mimetools} module.}
|
the \module{mimetools} module.}
|
||||||
\seemodule{rfc822}{Provides the base class for
|
\seemodule{rfc822}{Provides the base class for
|
||||||
\class{mimetools.Message}.}
|
\class{mimetools.Message}.}
|
||||||
|
|
|
@ -35,7 +35,7 @@ messages that may have multiple nested message parts, each with its
|
||||||
own pattern for section-divider and end-marker lines.
|
own pattern for section-divider and end-marker lines.
|
||||||
|
|
||||||
\begin{seealso}
|
\begin{seealso}
|
||||||
\seemodule{email}{Comprehensive email handling package; supercedes
|
\seemodule{email}{Comprehensive email handling package; supersedes
|
||||||
the \module{multifile} module.}
|
the \module{multifile} module.}
|
||||||
\end{seealso}
|
\end{seealso}
|
||||||
|
|
||||||
|
|
|
@ -42,7 +42,7 @@ and
|
||||||
Note that unlike the built-in \function{cmp()}, these functions can
|
Note that unlike the built-in \function{cmp()}, these functions can
|
||||||
return any value, which may or may not be interpretable as a Boolean
|
return any value, which may or may not be interpretable as a Boolean
|
||||||
value. See the \citetitle[../ref/ref.html]{Python Reference Manual}
|
value. See the \citetitle[../ref/ref.html]{Python Reference Manual}
|
||||||
for more informations about rich comparisons.
|
for more information about rich comparisons.
|
||||||
\versionadded{2.2}
|
\versionadded{2.2}
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
|
|
|
@ -261,7 +261,7 @@ see if each parameter was actually set to the requested value, and
|
||||||
raises \exception{OSSAudioError} if not. Returns a tuple (\var{format},
|
raises \exception{OSSAudioError} if not. Returns a tuple (\var{format},
|
||||||
\var{nchannels}, \var{samplerate}) indicating the parameter values that
|
\var{nchannels}, \var{samplerate}) indicating the parameter values that
|
||||||
were actually set by the device driver (i.e., the same as the return
|
were actually set by the device driver (i.e., the same as the return
|
||||||
valus of \method{setfmt()}, \method{channels()}, and \method{speed()}).
|
values of \method{setfmt()}, \method{channels()}, and \method{speed()}).
|
||||||
|
|
||||||
For example,
|
For example,
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
|
|
|
@ -17,7 +17,7 @@
|
||||||
|
|
||||||
\begin{funcdesc}{architecture}{executable=sys.executable, bits='', linkage=''}
|
\begin{funcdesc}{architecture}{executable=sys.executable, bits='', linkage=''}
|
||||||
Queries the given executable (defaults to the Python interpreter
|
Queries the given executable (defaults to the Python interpreter
|
||||||
binary) for various architecture informations.
|
binary) for various architecture information.
|
||||||
|
|
||||||
Returns a tuple \code{(bits, linkage)} which contain information about
|
Returns a tuple \code{(bits, linkage)} which contain information about
|
||||||
the bit architecture and the linkage format used for the
|
the bit architecture and the linkage format used for the
|
||||||
|
|
|
@ -196,7 +196,7 @@ context (direct and indirect containers for \var{object} that are
|
||||||
affecting the presentation) as the keys; if an object needs to be
|
affecting the presentation) as the keys; if an object needs to be
|
||||||
presented which is already represented in \var{context}, the third
|
presented which is already represented in \var{context}, the third
|
||||||
return value should be true. Recursive calls to the \method{format()}
|
return value should be true. Recursive calls to the \method{format()}
|
||||||
method should add additionaly entries for containers to this
|
method should add additional entries for containers to this
|
||||||
dictionary. The fourth argument, \var{maxlevels}, gives the requested
|
dictionary. The fourth argument, \var{maxlevels}, gives the requested
|
||||||
limit to recursion; this will be \code{0} if there is no requested
|
limit to recursion; this will be \code{0} if there is no requested
|
||||||
limit. This argument should be passed unmodified to recursive calls.
|
limit. This argument should be passed unmodified to recursive calls.
|
||||||
|
|
|
@ -310,7 +310,7 @@ This requires Expat version 1.2 or newer.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}[xmlparser]{EndDoctypeDeclHandler}{}
|
\begin{methoddesc}[xmlparser]{EndDoctypeDeclHandler}{}
|
||||||
Called when Expat is done parsing the document type delaration.
|
Called when Expat is done parsing the document type declaration.
|
||||||
This requires Expat version 1.2 or newer.
|
This requires Expat version 1.2 or newer.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
|
@ -379,7 +379,7 @@ entities, \var{value} will be a string giving the declared contents
|
||||||
of the entity; this will be \code{None} for external entities. The
|
of the entity; this will be \code{None} for external entities. The
|
||||||
\var{notationName} parameter will be \code{None} for parsed entities,
|
\var{notationName} parameter will be \code{None} for parsed entities,
|
||||||
and the name of the notation for unparsed entities.
|
and the name of the notation for unparsed entities.
|
||||||
\var{is_parameter_entity} will be true if the entity is a paremeter
|
\var{is_parameter_entity} will be true if the entity is a parameter
|
||||||
entity or false for general entities (most applications only need to
|
entity or false for general entities (most applications only need to
|
||||||
be concerned with general entities).
|
be concerned with general entities).
|
||||||
This is only available starting with version 1.95.0 of the Expat
|
This is only available starting with version 1.95.0 of the Expat
|
||||||
|
|
|
@ -845,9 +845,9 @@ index into the string beyond which the RE engine will not go.
|
||||||
The integer index of the last matched capturing group, or \code{None}
|
The integer index of the last matched capturing group, or \code{None}
|
||||||
if no group was matched at all. For example, the expressions
|
if no group was matched at all. For example, the expressions
|
||||||
\regexp{(a)b}, \regexp{((a)(b))}, and \regexp{((ab))} will have
|
\regexp{(a)b}, \regexp{((a)(b))}, and \regexp{((ab))} will have
|
||||||
\code{lastindex == 1} if applyied to the string \code{'ab'},
|
\code{lastindex == 1} if applied to the string \code{'ab'},
|
||||||
while the expression \regexp{(a)(b)} will have \code{lastindex == 2},
|
while the expression \regexp{(a)(b)} will have \code{lastindex == 2},
|
||||||
if applyied to the same string.
|
if applied to the same string.
|
||||||
\end{memberdesc}
|
\end{memberdesc}
|
||||||
|
|
||||||
\begin{memberdesc}[MatchObject]{lastgroup}
|
\begin{memberdesc}[MatchObject]{lastgroup}
|
||||||
|
|
|
@ -44,7 +44,7 @@ operating system are not defined in this module for those platforms.
|
||||||
Returns a tuple \code{(\var{soft}, \var{hard})} with the current
|
Returns a tuple \code{(\var{soft}, \var{hard})} with the current
|
||||||
soft and hard limits of \var{resource}. Raises \exception{ValueError} if
|
soft and hard limits of \var{resource}. Raises \exception{ValueError} if
|
||||||
an invalid resource is specified, or \exception{error} if the
|
an invalid resource is specified, or \exception{error} if the
|
||||||
underyling system call fails unexpectedly.
|
underlying system call fails unexpectedly.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{setrlimit}{resource, limits}
|
\begin{funcdesc}{setrlimit}{resource, limits}
|
||||||
|
@ -56,7 +56,7 @@ operating system are not defined in this module for those platforms.
|
||||||
Raises \exception{ValueError} if an invalid resource is specified,
|
Raises \exception{ValueError} if an invalid resource is specified,
|
||||||
if the new soft limit exceeds the hard limit, or if a process tries
|
if the new soft limit exceeds the hard limit, or if a process tries
|
||||||
to raise its hard limit (unless the process has an effective UID of
|
to raise its hard limit (unless the process has an effective UID of
|
||||||
super-user). Can also raise \exception{error} if the underyling
|
super-user). Can also raise \exception{error} if the underlying
|
||||||
system call fails.
|
system call fails.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
|
|
|
@ -129,7 +129,7 @@ switch dates. Not enough to worry about for common use.
|
||||||
|
|
||||||
|
|
||||||
\begin{seealso}
|
\begin{seealso}
|
||||||
\seemodule{email}{Comprehensive email handling package; supercedes
|
\seemodule{email}{Comprehensive email handling package; supersedes
|
||||||
the \module{rfc822} module.}
|
the \module{rfc822} module.}
|
||||||
\seemodule{mailbox}{Classes to read various mailbox formats produced
|
\seemodule{mailbox}{Classes to read various mailbox formats produced
|
||||||
by end-user mail programs.}
|
by end-user mail programs.}
|
||||||
|
|
|
@ -61,7 +61,7 @@ descriptor, not just a random integer).
|
||||||
\note{File objects on Windows are not acceptable, but sockets
|
\note{File objects on Windows are not acceptable, but sockets
|
||||||
are.\index{WinSock} On Windows, the underlying \cfunction{select()}
|
are.\index{WinSock} On Windows, the underlying \cfunction{select()}
|
||||||
function is provided by the WinSock library, and does not handle file
|
function is provided by the WinSock library, and does not handle file
|
||||||
desciptors that don't originate from WinSock.}
|
descriptors that don't originate from WinSock.}
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\subsection{Polling Objects
|
\subsection{Polling Objects
|
||||||
|
|
|
@ -18,7 +18,7 @@ Open a persistent dictionary. The filename specified is the base filename
|
||||||
for the underlying database. As a side-effect, an extension may be added to
|
for the underlying database. As a side-effect, an extension may be added to
|
||||||
the filename and more than one file may be created. By default, the
|
the filename and more than one file may be created. By default, the
|
||||||
underlying database file is opened for reading and writing. The optional
|
underlying database file is opened for reading and writing. The optional
|
||||||
{}\var{flag} pararameter has the same interpretation as the \var{flag}
|
{}\var{flag} parameter has the same interpretation as the \var{flag}
|
||||||
parameter of \function{anydbm.open}.
|
parameter of \function{anydbm.open}.
|
||||||
|
|
||||||
By default, version 0 pickles are used to serialize values.
|
By default, version 0 pickles are used to serialize values.
|
||||||
|
|
|
@ -414,7 +414,7 @@ String literals are written in single or double quotes:
|
||||||
\code{'xyzzy'}, \code{"frobozz"}. See chapter 2 of the
|
\code{'xyzzy'}, \code{"frobozz"}. See chapter 2 of the
|
||||||
\citetitle[../ref/strings.html]{Python Reference Manual} for more about
|
\citetitle[../ref/strings.html]{Python Reference Manual} for more about
|
||||||
string literals. Unicode strings are much like strings, but are
|
string literals. Unicode strings are much like strings, but are
|
||||||
specified in the syntax using a preceeding \character{u} character:
|
specified in the syntax using a preceding \character{u} character:
|
||||||
\code{u'abc'}, \code{u"def"}. Lists are constructed with square brackets,
|
\code{u'abc'}, \code{u"def"}. Lists are constructed with square brackets,
|
||||||
separating items with commas: \code{[a, b, c]}. Tuples are
|
separating items with commas: \code{[a, b, c]}. Tuples are
|
||||||
constructed by the comma operator (not within square brackets), with
|
constructed by the comma operator (not within square brackets), with
|
||||||
|
@ -546,7 +546,7 @@ for assignments of the form \code{\var{s}=\var{s}+\var{t}} or
|
||||||
\code{\var{s}+=\var{t}}. When applicable, this optimization makes
|
\code{\var{s}+=\var{t}}. When applicable, this optimization makes
|
||||||
quadratic run-time much less likely. This optimization is both version
|
quadratic run-time much less likely. This optimization is both version
|
||||||
and implementation dependent. For performance sensitive code, it is
|
and implementation dependent. For performance sensitive code, it is
|
||||||
preferrable to use the \method{str.join()} method which assures consistent
|
preferable to use the \method{str.join()} method which assures consistent
|
||||||
linear concatenation performance across versions and implementations.
|
linear concatenation performance across versions and implementations.
|
||||||
\versionchanged[Formerly, string concatenation never occurred in-place]{2.4}
|
\versionchanged[Formerly, string concatenation never occurred in-place]{2.4}
|
||||||
|
|
||||||
|
@ -932,8 +932,8 @@ The conversion types are:
|
||||||
\lineiii{i}{Signed integer decimal.}{}
|
\lineiii{i}{Signed integer decimal.}{}
|
||||||
\lineiii{o}{Unsigned octal.}{(1)}
|
\lineiii{o}{Unsigned octal.}{(1)}
|
||||||
\lineiii{u}{Unsigned decimal.}{}
|
\lineiii{u}{Unsigned decimal.}{}
|
||||||
\lineiii{x}{Unsigned hexidecimal (lowercase).}{(2)}
|
\lineiii{x}{Unsigned hexadecimal (lowercase).}{(2)}
|
||||||
\lineiii{X}{Unsigned hexidecimal (uppercase).}{(2)}
|
\lineiii{X}{Unsigned hexadecimal (uppercase).}{(2)}
|
||||||
\lineiii{e}{Floating point exponential format (lowercase).}{}
|
\lineiii{e}{Floating point exponential format (lowercase).}{}
|
||||||
\lineiii{E}{Floating point exponential format (uppercase).}{}
|
\lineiii{E}{Floating point exponential format (uppercase).}{}
|
||||||
\lineiii{f}{Floating point decimal format.}{}
|
\lineiii{f}{Floating point decimal format.}{}
|
||||||
|
@ -1202,7 +1202,7 @@ subset of the second set (is a subset, but is not equal).
|
||||||
A set is greater than another set if and only if the first set is a proper
|
A set is greater than another set if and only if the first set is a proper
|
||||||
superset of the second set (is a superset, but is not equal).
|
superset of the second set (is a superset, but is not equal).
|
||||||
|
|
||||||
Instanceas of \class{set} are compared to instances of \class{frozenset} based
|
Instances of \class{set} are compared to instances of \class{frozenset} based
|
||||||
on their members. For example, \samp{set('abc') == frozenset('abc')} returns
|
on their members. For example, \samp{set('abc') == frozenset('abc')} returns
|
||||||
\code{True}.
|
\code{True}.
|
||||||
|
|
||||||
|
|
|
@ -375,14 +375,14 @@ Where:
|
||||||
\begin{itemize}
|
\begin{itemize}
|
||||||
\item[std and dst]
|
\item[std and dst]
|
||||||
Three or more alphanumerics giving the timezone abbreviations.
|
Three or more alphanumerics giving the timezone abbreviations.
|
||||||
These will be propogated into time.tzname
|
These will be propagated into time.tzname
|
||||||
|
|
||||||
\item[offset]
|
\item[offset]
|
||||||
The offset has the form: \plusminus{} hh[:mm[:ss]].
|
The offset has the form: \plusminus{} hh[:mm[:ss]].
|
||||||
This indicates the value added the local time to arrive at UTC.
|
This indicates the value added the local time to arrive at UTC.
|
||||||
If preceded by a '-', the timezone is east of the Prime
|
If preceded by a '-', the timezone is east of the Prime
|
||||||
Meridian; otherwise, it is west. If no offset follows
|
Meridian; otherwise, it is west. If no offset follows
|
||||||
dst, summmer time is assumed to be one hour ahead of standard time.
|
dst, summer time is assumed to be one hour ahead of standard time.
|
||||||
|
|
||||||
\item[start[/time],end[/time]]
|
\item[start[/time],end[/time]]
|
||||||
Indicates when to change to and back from DST. The format of the
|
Indicates when to change to and back from DST. The format of the
|
||||||
|
|
|
@ -568,7 +568,7 @@ Methods in the first group are:
|
||||||
|
|
||||||
\begin{methoddesc}[TestCase]{debug}{}
|
\begin{methoddesc}[TestCase]{debug}{}
|
||||||
Run the test without collecting the result. This allows exceptions
|
Run the test without collecting the result. This allows exceptions
|
||||||
raised by the test to be propogated to the caller, and can be used
|
raised by the test to be propagated to the caller, and can be used
|
||||||
to support running tests under a debugger.
|
to support running tests under a debugger.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
|
|
|
@ -51,7 +51,7 @@ above methods adds progressively more functionality. For instance,
|
||||||
defining all but \method{__delitem__} will preclude only \method{pop}
|
defining all but \method{__delitem__} will preclude only \method{pop}
|
||||||
and \method{popitem} from the full interface.
|
and \method{popitem} from the full interface.
|
||||||
|
|
||||||
In addition to the four base methods, progessively more efficiency
|
In addition to the four base methods, progressively more efficiency
|
||||||
comes with defining \method{__contains__()}, \method{__iter__()}, and
|
comes with defining \method{__contains__()}, \method{__iter__()}, and
|
||||||
\method{iteritems()}.
|
\method{iteritems()}.
|
||||||
|
|
||||||
|
|
|
@ -43,7 +43,7 @@ The \module{uu} module defines the following functions:
|
||||||
\begin{excclassdesc}{Error}{}
|
\begin{excclassdesc}{Error}{}
|
||||||
Subclass of \exception{Exception}, this can be raised by
|
Subclass of \exception{Exception}, this can be raised by
|
||||||
\function{uu.decode()} under various situations, such as described
|
\function{uu.decode()} under various situations, such as described
|
||||||
above, but also including a badly formated header, or truncated
|
above, but also including a badly formatted header, or truncated
|
||||||
input file.
|
input file.
|
||||||
\end{excclassdesc}
|
\end{excclassdesc}
|
||||||
|
|
||||||
|
|
|
@ -39,7 +39,7 @@ Rules can be added to the filter by calling
|
||||||
\function{resetwarnings()}.
|
\function{resetwarnings()}.
|
||||||
|
|
||||||
The printing of warning messages is done by calling
|
The printing of warning messages is done by calling
|
||||||
\function{showwarning()}, which may be overidden; the default
|
\function{showwarning()}, which may be overridden; the default
|
||||||
implementation of this function formats the message by calling
|
implementation of this function formats the message by calling
|
||||||
\function{formatwarning()}, which is also available for use by custom
|
\function{formatwarning()}, which is also available for use by custom
|
||||||
implementations.
|
implementations.
|
||||||
|
|
|
@ -97,7 +97,7 @@ compatibility. New code should use \class{ServerProxy}.
|
||||||
everything an XML-RPC client developer needs to know.}
|
everything an XML-RPC client developer needs to know.}
|
||||||
\seetitle[http://xmlrpc-c.sourceforge.net/hacks.php]
|
\seetitle[http://xmlrpc-c.sourceforge.net/hacks.php]
|
||||||
{XML-RPC-Hacks page}{Extensions for various open-source
|
{XML-RPC-Hacks page}{Extensions for various open-source
|
||||||
libraries to support instrospection and multicall.}
|
libraries to support introspection and multicall.}
|
||||||
\end{seealso}
|
\end{seealso}
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -36,7 +36,7 @@ The available attributes of this module are:
|
||||||
\end{classdesc*}
|
\end{classdesc*}
|
||||||
|
|
||||||
\begin{classdesc}{ZipInfo}{\optional{filename\optional{, date_time}}}
|
\begin{classdesc}{ZipInfo}{\optional{filename\optional{, date_time}}}
|
||||||
Class used the represent infomation about a member of an archive.
|
Class used to represent information about a member of an archive.
|
||||||
Instances of this class are returned by the \method{getinfo()} and
|
Instances of this class are returned by the \method{getinfo()} and
|
||||||
\method{infolist()} methods of \class{ZipFile} objects. Most users
|
\method{infolist()} methods of \class{ZipFile} objects. Most users
|
||||||
of the \module{zipfile} module will not need to create these, but
|
of the \module{zipfile} module will not need to create these, but
|
||||||
|
|
|
@ -26,7 +26,7 @@
|
||||||
relevant email and MIME related RFCs.
|
relevant email and MIME related RFCs.
|
||||||
\end{abstract}
|
\end{abstract}
|
||||||
|
|
||||||
% The ugly "%begin{latexonly}" pseudo-environment supresses the table
|
% The ugly "%begin{latexonly}" pseudo-environment suppresses the table
|
||||||
% of contents for HTML generation.
|
% of contents for HTML generation.
|
||||||
%
|
%
|
||||||
%begin{latexonly}
|
%begin{latexonly}
|
||||||
|
@ -39,7 +39,7 @@ parse, generate, and modify email messages, conforming to all the
|
||||||
relevant email and MIME related RFCs.
|
relevant email and MIME related RFCs.
|
||||||
|
|
||||||
This document describes version 3.0 of the \module{email} package, which is
|
This document describes version 3.0 of the \module{email} package, which is
|
||||||
distributed with Python 2.4 and is availble as a standalone distutils-based
|
distributed with Python 2.4 and is available as a standalone distutils-based
|
||||||
package for use with Python 2.3. \module{email} 3.0 is not compatible with
|
package for use with Python 2.3. \module{email} 3.0 is not compatible with
|
||||||
Python versions earlier than 2.3. For more information about the
|
Python versions earlier than 2.3. For more information about the
|
||||||
\module{email} package, including download links and mailing lists, see
|
\module{email} package, including download links and mailing lists, see
|
||||||
|
|
|
@ -10,7 +10,7 @@ and platform independent windowing toolkit, that is available to
|
||||||
Python programmers using the \refmodule{Tkinter} module, and its
|
Python programmers using the \refmodule{Tkinter} module, and its
|
||||||
extension, the \refmodule{Tix} module.
|
extension, the \refmodule{Tix} module.
|
||||||
|
|
||||||
The \refmodule{Tkinter} module is a thin object--oriented layer on top of
|
The \refmodule{Tkinter} module is a thin object-oriented layer on top of
|
||||||
Tcl/Tk. To use \refmodule{Tkinter}, you don't need to write Tcl code,
|
Tcl/Tk. To use \refmodule{Tkinter}, you don't need to write Tcl code,
|
||||||
but you will need to consult the Tk documentation, and occasionally
|
but you will need to consult the Tk documentation, and occasionally
|
||||||
the Tcl documentation. \refmodule{Tkinter} is a set of wrappers that
|
the Tcl documentation. \refmodule{Tkinter} is a set of wrappers that
|
||||||
|
@ -97,7 +97,7 @@ from Tkinter import *
|
||||||
\begin{classdesc}{Tk}{screenName=None, baseName=None, className='Tk', useTk=1}
|
\begin{classdesc}{Tk}{screenName=None, baseName=None, className='Tk', useTk=1}
|
||||||
The \class{Tk} class is instantiated without arguments.
|
The \class{Tk} class is instantiated without arguments.
|
||||||
This creates a toplevel widget of Tk which usually is the main window
|
This creates a toplevel widget of Tk which usually is the main window
|
||||||
of an appliation. Each instance has its own associated Tcl interpreter.
|
of an application. Each instance has its own associated Tcl interpreter.
|
||||||
% FIXME: The following keyword arguments are currently recognized:
|
% FIXME: The following keyword arguments are currently recognized:
|
||||||
\versionchanged[The \var{useTk} parameter was added]{2.4}
|
\versionchanged[The \var{useTk} parameter was added]{2.4}
|
||||||
\end{classdesc}
|
\end{classdesc}
|
||||||
|
@ -461,7 +461,7 @@ fred = Button(self, fg = "red", bg = "blue")
|
||||||
fred["fg"] = "red"
|
fred["fg"] = "red"
|
||||||
fred["bg"] = "blue"
|
fred["bg"] = "blue"
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
\item[Use the config() method to update multiple attrs subesequent to
|
\item[Use the config() method to update multiple attrs subsequent to
|
||||||
object creation]:
|
object creation]:
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
fred.config(fg = "red", bg = "blue")
|
fred.config(fg = "red", bg = "blue")
|
||||||
|
@ -812,7 +812,7 @@ For example:
|
||||||
self.button.bind("<Enter>", self.turnRed)
|
self.button.bind("<Enter>", self.turnRed)
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
|
|
||||||
Notice how the widget field of the event is being accesed in the
|
Notice how the widget field of the event is being accessed in the
|
||||||
\method{turnRed()} callback. This field contains the widget that
|
\method{turnRed()} callback. This field contains the widget that
|
||||||
caught the X event. The following table lists the other event fields
|
caught the X event. The following table lists the other event fields
|
||||||
you can access, and how they are denoted in Tk, which can be useful
|
you can access, and how they are denoted in Tk, which can be useful
|
||||||
|
@ -1218,7 +1218,7 @@ The \ulink{HList}
|
||||||
widget can be used to display any data that have a hierarchical
|
widget can be used to display any data that have a hierarchical
|
||||||
structure, for example, file system directory trees. The list entries
|
structure, for example, file system directory trees. The list entries
|
||||||
are indented and connected by branch lines according to their places
|
are indented and connected by branch lines according to their places
|
||||||
in the hierachy.
|
in the hierarchy.
|
||||||
\end{classdesc}
|
\end{classdesc}
|
||||||
|
|
||||||
% Python Demo of:
|
% Python Demo of:
|
||||||
|
@ -1243,7 +1243,7 @@ radiobuttons.
|
||||||
\begin{classdesc}{Tree}{}
|
\begin{classdesc}{Tree}{}
|
||||||
The \ulink{Tree}
|
The \ulink{Tree}
|
||||||
{http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixTree.htm}
|
{http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixTree.htm}
|
||||||
widget can be used to display hierachical data in a tree form. The
|
widget can be used to display hierarchical data in a tree form. The
|
||||||
user can adjust the view of the tree by opening or closing parts of
|
user can adjust the view of the tree by opening or closing parts of
|
||||||
the tree.
|
the tree.
|
||||||
\end{classdesc}
|
\end{classdesc}
|
||||||
|
@ -1359,7 +1359,7 @@ image types can be used to create images that consists of multiple
|
||||||
horizontal lines; each line is composed of a series of items (texts,
|
horizontal lines; each line is composed of a series of items (texts,
|
||||||
bitmaps, images or spaces) arranged from left to right. For example, a
|
bitmaps, images or spaces) arranged from left to right. For example, a
|
||||||
compound image can be used to display a bitmap and a text string
|
compound image can be used to display a bitmap and a text string
|
||||||
simutaneously in a Tk \class{Button} widget.
|
simultaneously in a Tk \class{Button} widget.
|
||||||
|
|
||||||
% Python Demo of:
|
% Python Demo of:
|
||||||
% \ulink{Compound Image In Buttons}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg.tcl}
|
% \ulink{Compound Image In Buttons}{http://tix.sourceforge.net/dist/current/demos/samples/CmpImg.tcl}
|
||||||
|
@ -1486,7 +1486,7 @@ used to configure the \code{image} option of the Tk and Tix widgets.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}{tix_option_get}{name}
|
\begin{methoddesc}{tix_option_get}{name}
|
||||||
Gets the options manitained by the Tix scheme mechanism.
|
Gets the options maintained by the Tix scheme mechanism.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}{tix_resetoptions}{newScheme, newFontSet\optional{,
|
\begin{methoddesc}{tix_resetoptions}{newScheme, newFontSet\optional{,
|
||||||
|
@ -1547,13 +1547,13 @@ are available:
|
||||||
\section{Idle \label{idle}}
|
\section{Idle \label{idle}}
|
||||||
|
|
||||||
%\declaremodule{standard}{idle}
|
%\declaremodule{standard}{idle}
|
||||||
%\modulesynopsis{A Python Integrated Developement Environment}
|
%\modulesynopsis{A Python Integrated Development Environment}
|
||||||
\moduleauthor{Guido van Rossum}{guido@Python.org}
|
\moduleauthor{Guido van Rossum}{guido@Python.org}
|
||||||
|
|
||||||
Idle is the Python IDE built with the \refmodule{Tkinter} GUI toolkit.
|
Idle is the Python IDE built with the \refmodule{Tkinter} GUI toolkit.
|
||||||
\index{Idle}
|
\index{Idle}
|
||||||
\index{Python Editor}
|
\index{Python Editor}
|
||||||
\index{Integrated Developement Environment}
|
\index{Integrated Development Environment}
|
||||||
|
|
||||||
|
|
||||||
IDLE has the following features:
|
IDLE has the following features:
|
||||||
|
|
|
@ -584,7 +584,7 @@ Set an attribute value from a string.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}[Element]{setAttributeNode}{newAttr}
|
\begin{methoddesc}[Element]{setAttributeNode}{newAttr}
|
||||||
Add a new attibute node to the element, replacing an existing
|
Add a new attribute node to the element, replacing an existing
|
||||||
attribute if necessary if the \member{name} attribute matches. If a
|
attribute if necessary if the \member{name} attribute matches. If a
|
||||||
replacement occurs, the old attribute node will be returned. If
|
replacement occurs, the old attribute node will be returned. If
|
||||||
\var{newAttr} is already in use, \exception{InuseAttributeErr} will be
|
\var{newAttr} is already in use, \exception{InuseAttributeErr} will be
|
||||||
|
@ -592,7 +592,7 @@ raised.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}[Element]{setAttributeNodeNS}{newAttr}
|
\begin{methoddesc}[Element]{setAttributeNodeNS}{newAttr}
|
||||||
Add a new attibute node to the element, replacing an existing
|
Add a new attribute node to the element, replacing an existing
|
||||||
attribute if necessary if the \member{namespaceURI} and
|
attribute if necessary if the \member{namespaceURI} and
|
||||||
\member{localName} attributes match. If a replacement occurs, the old
|
\member{localName} attributes match. If a replacement occurs, the old
|
||||||
attribute node will be returned. If \var{newAttr} is already in use,
|
attribute node will be returned. If \var{newAttr} is already in use,
|
||||||
|
@ -639,7 +639,7 @@ The length of the attribute list.
|
||||||
Return an attribute with a particular index. The order you get the
|
Return an attribute with a particular index. The order you get the
|
||||||
attributes in is arbitrary but will be consistent for the life of a
|
attributes in is arbitrary but will be consistent for the life of a
|
||||||
DOM. Each item is an attribute node. Get its value with the
|
DOM. Each item is an attribute node. Get its value with the
|
||||||
\member{value} attribbute.
|
\member{value} attribute.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
There are also experimental methods that give this class more mapping
|
There are also experimental methods that give this class more mapping
|
||||||
|
|
|
@ -110,7 +110,7 @@ dom3.unlink()
|
||||||
|
|
||||||
\method{unlink()} is a \module{xml.dom.minidom}-specific extension to
|
\method{unlink()} is a \module{xml.dom.minidom}-specific extension to
|
||||||
the DOM API. After calling \method{unlink()} on a node, the node and
|
the DOM API. After calling \method{unlink()} on a node, the node and
|
||||||
its descendents are essentially useless.
|
its descendants are essentially useless.
|
||||||
|
|
||||||
\begin{seealso}
|
\begin{seealso}
|
||||||
\seetitle[http://www.w3.org/TR/REC-DOM-Level-1/]{Document Object
|
\seetitle[http://www.w3.org/TR/REC-DOM-Level-1/]{Document Object
|
||||||
|
|
|
@ -151,7 +151,7 @@ to call the application event handler \var{async_dispatch} whenever events
|
||||||
are available. This will cause FrameWork window updates and the user
|
are available. This will cause FrameWork window updates and the user
|
||||||
interface to remain working during long computations, but will slow the
|
interface to remain working during long computations, but will slow the
|
||||||
interpreter down and may cause surprising results in non-reentrant code
|
interpreter down and may cause surprising results in non-reentrant code
|
||||||
(such as FrameWork itself). By default \var{async_dispatch} will immedeately
|
(such as FrameWork itself). By default \var{async_dispatch} will immediately
|
||||||
call \var{our_dispatch} but you may override this to handle only certain
|
call \var{our_dispatch} but you may override this to handle only certain
|
||||||
events asynchronously. Events you do not handle will be passed to Sioux
|
events asynchronously. Events you do not handle will be passed to Sioux
|
||||||
and such.
|
and such.
|
||||||
|
|
|
@ -59,7 +59,7 @@ for new files.
|
||||||
\platform{Mac}
|
\platform{Mac}
|
||||||
\modulesynopsis{Constant definitions for many Mac OS error codes.}
|
\modulesynopsis{Constant definitions for many Mac OS error codes.}
|
||||||
|
|
||||||
\module{macerrors} cotains constant definitions for many Mac OS error
|
\module{macerrors} contains constant definitions for many Mac OS error
|
||||||
codes.
|
codes.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -157,9 +157,9 @@ section \ref{defaults}.
|
||||||
|
|
||||||
\item
|
\item
|
||||||
When you waved the script icon over the \program{PythonInterpreter},
|
When you waved the script icon over the \program{PythonInterpreter},
|
||||||
the \program{PythonInterpreter} icon did not hilight. Most likely the
|
the \program{PythonInterpreter} icon did not highlight. Most likely
|
||||||
Creator code and document type is unset (or set incorrectly) -- this
|
the Creator code and document type is unset (or set incorrectly) --
|
||||||
often happens when a file originates on a non-Mac computer. See
|
this often happens when a file originates on a non-Mac computer. See
|
||||||
section \ref{creator-code} for more details.
|
section \ref{creator-code} for more details.
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
|
|
||||||
|
|
|
@ -1328,7 +1328,7 @@ new-style classes themselves.
|
||||||
|
|
||||||
\begin{methoddesc}[object]{__get__}{self, instance, owner}
|
\begin{methoddesc}[object]{__get__}{self, instance, owner}
|
||||||
Called to get the attribute of the owner class (class attribute access)
|
Called to get the attribute of the owner class (class attribute access)
|
||||||
or of an instance of that class (instance attribute acces).
|
or of an instance of that class (instance attribute access).
|
||||||
\var{owner} is always the owner class, while \var{instance} is the
|
\var{owner} is always the owner class, while \var{instance} is the
|
||||||
instance that the attribute was accessed through, or \code{None} when
|
instance that the attribute was accessed through, or \code{None} when
|
||||||
the attribute is accessed through the \var{owner}. This method should
|
the attribute is accessed through the \var{owner}. This method should
|
||||||
|
|
|
@ -262,7 +262,7 @@ entries of the dictionary: each key object is used as a key into the
|
||||||
dictionary to store the corresponding datum.
|
dictionary to store the corresponding datum.
|
||||||
|
|
||||||
Restrictions on the types of the key values are listed earlier in
|
Restrictions on the types of the key values are listed earlier in
|
||||||
section \ref{types}. (To summarize,the key type should be hashable,
|
section \ref{types}. (To summarize, the key type should be hashable,
|
||||||
which excludes all mutable objects.) Clashes between duplicate keys
|
which excludes all mutable objects.) Clashes between duplicate keys
|
||||||
are not detected; the last datum (textually rightmost in the display)
|
are not detected; the last datum (textually rightmost in the display)
|
||||||
stored for a given key value prevails.
|
stored for a given key value prevails.
|
||||||
|
|
|
@ -497,7 +497,7 @@ get executed.
|
||||||
\begin{notice}
|
\begin{notice}
|
||||||
In Python 2.2, the \keyword{yield} statement is only allowed
|
In Python 2.2, the \keyword{yield} statement is only allowed
|
||||||
when the \code{generators} feature has been enabled. It will always
|
when the \code{generators} feature has been enabled. It will always
|
||||||
be enabled in Python 2.3. This \code{__future__} import statment can
|
be enabled in Python 2.3. This \code{__future__} import statement can
|
||||||
be used to enable the feature:
|
be used to enable the feature:
|
||||||
|
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
|
|
|
@ -50,7 +50,7 @@
|
||||||
|
|
||||||
% Leave at least one blank line after this, to simplify ad-hoc tools
|
% Leave at least one blank line after this, to simplify ad-hoc tools
|
||||||
% that are sometimes used to massage these files.
|
% that are sometimes used to massage these files.
|
||||||
\modulesynopsis{This is a one-line descrition, for the chapter header.}
|
\modulesynopsis{This is a one-line description, for the chapter header.}
|
||||||
|
|
||||||
|
|
||||||
% ==== 2. ====
|
% ==== 2. ====
|
||||||
|
@ -110,7 +110,7 @@ once the \function{open()} function has been called.
|
||||||
% Exceptions are described using a ``excdesc'' block. This has only
|
% Exceptions are described using a ``excdesc'' block. This has only
|
||||||
% one parameter: the exception name. Exceptions defined as classes in
|
% one parameter: the exception name. Exceptions defined as classes in
|
||||||
% the source code should be documented using this environment, but
|
% the source code should be documented using this environment, but
|
||||||
% constructor parameters must be ommitted.
|
% constructor parameters must be omitted.
|
||||||
|
|
||||||
\begin{excdesc}{error}
|
\begin{excdesc}{error}
|
||||||
Exception raised when an operation fails for a Spam specific reason.
|
Exception raised when an operation fails for a Spam specific reason.
|
||||||
|
|
|
@ -3553,9 +3553,10 @@ Traceback (most recent call last):
|
||||||
__main__.MyError: 'oops!'
|
__main__.MyError: 'oops!'
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
|
|
||||||
In this example, the default \method{__init__} of \class{Exception} has
|
In this example, the default \method{__init__} of \class{Exception}
|
||||||
been overriden. The new behavior simply creates the \var{value} attribute.
|
has been overridden. The new behavior simply creates the \var{value}
|
||||||
This replaces the default behavior of creating the \var{args} attribute.
|
attribute. This replaces the default behavior of creating the
|
||||||
|
\var{args} attribute.
|
||||||
|
|
||||||
Exception classes can be defined which do anything any other class can
|
Exception classes can be defined which do anything any other class can
|
||||||
do, but are usually kept simple, often only offering a number of
|
do, but are usually kept simple, often only offering a number of
|
||||||
|
@ -4636,7 +4637,7 @@ for sending mail:
|
||||||
|
|
||||||
>>> import smtplib
|
>>> import smtplib
|
||||||
>>> server = smtplib.SMTP('localhost')
|
>>> server = smtplib.SMTP('localhost')
|
||||||
>>> server.sendmail('soothsayer@example.org', 'jceasar@example.org',
|
>>> server.sendmail('soothsayer@example.org', 'jcaesar@example.org',
|
||||||
"""To: jcaesar@example.org
|
"""To: jcaesar@example.org
|
||||||
From: soothsayer@example.org
|
From: soothsayer@example.org
|
||||||
|
|
||||||
|
|
|
@ -642,7 +642,7 @@ PythonWin also supports Windows CE; see the Python CE page at
|
||||||
\url{http://starship.python.net/crew/mhammond/ce/} for more
|
\url{http://starship.python.net/crew/mhammond/ce/} for more
|
||||||
information.
|
information.
|
||||||
|
|
||||||
Another new platform is Darwin/MacOS X; inital support for it is in
|
Another new platform is Darwin/MacOS X; initial support for it is in
|
||||||
Python 2.0. Dynamic loading works, if you specify ``configure
|
Python 2.0. Dynamic loading works, if you specify ``configure
|
||||||
--with-dyld --with-suffix=.x''. Consult the README in the Python
|
--with-dyld --with-suffix=.x''. Consult the README in the Python
|
||||||
source distribution for more instructions.
|
source distribution for more instructions.
|
||||||
|
@ -908,8 +908,8 @@ had to go through an arduous ritual of editing Makefiles and
|
||||||
configuration files, which only really work on Unix and leave Windows
|
configuration files, which only really work on Unix and leave Windows
|
||||||
and MacOS unsupported. Python users faced wildly differing
|
and MacOS unsupported. Python users faced wildly differing
|
||||||
installation instructions which varied between different extension
|
installation instructions which varied between different extension
|
||||||
packages, which made adminstering a Python installation something of a
|
packages, which made administering a Python installation something of
|
||||||
chore.
|
a chore.
|
||||||
|
|
||||||
The SIG for distribution utilities, shepherded by Greg Ward, has
|
The SIG for distribution utilities, shepherded by Greg Ward, has
|
||||||
created the Distutils, a system to make package installation much
|
created the Distutils, a system to make package installation much
|
||||||
|
|
|
@ -203,7 +203,7 @@ operations. The new magic method names are:
|
||||||
|
|
||||||
(The magic methods are named after the corresponding Fortran operators
|
(The magic methods are named after the corresponding Fortran operators
|
||||||
\code{.LT.}. \code{.LE.}, \&c. Numeric programmers are almost
|
\code{.LT.}. \code{.LE.}, \&c. Numeric programmers are almost
|
||||||
certainly quite familar with these names and will find them easy to
|
certainly quite familiar with these names and will find them easy to
|
||||||
remember.)
|
remember.)
|
||||||
|
|
||||||
Each of these magic methods is of the form \code{\var{method}(self,
|
Each of these magic methods is of the form \code{\var{method}(self,
|
||||||
|
|
|
@ -2223,7 +2223,7 @@ of the EMX port into CVS. (Contributed by Andrew MacIntyre.)
|
||||||
|
|
||||||
On MacOS, most toolbox modules have been weaklinked to improve
|
On MacOS, most toolbox modules have been weaklinked to improve
|
||||||
backward compatibility. This means that modules will no longer fail
|
backward compatibility. This means that modules will no longer fail
|
||||||
to load if a single routine is missing on the curent OS version.
|
to load if a single routine is missing on the current OS version.
|
||||||
Instead calling the missing routine will raise an exception.
|
Instead calling the missing routine will raise an exception.
|
||||||
(Contributed by Jack Jansen.)
|
(Contributed by Jack Jansen.)
|
||||||
|
|
||||||
|
|
|
@ -1493,7 +1493,7 @@ not.
|
||||||
In order to store cookies across sessions, two implementations of
|
In order to store cookies across sessions, two implementations of
|
||||||
cookie jars are provided: one that stores cookies in the Netscape
|
cookie jars are provided: one that stores cookies in the Netscape
|
||||||
format so applications can use the Mozilla or Lynx cookie files, and
|
format so applications can use the Mozilla or Lynx cookie files, and
|
||||||
one that stores cookies in the same format as the Perl libwww libary.
|
one that stores cookies in the same format as the Perl libwww library.
|
||||||
|
|
||||||
\module{urllib2} has been changed to interact with \module{cookielib}:
|
\module{urllib2} has been changed to interact with \module{cookielib}:
|
||||||
\class{HTTPCookieProcessor} manages a cookie jar that is used when
|
\class{HTTPCookieProcessor} manages a cookie jar that is used when
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue