Rob W. W. Hooft's spelling fixes for the Library Reference. I hope
SourceForge doesn't choke on this batch :-) I'm not entirely sure this is 100% correct. The patch changes an \index{persistency} to \index{presistence}, and I don't know what \index{} does. But it seems to do so persi--er, consistently, so I hope it isn't a problem.
This commit is contained in:
parent
0e19e76aba
commit
f8316638af
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
The modules described in this chapter provide interfaces to operating
|
The modules described in this chapter provide interfaces to operating
|
||||||
system features that are available on (almost) all operating systems,
|
system features that are available on (almost) all operating systems,
|
||||||
such as files and a clock. The interfaces are generally modelled
|
such as files and a clock. The interfaces are generally modeled
|
||||||
after the \UNIX{} or C interfaces, but they are available on most
|
after the \UNIX{} or C interfaces, but they are available on most
|
||||||
other systems as well. Here's an overview:
|
other systems as well. Here's an overview:
|
||||||
|
|
||||||
|
|
|
@ -18,7 +18,7 @@ control characters as follows:
|
||||||
\lineii{NUL}{}
|
\lineii{NUL}{}
|
||||||
\lineii{SOH}{Start of heading, console interrupt}
|
\lineii{SOH}{Start of heading, console interrupt}
|
||||||
\lineii{STX}{Start of text}
|
\lineii{STX}{Start of text}
|
||||||
\lineii{ETX}{Ennd of text}
|
\lineii{ETX}{End of text}
|
||||||
\lineii{EOT}{End of transmission}
|
\lineii{EOT}{End of transmission}
|
||||||
\lineii{ENQ}{Enquiry, goes with \constant{ACK} flow control}
|
\lineii{ENQ}{Enquiry, goes with \constant{ACK} flow control}
|
||||||
\lineii{ACK}{Acknowledgement}
|
\lineii{ACK}{Acknowledgement}
|
||||||
|
|
|
@ -107,7 +107,7 @@ def handle_write(self):
|
||||||
Each time through the \method{select()} loop, the set of sockets
|
Each time through the \method{select()} loop, the set of sockets
|
||||||
is scanned, and this method is called to see if there is any
|
is scanned, and this method is called to see if there is any
|
||||||
interest in writing. The default method simply returns \code{1},
|
interest in writing. The default method simply returns \code{1},
|
||||||
indiciating that by default, all channels will be interested.
|
indicating that by default, all channels will be interested.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
In addition, there are the basic methods needed to construct and
|
In addition, there are the basic methods needed to construct and
|
||||||
|
|
|
@ -151,7 +151,7 @@ Return the maximum peak-peak value in the sound fragment.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{mul}{fragment, width, factor}
|
\begin{funcdesc}{mul}{fragment, width, factor}
|
||||||
Return a fragment that has all samples in the original framgent
|
Return a fragment that has all samples in the original fragment
|
||||||
multiplied by the floating-point value \var{factor}. Overflow is
|
multiplied by the floating-point value \var{factor}. Overflow is
|
||||||
silently ignored.
|
silently ignored.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
@ -161,7 +161,7 @@ silently ignored.
|
||||||
Convert the frame rate of the input fragment.
|
Convert the frame rate of the input fragment.
|
||||||
|
|
||||||
\var{state} is a tuple containing the state of the converter. The
|
\var{state} is a tuple containing the state of the converter. The
|
||||||
converter returns a tupl \code{(\var{newfragment}, \var{newstate})},
|
converter returns a tuple \code{(\var{newfragment}, \var{newstate})},
|
||||||
and \var{newstate} should be passed to the next call of
|
and \var{newstate} should be passed to the next call of
|
||||||
\function{ratecv()}.
|
\function{ratecv()}.
|
||||||
|
|
||||||
|
|
|
@ -90,7 +90,7 @@ input data.
|
||||||
|
|
||||||
\begin{memberdesc}{wfile}
|
\begin{memberdesc}{wfile}
|
||||||
Contains the output stream for writing a response back to the client.
|
Contains the output stream for writing a response back to the client.
|
||||||
Proper adherance to the HTTP protocol must be used when writing
|
Proper adherence to the HTTP protocol must be used when writing
|
||||||
to this stream.
|
to this stream.
|
||||||
\end{memberdesc}
|
\end{memberdesc}
|
||||||
|
|
||||||
|
@ -115,7 +115,7 @@ variable. For example, \code{'Python/1.4'}.
|
||||||
Specifies a format string for building an error response to the
|
Specifies a format string for building an error response to the
|
||||||
client. It uses parenthesized, keyed format specifiers, so the
|
client. It uses parenthesized, keyed format specifiers, so the
|
||||||
format operand must be a dictionary. The \var{code} key should
|
format operand must be a dictionary. The \var{code} key should
|
||||||
be an integer, specifing the numeric HTTP error code value.
|
be an integer, specifying the numeric HTTP error code value.
|
||||||
\var{message} should be a string containing a (detailed) error
|
\var{message} should be a string containing a (detailed) error
|
||||||
message of what occurred, and \var{explain} should be an
|
message of what occurred, and \var{explain} should be an
|
||||||
explanation of the error code number. Default \var{message}
|
explanation of the error code number. Default \var{message}
|
||||||
|
|
|
@ -11,7 +11,7 @@ between binary and various \ASCII{}-encoded binary
|
||||||
representations. Normally, you will not use these functions directly
|
representations. Normally, you will not use these functions directly
|
||||||
but use wrapper modules like \refmodule{uu}\refstmodindex{uu} or
|
but use wrapper modules like \refmodule{uu}\refstmodindex{uu} or
|
||||||
\refmodule{binhex}\refstmodindex{binhex} instead, this module solely
|
\refmodule{binhex}\refstmodindex{binhex} instead, this module solely
|
||||||
exists because bit-manipuation of large amounts of data is slow in
|
exists because bit-manipulation of large amounts of data is slow in
|
||||||
Python.
|
Python.
|
||||||
|
|
||||||
The \module{binascii} module defines the following functions:
|
The \module{binascii} module defines the following functions:
|
||||||
|
|
|
@ -86,7 +86,7 @@ will return I/O errors.
|
||||||
\end{datadesc}
|
\end{datadesc}
|
||||||
|
|
||||||
\begin{datadesc}{ERROR}
|
\begin{datadesc}{ERROR}
|
||||||
An error aoocurred while trying to read the disc or its table of
|
An error occurred while trying to read the disc or its table of
|
||||||
contents.
|
contents.
|
||||||
\end{datadesc}
|
\end{datadesc}
|
||||||
|
|
||||||
|
@ -194,7 +194,7 @@ track.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}[CD player]{playtrackabs}{track, minutes, seconds, frames, play}
|
\begin{methoddesc}[CD player]{playtrackabs}{track, minutes, seconds, frames, play}
|
||||||
Like \method{play()}, except that playing begins at the spcified
|
Like \method{play()}, except that playing begins at the specified
|
||||||
absolute time and ends at the end of the specified track.
|
absolute time and ends at the end of the specified track.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
|
|
|
@ -56,7 +56,7 @@ Exception raised when a specified section is not found.
|
||||||
\end{excdesc}
|
\end{excdesc}
|
||||||
|
|
||||||
\begin{excdesc}{DuplicateSectionError}
|
\begin{excdesc}{DuplicateSectionError}
|
||||||
Exception raised when mutliple sections with the same name are found,
|
Exception raised when multiple sections with the same name are found,
|
||||||
or if \method{add_section()} is called with the name of a section that
|
or if \method{add_section()} is called with the name of a section that
|
||||||
is already present.
|
is already present.
|
||||||
\end{excdesc}
|
\end{excdesc}
|
||||||
|
|
|
@ -104,7 +104,7 @@ If the submitted form data contains more than one field with the same
|
||||||
name, the object retrieved by \samp{form[\var{key}]} is not a
|
name, the object retrieved by \samp{form[\var{key}]} is not a
|
||||||
\class{FieldStorage} or \class{MiniFieldStorage}
|
\class{FieldStorage} or \class{MiniFieldStorage}
|
||||||
instance but a list of such instances. If you expect this possibility
|
instance but a list of such instances. If you expect this possibility
|
||||||
(i.e., when your HTML form comtains multiple fields with the same
|
(i.e., when your HTML form contains multiple fields with the same
|
||||||
name), use the \function{type()} function to determine whether you
|
name), use the \function{type()} function to determine whether you
|
||||||
have a single instance or a list of instances. For example, here's
|
have a single instance or a list of instances. For example, here's
|
||||||
code that concatenates any number of username fields, separated by
|
code that concatenates any number of username fields, separated by
|
||||||
|
@ -131,7 +131,7 @@ If a field represents an uploaded file, the value attribute reads the
|
||||||
entire file in memory as a string. This may not be what you want.
|
entire file in memory as a string. This may not be what you want.
|
||||||
You can test for an uploaded file by testing either the filename
|
You can test for an uploaded file by testing either the filename
|
||||||
attribute or the file attribute. You can then read the data at
|
attribute or the file attribute. You can then read the data at
|
||||||
leasure from the file attribute:
|
leisure from the file attribute:
|
||||||
|
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
fileitem = form["userfile"]
|
fileitem = form["userfile"]
|
||||||
|
|
|
@ -11,7 +11,7 @@
|
||||||
|
|
||||||
The \module{CGIHTTPServer} module defines a request-handler class,
|
The \module{CGIHTTPServer} module defines a request-handler class,
|
||||||
interface compatible with
|
interface compatible with
|
||||||
\class{BaseHTTPServer.BaseHTTPRequestHandler} and inherits behaviour
|
\class{BaseHTTPServer.BaseHTTPRequestHandler} and inherits behavior
|
||||||
from \class{SimpleHTTPServer.SimpleHTTPRequestHandler} but can also
|
from \class{SimpleHTTPServer.SimpleHTTPRequestHandler} but can also
|
||||||
run CGI scripts.
|
run CGI scripts.
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,7 @@ A chunk has the following structure:
|
||||||
\lineiii{4}{4}{Size of chunk in big-endian byte order, not including the
|
\lineiii{4}{4}{Size of chunk in big-endian byte order, not including the
|
||||||
header}
|
header}
|
||||||
\lineiii{8}{\var{n}}{Data bytes, where \var{n} is the size given in
|
\lineiii{8}{\var{n}}{Data bytes, where \var{n} is the size given in
|
||||||
the preceeding field}
|
the preceding field}
|
||||||
\lineiii{8 + \var{n}}{0 or 1}{Pad byte needed if \var{n} is odd and
|
\lineiii{8 + \var{n}}{0 or 1}{Pad byte needed if \var{n} is odd and
|
||||||
chunk alignment is used}
|
chunk alignment is used}
|
||||||
\end{tableiii}
|
\end{tableiii}
|
||||||
|
|
|
@ -103,7 +103,7 @@ The return value can be used to decide whether to use
|
||||||
Execute a code object.
|
Execute a code object.
|
||||||
When an exception occurs, \method{showtraceback()} is called to
|
When an exception occurs, \method{showtraceback()} is called to
|
||||||
display a traceback. All exceptions are caught except
|
display a traceback. All exceptions are caught except
|
||||||
\exception{SystemExit}, which is allowed to propogate.
|
\exception{SystemExit}, which is allowed to propagate.
|
||||||
|
|
||||||
A note about \exception{KeyboardInterrupt}: this exception may occur
|
A note about \exception{KeyboardInterrupt}: this exception may occur
|
||||||
elsewhere in this code, and may not always be caught. The caller
|
elsewhere in this code, and may not always be caught. The caller
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
\section{\module{curses} ---
|
\section{\module{curses} ---
|
||||||
Terminal independant console handling}
|
Terminal independent console handling}
|
||||||
|
|
||||||
\declaremodule{extension}{curses}
|
\declaremodule{extension}{curses}
|
||||||
\sectionauthor{Moshe Zadka}{mzadka@geocities.com}
|
\sectionauthor{Moshe Zadka}{mzadka@geocities.com}
|
||||||
|
@ -243,7 +243,7 @@ allow only 7-bit chars.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{mouseinterval}{interval}
|
\begin{funcdesc}{mouseinterval}{interval}
|
||||||
Sets the maximum time in millisecondsthat can elapse between press and
|
Sets the maximum time in milliseconds that can elapse between press and
|
||||||
release events in order for them to be recognized as a click, and
|
release events in order for them to be recognized as a click, and
|
||||||
returns the previous interval value. The default value is 200 msec,
|
returns the previous interval value. The default value is 200 msec,
|
||||||
or one fifth of a second.
|
or one fifth of a second.
|
||||||
|
@ -846,7 +846,7 @@ the window.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}{timeout}{delay}
|
\begin{methoddesc}{timeout}{delay}
|
||||||
Sets blocking or non-blocking read behaviour for the window. If
|
Sets blocking or non-blocking read behavior for the window. If
|
||||||
\var{delay} is negative, blocking read is used, which will wait
|
\var{delay} is negative, blocking read is used, which will wait
|
||||||
indefinitely for input). If \var{delay} is zero, then non-blocking
|
indefinitely for input). If \var{delay} is zero, then non-blocking
|
||||||
read is used, and -1 will be returned by \method{getch()} if no input
|
read is used, and -1 will be returned by \method{getch()} if no input
|
||||||
|
|
|
@ -22,7 +22,7 @@ a future version should change it to return a tuple?)
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{opendir}{path}
|
\begin{funcdesc}{opendir}{path}
|
||||||
Same as \function{listdir()}. Defined for backwards compatability.
|
Same as \function{listdir()}. Defined for backwards compatibility.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{annotate}{head, list}
|
\begin{funcdesc}{annotate}{head, list}
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
The \module{dl} module defines an interface to the
|
The \module{dl} module defines an interface to the
|
||||||
\cfunction{dlopen()} function, which is the most common interface on
|
\cfunction{dlopen()} function, which is the most common interface on
|
||||||
\UNIX{} platforms for handling dynamically linked libraries. It allows
|
\UNIX{} platforms for handling dynamically linked libraries. It allows
|
||||||
the program to call arbitary functions in such a library.
|
the program to call arbitrary functions in such a library.
|
||||||
|
|
||||||
\strong{Note:} This module will not work unless
|
\strong{Note:} This module will not work unless
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
|
@ -23,7 +23,7 @@ The \module{dl} module defines the following function:
|
||||||
Open a shared object file, and return a handle. Mode
|
Open a shared object file, and return a handle. Mode
|
||||||
signifies late binding (\constant{RTLD_LAZY}) or immediate binding
|
signifies late binding (\constant{RTLD_LAZY}) or immediate binding
|
||||||
(\constant{RTLD_NOW}). Default is \constant{RTLD_LAZY}. Note that some
|
(\constant{RTLD_NOW}). Default is \constant{RTLD_LAZY}. Note that some
|
||||||
sytems do not support \constant{RTLD_NOW}.
|
systems do not support \constant{RTLD_NOW}.
|
||||||
|
|
||||||
Return value is a \pytype{dlobject}.
|
Return value is a \pytype{dlobject}.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
@ -44,7 +44,7 @@ determine if the system supports immediate binding.
|
||||||
The \module{dl} module defines the following exception:
|
The \module{dl} module defines the following exception:
|
||||||
|
|
||||||
\begin{excdesc}{error}
|
\begin{excdesc}{error}
|
||||||
Exception raised when an error has occured inside the dynamic loading
|
Exception raised when an error has occurred inside the dynamic loading
|
||||||
and linking routines.
|
and linking routines.
|
||||||
\end{excdesc}
|
\end{excdesc}
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
This module supports two interface definitions, each with mulitple
|
This module supports two interface definitions, each with multiple
|
||||||
implementations. The \emph{formatter} interface is used by the
|
implementations. The \emph{formatter} interface is used by the
|
||||||
\class{HTMLParser} class of the \refmodule{htmllib} module, and the
|
\class{HTMLParser} class of the \refmodule{htmllib} module, and the
|
||||||
\emph{writer} interface is required by the formatter interface.
|
\emph{writer} interface is required by the formatter interface.
|
||||||
|
@ -75,8 +75,8 @@ not broken. The arguments and keywords are passed on to the writer's
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}[formatter]{add_flowing_data}{data}
|
\begin{methoddesc}[formatter]{add_flowing_data}{data}
|
||||||
Provide data which should be formatted with collapsed whitespaces.
|
Provide data which should be formatted with collapsed whitespace.
|
||||||
Whitespace from preceeding and successive calls to
|
Whitespace from preceding and successive calls to
|
||||||
\method{add_flowing_data()} is considered as well when the whitespace
|
\method{add_flowing_data()} is considered as well when the whitespace
|
||||||
collapse is performed. The data which is passed to this method is
|
collapse is performed. The data which is passed to this method is
|
||||||
expected to be word-wrapped by the output device. Note that any
|
expected to be word-wrapped by the output device. Note that any
|
||||||
|
@ -106,7 +106,7 @@ value, are used to compute label values. Each character in the format
|
||||||
string is copied to the label value, with some characters recognized
|
string is copied to the label value, with some characters recognized
|
||||||
to indicate a transform on the counter value. Specifically, the
|
to indicate a transform on the counter value. Specifically, the
|
||||||
character \character{1} represents the counter value formatter as an
|
character \character{1} represents the counter value formatter as an
|
||||||
arabic number, the characters \character{A} and \character{a}
|
Arabic number, the characters \character{A} and \character{a}
|
||||||
represent alphabetic representations of the counter value in upper and
|
represent alphabetic representations of the counter value in upper and
|
||||||
lower case, respectively, and \character{I} and \character{i}
|
lower case, respectively, and \character{I} and \character{i}
|
||||||
represent the counter value in Roman numerals, in upper and lower
|
represent the counter value in Roman numerals, in upper and lower
|
||||||
|
@ -264,7 +264,7 @@ Break the current line.
|
||||||
|
|
||||||
\begin{methoddesc}[writer]{send_paragraph}{blankline}
|
\begin{methoddesc}[writer]{send_paragraph}{blankline}
|
||||||
Produce a paragraph separation of at least \var{blankline} blank
|
Produce a paragraph separation of at least \var{blankline} blank
|
||||||
lines, or the equivelent. The \var{blankline} value will be an
|
lines, or the equivalent. The \var{blankline} value will be an
|
||||||
integer. Note that the implementation will receive a call to
|
integer. Note that the implementation will receive a call to
|
||||||
\method{send_line_break()} before this call if a line break is needed;
|
\method{send_line_break()} before this call if a line break is needed;
|
||||||
this method should not include ending the last line of the paragraph.
|
this method should not include ending the last line of the paragraph.
|
||||||
|
|
|
@ -265,6 +265,6 @@ Close the connection unilaterally. This should not be applied to an
|
||||||
already closed connection (e.g.\ after a successful call to
|
already closed connection (e.g.\ after a successful call to
|
||||||
\method{quit()}. After this call the \class{FTP} instance should not
|
\method{quit()}. After this call the \class{FTP} instance should not
|
||||||
be used any more (i.e., after a call to \method{close()} or
|
be used any more (i.e., after a call to \method{close()} or
|
||||||
\method{quit()} you cannot reopen the connection by issueing another
|
\method{quit()} you cannot reopen the connection by issuing another
|
||||||
\method{login()} method).
|
\method{login()} method).
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
|
@ -124,9 +124,9 @@ nested.
|
||||||
|
|
||||||
\begin{methoddesc}{save_end}{}
|
\begin{methoddesc}{save_end}{}
|
||||||
Ends buffering character data and returns all data saved since the
|
Ends buffering character data and returns all data saved since the
|
||||||
preceeding call to \method{save_bgn()}. If the \member{nofill} flag is
|
preceding call to \method{save_bgn()}. If the \member{nofill} flag is
|
||||||
false, whitespace is collapsed to single spaces. A call to this
|
false, whitespace is collapsed to single spaces. A call to this
|
||||||
method without a preceeding call to \method{save_bgn()} will raise a
|
method without a preceding call to \method{save_bgn()} will raise a
|
||||||
\exception{TypeError} exception.
|
\exception{TypeError} exception.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
|
|
|
@ -46,7 +46,7 @@ interlacing, hence the name.
|
||||||
|
|
||||||
\begin{funcdesc}{grey2mono}{image, width, height, threshold}
|
\begin{funcdesc}{grey2mono}{image, width, height, threshold}
|
||||||
Convert a 8-bit deep greyscale image to a 1-bit deep image by
|
Convert a 8-bit deep greyscale image to a 1-bit deep image by
|
||||||
tresholding all the pixels. The resulting image is tightly packed and
|
thresholding all the pixels. The resulting image is tightly packed and
|
||||||
is probably only useful as an argument to \function{mono2grey()}.
|
is probably only useful as an argument to \function{mono2grey()}.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
|
|
|
@ -42,7 +42,7 @@ exception.
|
||||||
\end{excdesc}
|
\end{excdesc}
|
||||||
|
|
||||||
\begin{excdesc}{IMAP4.readonly}
|
\begin{excdesc}{IMAP4.readonly}
|
||||||
This exception is raised when a writeable mailbox has its status changed by the server. This is a
|
This exception is raised when a writable mailbox has its status changed by the server. This is a
|
||||||
sub-class of \exception{IMAP4.error}. Some other client now has write permission,
|
sub-class of \exception{IMAP4.error}. Some other client now has write permission,
|
||||||
and the mailbox will need to be re-opened to re-obtain write permission.
|
and the mailbox will need to be re-opened to re-obtain write permission.
|
||||||
\end{excdesc}
|
\end{excdesc}
|
||||||
|
|
|
@ -52,7 +52,7 @@ returned by \function{get_suffixes()} describing the kind of module found.
|
||||||
If the module does not live in a file, the returned \var{file} is
|
If the module does not live in a file, the returned \var{file} is
|
||||||
\code{None}, \var{filename} is the empty string, and the
|
\code{None}, \var{filename} is the empty string, and the
|
||||||
\var{description} tuple contains empty strings for its suffix and
|
\var{description} tuple contains empty strings for its suffix and
|
||||||
mode; the module type is as indicate in parentheses dabove. If the
|
mode; the module type is as indicate in parentheses above. If the
|
||||||
search is unsuccessful, \exception{ImportError} is raised. Other
|
search is unsuccessful, \exception{ImportError} is raised. Other
|
||||||
exceptions indicate problems with the arguments or environment.
|
exceptions indicate problems with the arguments or environment.
|
||||||
|
|
||||||
|
@ -187,7 +187,7 @@ don't like that and may raise an exception. The \var{pathname}
|
||||||
argument must point to the shared library. The \var{name} argument is
|
argument must point to the shared library. The \var{name} argument is
|
||||||
used to construct the name of the initialization function: an external
|
used to construct the name of the initialization function: an external
|
||||||
C function called \samp{init\var{name}()} in the shared library is
|
C function called \samp{init\var{name}()} in the shared library is
|
||||||
called. The optional \var{file} argment is ignored. (Note: using
|
called. The optional \var{file} argument is ignored. (Note: using
|
||||||
shared libraries is highly system dependent, and not all systems
|
shared libraries is highly system dependent, and not all systems
|
||||||
support it.)
|
support it.)
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
|
@ -25,7 +25,7 @@ trace; some provide interfaces that are specific to particular
|
||||||
operating systems, such as access to specific hardware; others provide
|
operating systems, such as access to specific hardware; others provide
|
||||||
interfaces that are
|
interfaces that are
|
||||||
specific to a particular application domain, like the World-Wide Web.
|
specific to a particular application domain, like the World-Wide Web.
|
||||||
Some modules are avaiable in all versions and ports of Python; others
|
Some modules are available in all versions and ports of Python; others
|
||||||
are only available when the underlying system supports or requires
|
are only available when the underlying system supports or requires
|
||||||
them; yet others are available only when a particular configuration
|
them; yet others are available only when a particular configuration
|
||||||
option was chosen at the time when Python was compiled and installed.
|
option was chosen at the time when Python was compiled and installed.
|
||||||
|
|
|
@ -258,7 +258,7 @@ generally okay, and Python will use whatever locale is set,
|
||||||
\samp{C}.
|
\samp{C}.
|
||||||
|
|
||||||
The \function{setlocale()} function in the \module{locale} module
|
The \function{setlocale()} function in the \module{locale} module
|
||||||
gives the Python progammer the impression that you can manipulate the
|
gives the Python programmer the impression that you can manipulate the
|
||||||
\constant{LC_NUMERIC} locale setting, but this not the case at the C
|
\constant{LC_NUMERIC} locale setting, but this not the case at the C
|
||||||
level: C code will always find that the \constant{LC_NUMERIC} locale
|
level: C code will always find that the \constant{LC_NUMERIC} locale
|
||||||
setting is \samp{C}. This is because too much would break when the
|
setting is \samp{C}. This is because too much would break when the
|
||||||
|
|
|
@ -19,7 +19,7 @@ does).\footnote{The name of this module stems from a bit of
|
||||||
convert some data from internal to external form (in an RPC buffer for
|
convert some data from internal to external form (in an RPC buffer for
|
||||||
instance) and ``unmarshalling'' for the reverse process.}
|
instance) and ``unmarshalling'' for the reverse process.}
|
||||||
|
|
||||||
This is not a general ``persistency'' module. For general persistency
|
This is not a general ``persistence'' module. For general persistence
|
||||||
and transfer of Python objects through RPC calls, see the modules
|
and transfer of Python objects through RPC calls, see the modules
|
||||||
\refmodule{pickle} and \refmodule{shelve}. The \module{marshal} module exists
|
\refmodule{pickle} and \refmodule{shelve}. The \module{marshal} module exists
|
||||||
mainly to support reading and writing the ``pseudo-compiled'' code for
|
mainly to support reading and writing the ``pseudo-compiled'' code for
|
||||||
|
|
|
@ -12,7 +12,7 @@ straightforward:\ use the \function{new()} to create an md5 object.
|
||||||
You can now feed this object with arbitrary strings using the
|
You can now feed this object with arbitrary strings using the
|
||||||
\method{update()} method, and at any point you can ask it for the
|
\method{update()} method, and at any point you can ask it for the
|
||||||
\dfn{digest} (a strong kind of 128-bit checksum,
|
\dfn{digest} (a strong kind of 128-bit checksum,
|
||||||
a.k.a. ``fingerprint'') of the contatenation of the strings fed to it
|
a.k.a. ``fingerprint'') of the concatenation of the strings fed to it
|
||||||
so far using the \method{digest()} method.
|
so far using the \method{digest()} method.
|
||||||
\index{checksum!MD5}
|
\index{checksum!MD5}
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
\modulesynopsis{Lock and queue for mutual exclusion.}
|
\modulesynopsis{Lock and queue for mutual exclusion.}
|
||||||
|
|
||||||
The \module{mutex} defines a class that allows mutual-exclusion
|
The \module{mutex} defines a class that allows mutual-exclusion
|
||||||
via aquiring and releasing locks. It does not require (or imply)
|
via acquiring and releasing locks. It does not require (or imply)
|
||||||
threading or multi-tasking, though it could be useful for
|
threading or multi-tasking, though it could be useful for
|
||||||
those purposes.
|
those purposes.
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@ the first queue entry is removed and its
|
||||||
implying it now has the lock.
|
implying it now has the lock.
|
||||||
|
|
||||||
Of course, no multi-threading is implied -- hence the funny interface
|
Of course, no multi-threading is implied -- hence the funny interface
|
||||||
for lock, where a function is called once the lock is aquired.
|
for lock, where a function is called once the lock is acquired.
|
||||||
\end{classdesc}
|
\end{classdesc}
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@ The \class{netrc} class parses and encapsulates the netrc file format
|
||||||
used by the \UNIX{} \program{ftp} program and other FTP clients.
|
used by the \UNIX{} \program{ftp} program and other FTP clients.
|
||||||
|
|
||||||
\begin{classdesc}{netrc}{\optional{file}}
|
\begin{classdesc}{netrc}{\optional{file}}
|
||||||
A \class{netrc} instance or subclass instance enapsulates data from
|
A \class{netrc} instance or subclass instance encapsulates data from
|
||||||
a netrc file. The initialization argument, if present, specifies the
|
a netrc file. The initialization argument, if present, specifies the
|
||||||
file to parse. If no argument is given, the file \file{.netrc} in the
|
file to parse. If no argument is given, the file \file{.netrc} in the
|
||||||
user's home directory will be read. Parse errors will raise
|
user's home directory will be read. Parse errors will raise
|
||||||
|
|
|
@ -19,7 +19,7 @@ The \module{nis} module defines the following functions:
|
||||||
Return the match for \var{key} in map \var{mapname}, or raise an
|
Return the match for \var{key} in map \var{mapname}, or raise an
|
||||||
error (\exception{nis.error}) if there is none.
|
error (\exception{nis.error}) if there is none.
|
||||||
Both should be strings, \var{key} is 8-bit clean.
|
Both should be strings, \var{key} is 8-bit clean.
|
||||||
Return value is an arbitary array of bytes (i.e., may contain \code{NULL}
|
Return value is an arbitrary array of bytes (i.e., may contain \code{NULL}
|
||||||
and other joys).
|
and other joys).
|
||||||
|
|
||||||
Note that \var{mapname} is first checked if it is an alias to another name.
|
Note that \var{mapname} is first checked if it is an alias to another name.
|
||||||
|
@ -28,7 +28,7 @@ Note that \var{mapname} is first checked if it is an alias to another name.
|
||||||
\begin{funcdesc}{cat}{mapname}
|
\begin{funcdesc}{cat}{mapname}
|
||||||
Return a dictionary mapping \var{key} to \var{value} such that
|
Return a dictionary mapping \var{key} to \var{value} such that
|
||||||
\code{match(\var{key}, \var{mapname})==\var{value}}.
|
\code{match(\var{key}, \var{mapname})==\var{value}}.
|
||||||
Note that both keys and values of the dictionary are arbitary
|
Note that both keys and values of the dictionary are arbitrary
|
||||||
arrays of bytes.
|
arrays of bytes.
|
||||||
|
|
||||||
Note that \var{mapname} is first checked if it is an alias to another name.
|
Note that \var{mapname} is first checked if it is an alias to another name.
|
||||||
|
|
|
@ -325,7 +325,7 @@ Availability: \UNIX{}, Windows.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{fpathconf}{fd, name}
|
\begin{funcdesc}{fpathconf}{fd, name}
|
||||||
Return system configration information relevant to an open file.
|
Return system configuration information relevant to an open file.
|
||||||
\var{name} specifies the configuration value to retrieve; it may be a
|
\var{name} specifies the configuration value to retrieve; it may be a
|
||||||
string which is the name of a defined system value; these names are
|
string which is the name of a defined system value; these names are
|
||||||
specified in a number of standards (\POSIX.1, Unix95, Unix98, and
|
specified in a number of standards (\POSIX.1, Unix95, Unix98, and
|
||||||
|
@ -575,7 +575,7 @@ is \code{0777} (octal).
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{pathconf}{path, name}
|
\begin{funcdesc}{pathconf}{path, name}
|
||||||
Return system configration information relevant to a named file.
|
Return system configuration information relevant to a named file.
|
||||||
\var{name} specifies the configuration value to retrieve; it may be a
|
\var{name} specifies the configuration value to retrieve; it may be a
|
||||||
string which is the name of a defined system value; these names are
|
string which is the name of a defined system value; these names are
|
||||||
specified in a number of standards (\POSIX.1, Unix95, Unix98, and
|
specified in a number of standards (\POSIX.1, Unix95, Unix98, and
|
||||||
|
@ -983,7 +983,7 @@ Availability: \UNIX{}.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
|
|
||||||
\subsection{Miscellanenous System Information \label{os-path}}
|
\subsection{Miscellaneous System Information \label{os-path}}
|
||||||
|
|
||||||
|
|
||||||
\begin{funcdesc}{confstr}{name}
|
\begin{funcdesc}{confstr}{name}
|
||||||
|
|
|
@ -64,7 +64,7 @@ built by NASA Ames\index{NASA} (to get it, send e-mail to
|
||||||
\code{panel-request@nas.nasa.gov}).
|
\code{panel-request@nas.nasa.gov}).
|
||||||
All access to it should be done through the standard module
|
All access to it should be done through the standard module
|
||||||
\code{panel}\refstmodindex{panel},
|
\code{panel}\refstmodindex{panel},
|
||||||
which transparantly exports most functions from
|
which transparently exports most functions from
|
||||||
\code{pnl}
|
\code{pnl}
|
||||||
but redefines
|
but redefines
|
||||||
\code{pnl.dopanel()}.
|
\code{pnl.dopanel()}.
|
||||||
|
|
|
@ -593,7 +593,7 @@ information; this parallels the use of the \keyword{def} statement to
|
||||||
define both types of elements.
|
define both types of elements.
|
||||||
|
|
||||||
Most of the accessor functions are declared in \class{SuiteInfoBase}
|
Most of the accessor functions are declared in \class{SuiteInfoBase}
|
||||||
and do not need to be overriden by subclasses. More importantly, the
|
and do not need to be overridden by subclasses. More importantly, the
|
||||||
extraction of most information from a parse tree is handled through a
|
extraction of most information from a parse tree is handled through a
|
||||||
method called by the \class{SuiteInfoBase} constructor. The example
|
method called by the \class{SuiteInfoBase} constructor. The example
|
||||||
code for most of the classes is clear when read alongside the formal
|
code for most of the classes is clear when read alongside the formal
|
||||||
|
@ -684,7 +684,7 @@ a class definition, function or method definition, or
|
||||||
something else. For the definition statements, the name of the
|
something else. For the definition statements, the name of the
|
||||||
element defined is extracted and a representation object
|
element defined is extracted and a representation object
|
||||||
appropriate to the definition is created with the defining subtree
|
appropriate to the definition is created with the defining subtree
|
||||||
passed as an argument to the constructor. The repesentation objects
|
passed as an argument to the constructor. The representation objects
|
||||||
are stored in instance variables and may be retrieved by name using
|
are stored in instance variables and may be retrieved by name using
|
||||||
the appropriate accessor methods.
|
the appropriate accessor methods.
|
||||||
|
|
||||||
|
|
|
@ -153,7 +153,7 @@ exists in the user's home directory or in the current directory, it is
|
||||||
read in and executed as if it had been typed at the debugger prompt.
|
read in and executed as if it had been typed at the debugger prompt.
|
||||||
This is particularly useful for aliases. If both files exist, the one
|
This is particularly useful for aliases. If both files exist, the one
|
||||||
in the home directory is read first and aliases defined there can be
|
in the home directory is read first and aliases defined there can be
|
||||||
overriden by the local file.
|
overridden by the local file.
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
\modulesynopsis{Convert Python objects to streams of bytes and back.}
|
\modulesynopsis{Convert Python objects to streams of bytes and back.}
|
||||||
% Substantial improvements by Jim Kerr <jbkerr@sr.hp.com>.
|
% Substantial improvements by Jim Kerr <jbkerr@sr.hp.com>.
|
||||||
|
|
||||||
\index{persistency}
|
\index{persistence}
|
||||||
\indexii{persistent}{objects}
|
\indexii{persistent}{objects}
|
||||||
\indexii{serializing}{objects}
|
\indexii{serializing}{objects}
|
||||||
\indexii{marshalling}{objects}
|
\indexii{marshalling}{objects}
|
||||||
|
@ -17,7 +17,7 @@ The \module{pickle} module implements a basic but powerful algorithm
|
||||||
for ``pickling'' (a.k.a.\ serializing, marshalling or flattening)
|
for ``pickling'' (a.k.a.\ serializing, marshalling or flattening)
|
||||||
nearly arbitrary Python objects. This is the act of converting
|
nearly arbitrary Python objects. This is the act of converting
|
||||||
objects to a stream of bytes (and back: ``unpickling''). This is a
|
objects to a stream of bytes (and back: ``unpickling''). This is a
|
||||||
more primitive notion than persistency --- although \module{pickle}
|
more primitive notion than persistence --- although \module{pickle}
|
||||||
reads and writes file objects, it does not handle the issue of naming
|
reads and writes file objects, it does not handle the issue of naming
|
||||||
persistent objects, nor the (even more complicated) area of concurrent
|
persistent objects, nor the (even more complicated) area of concurrent
|
||||||
access to persistent objects. The \module{pickle} module can
|
access to persistent objects. The \module{pickle} module can
|
||||||
|
@ -92,7 +92,7 @@ great need for it right now (as long as \refmodule{marshal} continues
|
||||||
to be used for reading and writing code objects), and at least this
|
to be used for reading and writing code objects), and at least this
|
||||||
avoids the possibility of smuggling Trojan horses into a program.
|
avoids the possibility of smuggling Trojan horses into a program.
|
||||||
|
|
||||||
For the benefit of persistency modules written using \module{pickle}, it
|
For the benefit of persistence modules written using \module{pickle}, it
|
||||||
supports the notion of a reference to an object outside the pickled
|
supports the notion of a reference to an object outside the pickled
|
||||||
data stream. Such objects are referenced by a name, which is an
|
data stream. Such objects are referenced by a name, which is an
|
||||||
arbitrary string of printable \ASCII{} characters. The resolution of
|
arbitrary string of printable \ASCII{} characters. The resolution of
|
||||||
|
@ -250,7 +250,7 @@ Apart from the \class{Pickler} and \class{Unpickler} classes, the
|
||||||
module defines the following functions, and an exception:
|
module defines the following functions, and an exception:
|
||||||
|
|
||||||
\begin{funcdesc}{dump}{object, file\optional{, bin}}
|
\begin{funcdesc}{dump}{object, file\optional{, bin}}
|
||||||
Write a pickled representation of \var{obect} to the open file object
|
Write a pickled representation of \var{object} to the open file object
|
||||||
\var{file}. This is equivalent to
|
\var{file}. This is equivalent to
|
||||||
\samp{Pickler(\var{file}, \var{bin}).dump(\var{object})}.
|
\samp{Pickler(\var{file}, \var{bin}).dump(\var{object})}.
|
||||||
If the optional \var{bin} argument is present and nonzero, the binary
|
If the optional \var{bin} argument is present and nonzero, the binary
|
||||||
|
@ -380,7 +380,7 @@ cannot be subclassed. This should not be an issue in most cases.
|
||||||
|
|
||||||
The format of the pickle data is identical to that produced using the
|
The format of the pickle data is identical to that produced using the
|
||||||
\refmodule{pickle} module, so it is possible to use \refmodule{pickle} and
|
\refmodule{pickle} module, so it is possible to use \refmodule{pickle} and
|
||||||
\module{cPickle} interchangably with existing pickles.
|
\module{cPickle} interchangeably with existing pickles.
|
||||||
|
|
||||||
(Since the pickle data format is actually a tiny stack-oriented
|
(Since the pickle data format is actually a tiny stack-oriented
|
||||||
programming language, and there are some freedoms in the encodings of
|
programming language, and there are some freedoms in the encodings of
|
||||||
|
|
|
@ -62,7 +62,7 @@ reads its standard input), \code{'f'} (which means the commands reads
|
||||||
a given file on the command line) or \code{'.'} (which means the commands
|
a given file on the command line) or \code{'.'} (which means the commands
|
||||||
reads no input, and hence must be first.)
|
reads no input, and hence must be first.)
|
||||||
|
|
||||||
Similarily, the second letter can be either of \code{'-'} (which means
|
Similarly, the second letter can be either of \code{'-'} (which means
|
||||||
the command writes to standard output), \code{'f'} (which means the
|
the command writes to standard output), \code{'f'} (which means the
|
||||||
command writes a file on the command line) or \code{'.'} (which means
|
command writes a file on the command line) or \code{'.'} (which means
|
||||||
the command does not write anything, and hence must be last.)
|
the command does not write anything, and hence must be last.)
|
||||||
|
|
|
@ -13,7 +13,7 @@
|
||||||
|
|
||||||
This module defines a class, \class{POP3}, which encapsulates a
|
This module defines a class, \class{POP3}, which encapsulates a
|
||||||
connection to an POP3 server and implements protocol as defined in
|
connection to an POP3 server and implements protocol as defined in
|
||||||
\rfc{1725}. The \class{POP3} class supports both the minmal and
|
\rfc{1725}. The \class{POP3} class supports both the minimal and
|
||||||
optional command sets.
|
optional command sets.
|
||||||
|
|
||||||
A single class is provided by the \module{poplib} module:
|
A single class is provided by the \module{poplib} module:
|
||||||
|
@ -46,7 +46,7 @@ Returns the greeting string sent by the POP3 server.
|
||||||
|
|
||||||
|
|
||||||
\begin{methoddesc}{user}{username}
|
\begin{methoddesc}{user}{username}
|
||||||
Send user commad, response should indicate that a password is required.
|
Send user command, response should indicate that a password is required.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}{pass_}{password}
|
\begin{methoddesc}{pass_}{password}
|
||||||
|
|
|
@ -98,7 +98,7 @@ arbitrary number of rotors.
|
||||||
The original Enigma cipher was broken in 1944. % XXX: Is this right?
|
The original Enigma cipher was broken in 1944. % XXX: Is this right?
|
||||||
The version implemented here is probably a good deal more difficult to crack
|
The version implemented here is probably a good deal more difficult to crack
|
||||||
(especially if you use many rotors), but it won't be impossible for
|
(especially if you use many rotors), but it won't be impossible for
|
||||||
a truly skilful and determined attacker to break the cipher. So if you want
|
a truly skillful and determined attacker to break the cipher. So if you want
|
||||||
to keep the NSA out of your files, this rotor cipher may well be unsafe, but
|
to keep the NSA out of your files, this rotor cipher may well be unsafe, but
|
||||||
for discouraging casual snooping through your files, it will probably be
|
for discouraging casual snooping through your files, it will probably be
|
||||||
just fine, and may be somewhat safer than using the \UNIX{} \program{crypt}
|
just fine, and may be somewhat safer than using the \UNIX{} \program{crypt}
|
||||||
|
|
|
@ -92,6 +92,6 @@ the event will not be attempted in future calls to \method{run()}.
|
||||||
|
|
||||||
If a sequence of events takes longer to run than the time available
|
If a sequence of events takes longer to run than the time available
|
||||||
before the next event, the scheduler will simply fall behind. No
|
before the next event, the scheduler will simply fall behind. No
|
||||||
events will be dropped; the calling code is responsible for cancelling
|
events will be dropped; the calling code is responsible for canceling
|
||||||
events which are no longer pertinent.
|
events which are no longer pertinent.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
|
@ -34,7 +34,7 @@ Entity references of the form \samp{\&\var{name};}.
|
||||||
\item
|
\item
|
||||||
SGML comments of the form \samp{<!--\var{text}-->}. Note that
|
SGML comments of the form \samp{<!--\var{text}-->}. Note that
|
||||||
spaces, tabs, and newlines are allowed between the trailing
|
spaces, tabs, and newlines are allowed between the trailing
|
||||||
\samp{>} and the immediately preceeding \samp{--}.
|
\samp{>} and the immediately preceding \samp{--}.
|
||||||
|
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
\end{classdesc}
|
\end{classdesc}
|
||||||
|
|
|
@ -11,7 +11,7 @@ algorithm,\index{Secure Hash Algorithm} known as SHA. It is used in
|
||||||
the same way as the \refmodule{md5} module:\ use the \function{new()}
|
the same way as the \refmodule{md5} module:\ use the \function{new()}
|
||||||
to create an sha object, then feed this object with arbitrary strings
|
to create an sha object, then feed this object with arbitrary strings
|
||||||
using the \method{update()} method, and at any point you can ask it
|
using the \method{update()} method, and at any point you can ask it
|
||||||
for the \dfn{digest} of the contatenation of the strings fed to it
|
for the \dfn{digest} of the concatenation of the strings fed to it
|
||||||
so far.\index{checksum!SHA} SHA digests are 160 bits instead of 128
|
so far.\index{checksum!SHA} SHA digests are 160 bits instead of 128
|
||||||
bits.
|
bits.
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
\section{\module{shelve} ---
|
\section{\module{shelve} ---
|
||||||
Python object persistency}
|
Python object persistence}
|
||||||
|
|
||||||
\declaremodule{standard}{shelve}
|
\declaremodule{standard}{shelve}
|
||||||
\modulesynopsis{Python object persistency.}
|
\modulesynopsis{Python object persistence.}
|
||||||
|
|
||||||
|
|
||||||
A ``shelf'' is a persistent, dictionary-like object. The difference
|
A ``shelf'' is a persistent, dictionary-like object. The difference
|
||||||
|
|
|
@ -21,7 +21,7 @@ read characters from. It must be a file- or stream-like object with
|
||||||
input will be taken from \code{sys.stdin}. The second optional
|
input will be taken from \code{sys.stdin}. The second optional
|
||||||
argument is a filename string, which sets the initial value of the
|
argument is a filename string, which sets the initial value of the
|
||||||
\member{infile} member. If the stream argument is omitted or
|
\member{infile} member. If the stream argument is omitted or
|
||||||
equal to \code{sys.stdin}, this second argument defauilts to ``stdin''.
|
equal to \code{sys.stdin}, this second argument defaults to ``stdin''.
|
||||||
\end{classdesc}
|
\end{classdesc}
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -56,7 +56,7 @@ only the main thread can set a new signal handler, and the main thread
|
||||||
will be the only one to receive signals (this is enforced by the
|
will be the only one to receive signals (this is enforced by the
|
||||||
Python \module{signal} module, even if the underlying thread
|
Python \module{signal} module, even if the underlying thread
|
||||||
implementation supports sending signals to individual threads). This
|
implementation supports sending signals to individual threads). This
|
||||||
means that signals can't be used as a means of interthread
|
means that signals can't be used as a means of inter-thread
|
||||||
communication. Use locks instead.
|
communication. Use locks instead.
|
||||||
|
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
|
|
|
@ -56,7 +56,7 @@ A nice selection of exceptions is defined as well:
|
||||||
|
|
||||||
\begin{excdesc}{SMTPRecipientsRefused}
|
\begin{excdesc}{SMTPRecipientsRefused}
|
||||||
All recipient addresses refused. The errors for each recipient are
|
All recipient addresses refused. The errors for each recipient are
|
||||||
accessable through the attribute \member{recipients}, which is a
|
accessible through the attribute \member{recipients}, which is a
|
||||||
dictionary of exactly the same sort as \method{SMTP.sendmail()}
|
dictionary of exactly the same sort as \method{SMTP.sendmail()}
|
||||||
returns.
|
returns.
|
||||||
\end{excdesc}
|
\end{excdesc}
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
The modules described in this chapter provide interfaces to operating
|
The modules described in this chapter provide interfaces to operating
|
||||||
system features that are available on selected operating systems only.
|
system features that are available on selected operating systems only.
|
||||||
The interfaces are generally modelled after the \UNIX{} or \C{}
|
The interfaces are generally modeled after the \UNIX{} or \C{}
|
||||||
interfaces but they are available on some other systems as well
|
interfaces but they are available on some other systems as well
|
||||||
(e.g. Windows or NT). Here's an overview:
|
(e.g. Windows or NT). Here's an overview:
|
||||||
|
|
||||||
|
|
|
@ -47,7 +47,7 @@ Free nodes available to non-super user.
|
||||||
\end{datadesc}
|
\end{datadesc}
|
||||||
|
|
||||||
\begin{datadesc}{F_FLAG}
|
\begin{datadesc}{F_FLAG}
|
||||||
Flags. System dependant: see \cfunction{statvfs()} man page.
|
Flags. System dependent: see \cfunction{statvfs()} man page.
|
||||||
\end{datadesc}
|
\end{datadesc}
|
||||||
|
|
||||||
\begin{datadesc}{F_NAMEMAX}
|
\begin{datadesc}{F_NAMEMAX}
|
||||||
|
|
|
@ -259,7 +259,7 @@ Return the total line height of the current font.
|
||||||
\begin{funcdesc}{textbreak}{str, width}
|
\begin{funcdesc}{textbreak}{str, width}
|
||||||
Return the number of characters of the string that fit into a space of
|
Return the number of characters of the string that fit into a space of
|
||||||
\var{width}
|
\var{width}
|
||||||
bits wide when drawn in the curent font.
|
bits wide when drawn in the current font.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
\begin{funcdesc}{textwidth}{str}
|
\begin{funcdesc}{textwidth}{str}
|
||||||
|
|
|
@ -95,7 +95,7 @@ Rewind the file pointer to the beginning of the audio stream.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
The following two methods define a term ``position'' which is compatible
|
The following two methods define a term ``position'' which is compatible
|
||||||
between them, and is otherwise implementation dependant.
|
between them, and is otherwise implementation dependent.
|
||||||
|
|
||||||
\begin{methoddesc}[AU_read]{setpos}{pos}
|
\begin{methoddesc}[AU_read]{setpos}{pos}
|
||||||
Set the file pointer to the specified position.
|
Set the file pointer to the specified position.
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
This module provides constants which represent the numeric values of
|
This module provides constants which represent the numeric values of
|
||||||
internal nodes of the parse tree. Unlike most Python constants, these
|
internal nodes of the parse tree. Unlike most Python constants, these
|
||||||
use lower-case names. Refer to the file \file{Grammar/Grammar} in the
|
use lower-case names. Refer to the file \file{Grammar/Grammar} in the
|
||||||
Python distribution for the defintions of the names in the context of
|
Python distribution for the definitions of the names in the context of
|
||||||
the language grammar. The specific numeric values which the names map
|
the language grammar. The specific numeric values which the names map
|
||||||
to may change between Python versions.
|
to may change between Python versions.
|
||||||
|
|
||||||
|
|
|
@ -140,7 +140,7 @@ Read until one from a list of a regular expressions matches.
|
||||||
The first argument is a list of regular expressions, either
|
The first argument is a list of regular expressions, either
|
||||||
compiled (\class{re.RegexObject} instances) or uncompiled (strings).
|
compiled (\class{re.RegexObject} instances) or uncompiled (strings).
|
||||||
The optional second argument is a timeout, in seconds; the default
|
The optional second argument is a timeout, in seconds; the default
|
||||||
is to block indefinately.
|
is to block indefinitely.
|
||||||
|
|
||||||
Return a tuple of three items: the index in the list of the
|
Return a tuple of three items: the index in the list of the
|
||||||
first regular expression that matches; the match object
|
first regular expression that matches; the match object
|
||||||
|
@ -153,7 +153,7 @@ far (may be the empty string if a timeout happened).
|
||||||
|
|
||||||
If a regular expression ends with a greedy match (e.g. \regexp{.*})
|
If a regular expression ends with a greedy match (e.g. \regexp{.*})
|
||||||
or if more than one expression can match the same input, the
|
or if more than one expression can match the same input, the
|
||||||
results are undeterministic, and may depend on the I/O timing.
|
results are indeterministic, and may depend on the I/O timing.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -26,7 +26,7 @@ useful on some platforms.
|
||||||
bufsize\optional{, suffix}}}}
|
bufsize\optional{, suffix}}}}
|
||||||
Return a file (or file-like) object that can be used as a temporary
|
Return a file (or file-like) object that can be used as a temporary
|
||||||
storage area. The file is created in the most secure manner available
|
storage area. The file is created in the most secure manner available
|
||||||
in the appporpriate temporary directory for the host platform. Under
|
in the appropriate temporary directory for the host platform. Under
|
||||||
\UNIX, the directory entry to the file is removed so that it is secure
|
\UNIX, the directory entry to the file is removed so that it is secure
|
||||||
against attacks which involve creating symbolic links to the file or
|
against attacks which involve creating symbolic links to the file or
|
||||||
replacing the file with a symbolic link to some other file. For other
|
replacing the file with a symbolic link to some other file. For other
|
||||||
|
|
|
@ -86,7 +86,7 @@ is a tuple of 9 integers:
|
||||||
\lineiii{3}{hour}{range [0,23]}
|
\lineiii{3}{hour}{range [0,23]}
|
||||||
\lineiii{4}{minute}{range [0,59]}
|
\lineiii{4}{minute}{range [0,59]}
|
||||||
\lineiii{5}{second}{range [0,61]; see \strong{(1)} in \function{strftime()} description}
|
\lineiii{5}{second}{range [0,61]; see \strong{(1)} in \function{strftime()} description}
|
||||||
\lineiii{6}{weekday}{range [0,6], monday is 0}
|
\lineiii{6}{weekday}{range [0,6], Monday is 0}
|
||||||
\lineiii{7}{Julian day}{range [1,366]}
|
\lineiii{7}{Julian day}{range [1,366]}
|
||||||
\lineiii{8}{daylight savings flag}{0, 1 or -1; see below}
|
\lineiii{8}{daylight savings flag}{0, 1 or -1; see below}
|
||||||
\end{tableiii}
|
\end{tableiii}
|
||||||
|
@ -125,7 +125,7 @@ the same name, there is no trailing newline.
|
||||||
|
|
||||||
\begin{funcdesc}{clock}{}
|
\begin{funcdesc}{clock}{}
|
||||||
Return the current CPU time as a floating point number expressed in
|
Return the current CPU time as a floating point number expressed in
|
||||||
seconds. The precision, and in fact the very definiton of the meaning
|
seconds. The precision, and in fact the very definition of the meaning
|
||||||
of ``CPU time''\index{CPU time}, depends on that of the C function
|
of ``CPU time''\index{CPU time}, depends on that of the C function
|
||||||
of the same name, but in any case, this is the function to use for
|
of the same name, but in any case, this is the function to use for
|
||||||
benchmarking\index{benchmarking} Python or timing algorithms.
|
benchmarking\index{benchmarking} Python or timing algorithms.
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
|
|
||||||
This module provides constants which represent the numeric values of
|
This module provides constants which represent the numeric values of
|
||||||
leaf nodes of the parse tree (terminal tokens). Refer to the file
|
leaf nodes of the parse tree (terminal tokens). Refer to the file
|
||||||
\file{Grammar/Grammar} in the Python distribution for the defintions
|
\file{Grammar/Grammar} in the Python distribution for the definitions
|
||||||
of the names in the context of the language grammar. The specific
|
of the names in the context of the language grammar. The specific
|
||||||
numeric values which the names map to may change between Python
|
numeric values which the names map to may change between Python
|
||||||
versions.
|
versions.
|
||||||
|
|
|
@ -104,7 +104,7 @@ Format a stack trace and the exception information. The arguments
|
||||||
have the same meaning as the corresponding arguments to
|
have the same meaning as the corresponding arguments to
|
||||||
\function{print_exception()}. The return value is a list of strings,
|
\function{print_exception()}. The return value is a list of strings,
|
||||||
each ending in a newline and some containing internal newlines. When
|
each ending in a newline and some containing internal newlines. When
|
||||||
these lines are contatenated and printed, exactly the same text is
|
these lines are concatenated and printed, exactly the same text is
|
||||||
printed as does \function{print_exception()}.
|
printed as does \function{print_exception()}.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
|
|
|
@ -134,7 +134,7 @@ code object (these are now accessible as attributes:
|
||||||
|
|
||||||
\item[\module{lockfile}]
|
\item[\module{lockfile}]
|
||||||
--- wrapper around FCNTL file locking (use
|
--- wrapper around FCNTL file locking (use
|
||||||
\function{fcntl.lockf()}/\function{flock()} intead; see \refmodule{fcntl})
|
\function{fcntl.lockf()}/\function{flock()} instead; see \refmodule{fcntl})
|
||||||
|
|
||||||
\item[\module{newdir}]
|
\item[\module{newdir}]
|
||||||
--- New \function{dir()} function (the standard \function{dir()} is
|
--- New \function{dir()} function (the standard \function{dir()} is
|
||||||
|
|
|
@ -261,7 +261,7 @@ manipulation is in module \refmodule{urlparse}\refstmodindex{urlparse}.
|
||||||
\sectionauthor{Skip Montanaro}{skip@mojam.com}
|
\sectionauthor{Skip Montanaro}{skip@mojam.com}
|
||||||
|
|
||||||
\class{URLopener} and \class{FancyURLopener} objects have the
|
\class{URLopener} and \class{FancyURLopener} objects have the
|
||||||
following methodsL
|
following methods.
|
||||||
|
|
||||||
\begin{methoddesc}{open}{fullurl\optional{, data}}
|
\begin{methoddesc}{open}{fullurl\optional{, data}}
|
||||||
Open \var{fullurl} using the appropriate protocol. This method sets
|
Open \var{fullurl} using the appropriate protocol. This method sets
|
||||||
|
|
|
@ -12,7 +12,7 @@
|
||||||
|
|
||||||
|
|
||||||
This module defines a standard interface to break URL strings up in
|
This module defines a standard interface to break URL strings up in
|
||||||
components (addessing scheme, network location, path etc.), to combine
|
components (addressing scheme, network location, path etc.), to combine
|
||||||
the components back into a URL string, and to convert a ``relative
|
the components back into a URL string, and to convert a ``relative
|
||||||
URL'' to an absolute URL given a ``base URL.''
|
URL'' to an absolute URL given a ``base URL.''
|
||||||
|
|
||||||
|
|
|
@ -23,7 +23,7 @@ import user
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
|
|
||||||
The \module{user} module looks for a file \file{.pythonrc.py} in the user's
|
The \module{user} module looks for a file \file{.pythonrc.py} in the user's
|
||||||
home directory and if it can be opened, exececutes it (using
|
home directory and if it can be opened, executes it (using
|
||||||
\function{execfile()}\bifuncindex{execfile}) in its own (i.e. the
|
\function{execfile()}\bifuncindex{execfile}) in its own (i.e. the
|
||||||
module \module{user}'s) global namespace. Errors during this phase
|
module \module{user}'s) global namespace. Errors during this phase
|
||||||
are not caught; that's up to the program that imports the
|
are not caught; that's up to the program that imports the
|
||||||
|
|
|
@ -8,11 +8,11 @@ This module defines a class that acts as a wrapper around
|
||||||
dictionary objects. It is a useful base class for
|
dictionary objects. It is a useful base class for
|
||||||
your own dictionary-like classes, which can inherit from
|
your own dictionary-like classes, which can inherit from
|
||||||
them and override existing methods or add new ones. In this way one
|
them and override existing methods or add new ones. In this way one
|
||||||
can add new behaviours to dictionaries.
|
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{intialdata}}
|
\begin{classdesc}{UserDict}{\optional{initialdata}}
|
||||||
Return a class instance that simulates a dictionary. The instance's
|
Return a class instance 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
|
||||||
|
@ -42,7 +42,7 @@ This module defines a class that acts as a wrapper around
|
||||||
list objects. It is a useful base class for
|
list objects. It is a useful base class for
|
||||||
your own list-like classes, which can inherit from
|
your own list-like classes, which can inherit from
|
||||||
them and override existing methods or add new ones. In this way one
|
them and override existing methods or add new ones. In this way one
|
||||||
can add new behaviours to lists.
|
can add new behaviors to lists.
|
||||||
|
|
||||||
The \module{UserList} module defines the \class{UserList} class:
|
The \module{UserList} module defines the \class{UserList} class:
|
||||||
|
|
||||||
|
@ -77,7 +77,7 @@ This module defines a class that acts as a wrapper around
|
||||||
string objects. It is a useful base class for
|
string objects. It is a useful base class for
|
||||||
your own string-like classes, which can inherit from
|
your own string-like classes, which can inherit from
|
||||||
them and override existing methods or add new ones. In this way one
|
them and override existing methods or add new ones. In this way one
|
||||||
can add new behaviours to strings.
|
can add new behaviors to strings.
|
||||||
|
|
||||||
The \module{UserString} module defines the \class{UserString} class:
|
The \module{UserString} module defines the \class{UserString} class:
|
||||||
|
|
||||||
|
@ -109,5 +109,5 @@ keys. The main intention of this class is to serve as an educational
|
||||||
example for inheritance and necessity to remove (override) the
|
example for inheritance and necessity to remove (override) the
|
||||||
\function{__hash__} method in order to trap attempts to use a
|
\function{__hash__} method in order to trap attempts to use a
|
||||||
mutable object as dictionary key, which would be otherwise very
|
mutable object as dictionary key, which would be otherwise very
|
||||||
errorprone and hard to track down.
|
error prone and hard to track down.
|
||||||
\end{classdesc}
|
\end{classdesc}
|
||||||
|
|
|
@ -102,7 +102,7 @@ Raise an error.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
The following two methods define a term ``position'' which is compatible
|
The following two methods define a term ``position'' which is compatible
|
||||||
between them, and is otherwise implementation dependant.
|
between them, and is otherwise implementation dependent.
|
||||||
|
|
||||||
\begin{methoddesc}[Wave_read]{setpos}{pos}
|
\begin{methoddesc}[Wave_read]{setpos}{pos}
|
||||||
Set the file pointer to the specified position.
|
Set the file pointer to the specified position.
|
||||||
|
|
|
@ -53,7 +53,7 @@ two functions and several constants.
|
||||||
image of a WAV file.
|
image of a WAV file.
|
||||||
|
|
||||||
\strong{Note:} This module does not support playing from a memory
|
\strong{Note:} This module does not support playing from a memory
|
||||||
image asynchonously, so a combination of this flag and
|
image asynchronously, so a combination of this flag and
|
||||||
\constant{SND_ASYNC} will raise a \exception{RuntimeError}.
|
\constant{SND_ASYNC} will raise a \exception{RuntimeError}.
|
||||||
\end{datadesc}
|
\end{datadesc}
|
||||||
|
|
||||||
|
|
|
@ -197,7 +197,7 @@ handled separately if it is located at the start of the document.
|
||||||
This method is called when a syntax error is encountered. The
|
This method is called when a syntax error is encountered. The
|
||||||
\var{message} is a description of what was wrong. The default method
|
\var{message} is a description of what was wrong. The default method
|
||||||
raises a \exception{RuntimeError} exception. If this method is
|
raises a \exception{RuntimeError} exception. If this method is
|
||||||
overridden, it is permissable for it to return. This method is only
|
overridden, it is permissible for it to return. This method is only
|
||||||
called when the error can be recovered from. Unrecoverable errors
|
called when the error can be recovered from. Unrecoverable errors
|
||||||
raise a \exception{RuntimeError} without first calling
|
raise a \exception{RuntimeError} without first calling
|
||||||
\method{syntax_error()}.
|
\method{syntax_error()}.
|
||||||
|
|
Loading…
Reference in New Issue