diff options
Diffstat (limited to 'Doc/lib')
| -rw-r--r-- | Doc/lib/lib.tex | 3 | ||||
| -rw-r--r-- | Doc/lib/libcollections.tex | 19 | ||||
| -rw-r--r-- | Doc/lib/libcontextlib.tex | 2 | ||||
| -rw-r--r-- | Doc/lib/libfuncs.tex | 9 | ||||
| -rw-r--r-- | Doc/lib/libgopherlib.tex | 36 | ||||
| -rw-r--r-- | Doc/lib/libhttplib.tex | 4 | ||||
| -rw-r--r-- | Doc/lib/libimageop.tex | 100 | ||||
| -rw-r--r-- | Doc/lib/liboptparse.tex | 4 | ||||
| -rw-r--r-- | Doc/lib/librgbimg.tex | 54 | ||||
| -rw-r--r-- | Doc/lib/libsets.tex | 0 | ||||
| -rw-r--r-- | Doc/lib/liburllib.tex | 13 | ||||
| -rw-r--r-- | Doc/lib/liburllib2.tex | 16 |
12 files changed, 26 insertions, 234 deletions
diff --git a/Doc/lib/lib.tex b/Doc/lib/lib.tex index c9cf38d..cb82246 100644 --- a/Doc/lib/lib.tex +++ b/Doc/lib/lib.tex @@ -292,7 +292,6 @@ and how to embed it in other applications. \input{liburllib2} \input{libhttplib} \input{libftplib} -\input{libgopherlib} \input{libpoplib} \input{libimaplib} \input{libnntplib} @@ -317,13 +316,11 @@ and how to embed it in other applications. \input{libmm} % Multimedia Services \input{libaudioop} -\input{libimageop} \input{libaifc} \input{libsunau} \input{libwave} \input{libchunk} \input{libcolorsys} -\input{librgbimg} \input{libimghdr} \input{libsndhdr} \input{libossaudiodev} diff --git a/Doc/lib/libcollections.tex b/Doc/lib/libcollections.tex index 33ace7d..fc44e01 100644 --- a/Doc/lib/libcollections.tex +++ b/Doc/lib/libcollections.tex @@ -378,14 +378,25 @@ Point(x=11, y=22) The use cases are the same as those for tuples. The named factories assign meaning to each tuple position and allow for more readable, self-documenting code. Named tuples can also be used to assign field names - to tuples - returned by the \module{csv} or \module{sqlite3} modules. For example: + to tuples returned by the \module{csv} or \module{sqlite3} modules. + For example: \begin{verbatim} +from itertools import starmap import csv EmployeeRecord = NamedTuple('EmployeeRecord', 'name age title department paygrade') -for tup in csv.reader(open("employees.csv", "rb")): - print EmployeeRecord(*tup) +for record in starmap(EmployeeRecord, csv.reader(open("employees.csv", "rb"))): + print record +\end{verbatim} + + To cast an individual record stored as \class{list}, \class{tuple}, or some other + iterable type, use the star-operator to unpack the values: + + \begin{verbatim} +>>> Color = NamedTuple('Color', 'name code') +>>> m = dict(red=1, green=2, blue=3) +>>> print Color(*m.popitem()) +Color(name='blue', code=3) \end{verbatim} \end{funcdesc} diff --git a/Doc/lib/libcontextlib.tex b/Doc/lib/libcontextlib.tex index 72bf537..0ac5442 100644 --- a/Doc/lib/libcontextlib.tex +++ b/Doc/lib/libcontextlib.tex @@ -111,7 +111,7 @@ And lets you write code like this: \begin{verbatim} from __future__ import with_statement from contextlib import closing -import codecs +import urllib with closing(urllib.urlopen('http://www.python.org')) as page: for line in page: diff --git a/Doc/lib/libfuncs.tex b/Doc/lib/libfuncs.tex index c02f6f1..5e6e2a0 100644 --- a/Doc/lib/libfuncs.tex +++ b/Doc/lib/libfuncs.tex @@ -118,15 +118,6 @@ def my_import(name): \constant{False}]{2.3} \end{funcdesc} -\begin{funcdesc}{callable}{object} - Return true if the \var{object} argument appears callable, false if - not. If this returns true, it is still possible that a call fails, - but if it is false, calling \var{object} will never succeed. Note - that classes are callable (calling a class returns a new instance); - class instances are callable if they have a \method{__call__()} - method. -\end{funcdesc} - \begin{funcdesc}{chr}{i} Return a string of one character whose \ASCII{} code is the integer \var{i}. For example, \code{chr(97)} returns the string \code{'a'}. diff --git a/Doc/lib/libgopherlib.tex b/Doc/lib/libgopherlib.tex deleted file mode 100644 index 4b22605..0000000 --- a/Doc/lib/libgopherlib.tex +++ /dev/null @@ -1,36 +0,0 @@ -\section{\module{gopherlib} --- - Gopher protocol client} - -\declaremodule{standard}{gopherlib} -\modulesynopsis{Gopher protocol client (requires sockets).} - -\deprecated{2.5}{The \code{gopher} protocol is not in active use - anymore.} - -\indexii{Gopher}{protocol} - -This module provides a minimal implementation of client side of the -Gopher protocol. It is used by the module \refmodule{urllib} to -handle URLs that use the Gopher protocol. - -The module defines the following functions: - -\begin{funcdesc}{send_selector}{selector, host\optional{, port}} -Send a \var{selector} string to the gopher server at \var{host} and -\var{port} (default \code{70}). Returns an open file object from -which the returned document can be read. -\end{funcdesc} - -\begin{funcdesc}{send_query}{selector, query, host\optional{, port}} -Send a \var{selector} string and a \var{query} string to a gopher -server at \var{host} and \var{port} (default \code{70}). Returns an -open file object from which the returned document can be read. -\end{funcdesc} - -Note that the data returned by the Gopher server can be of any type, -depending on the first character of the selector string. If the data -is text (first character of the selector is \samp{0}), lines are -terminated by CRLF, and the data is terminated by a line consisting of -a single \samp{.}, and a leading \samp{.} should be stripped from -lines that begin with \samp{..}. Directory listings (first character -of the selector is \samp{1}) are transferred using the same protocol. diff --git a/Doc/lib/libhttplib.tex b/Doc/lib/libhttplib.tex index 5fd48c1..7c9449d 100644 --- a/Doc/lib/libhttplib.tex +++ b/Doc/lib/libhttplib.tex @@ -51,7 +51,9 @@ the server at the same host and port: \versionadded{2.0} \end{classdesc} -\begin{classdesc}{HTTPSConnection}{host\optional{, port, key_file, cert_file}} +\begin{classdesc}{HTTPSConnection}{host\optional{, port\optional{, + key_file\optional{, cert_file\optional{, + strict\optional{, timeout}}}}}} A subclass of \class{HTTPConnection} that uses SSL for communication with secure servers. Default port is \code{443}. \var{key_file} is diff --git a/Doc/lib/libimageop.tex b/Doc/lib/libimageop.tex deleted file mode 100644 index 0f732bf..0000000 --- a/Doc/lib/libimageop.tex +++ /dev/null @@ -1,100 +0,0 @@ -\section{\module{imageop} --- - Manipulate raw image data} - -\declaremodule{builtin}{imageop} -\modulesynopsis{Manipulate raw image data.} - - -The \module{imageop} module contains some useful operations on images. -It operates on images consisting of 8 or 32 bit pixels stored in -Python strings. This is the same format as used by -\function{gl.lrectwrite()} and the \refmodule{imgfile} module. - -The module defines the following variables and functions: - -\begin{excdesc}{error} -This exception is raised on all errors, such as unknown number of bits -per pixel, etc. -\end{excdesc} - - -\begin{funcdesc}{crop}{image, psize, width, height, x0, y0, x1, y1} -Return the selected part of \var{image}, which should be -\var{width} by \var{height} in size and consist of pixels of -\var{psize} bytes. \var{x0}, \var{y0}, \var{x1} and \var{y1} are like -the \function{gl.lrectread()} parameters, i.e.\ the boundary is -included in the new image. The new boundaries need not be inside the -picture. Pixels that fall outside the old image will have their value -set to zero. If \var{x0} is bigger than \var{x1} the new image is -mirrored. The same holds for the y coordinates. -\end{funcdesc} - -\begin{funcdesc}{scale}{image, psize, width, height, newwidth, newheight} -Return \var{image} scaled to size \var{newwidth} by \var{newheight}. -No interpolation is done, scaling is done by simple-minded pixel -duplication or removal. Therefore, computer-generated images or -dithered images will not look nice after scaling. -\end{funcdesc} - -\begin{funcdesc}{tovideo}{image, psize, width, height} -Run a vertical low-pass filter over an image. It does so by computing -each destination pixel as the average of two vertically-aligned source -pixels. The main use of this routine is to forestall excessive -flicker if the image is displayed on a video device that uses -interlacing, hence the name. -\end{funcdesc} - -\begin{funcdesc}{grey2mono}{image, width, height, threshold} -Convert a 8-bit deep greyscale image to a 1-bit deep image by -thresholding all the pixels. The resulting image is tightly packed and -is probably only useful as an argument to \function{mono2grey()}. -\end{funcdesc} - -\begin{funcdesc}{dither2mono}{image, width, height} -Convert an 8-bit greyscale image to a 1-bit monochrome image using a -(simple-minded) dithering algorithm. -\end{funcdesc} - -\begin{funcdesc}{mono2grey}{image, width, height, p0, p1} -Convert a 1-bit monochrome image to an 8 bit greyscale or color image. -All pixels that are zero-valued on input get value \var{p0} on output -and all one-value input pixels get value \var{p1} on output. To -convert a monochrome black-and-white image to greyscale pass the -values \code{0} and \code{255} respectively. -\end{funcdesc} - -\begin{funcdesc}{grey2grey4}{image, width, height} -Convert an 8-bit greyscale image to a 4-bit greyscale image without -dithering. -\end{funcdesc} - -\begin{funcdesc}{grey2grey2}{image, width, height} -Convert an 8-bit greyscale image to a 2-bit greyscale image without -dithering. -\end{funcdesc} - -\begin{funcdesc}{dither2grey2}{image, width, height} -Convert an 8-bit greyscale image to a 2-bit greyscale image with -dithering. As for \function{dither2mono()}, the dithering algorithm -is currently very simple. -\end{funcdesc} - -\begin{funcdesc}{grey42grey}{image, width, height} -Convert a 4-bit greyscale image to an 8-bit greyscale image. -\end{funcdesc} - -\begin{funcdesc}{grey22grey}{image, width, height} -Convert a 2-bit greyscale image to an 8-bit greyscale image. -\end{funcdesc} - -\begin{datadesc}{backward_compatible} -If set to 0, the functions in this module use a non-backward -compatible way of representing multi-byte pixels on little-endian -systems. The SGI for which this module was originally written is a -big-endian system, so setting this variable will have no effect. -However, the code wasn't originally intended to run on anything else, -so it made assumptions about byte order which are not universal. -Setting this variable to 0 will cause the byte order to be reversed on -little-endian systems, so that it then is the same as on big-endian -systems. -\end{datadesc} diff --git a/Doc/lib/liboptparse.tex b/Doc/lib/liboptparse.tex index dd618c8..eb4919b 100644 --- a/Doc/lib/liboptparse.tex +++ b/Doc/lib/liboptparse.tex @@ -1191,14 +1191,14 @@ OptionValueError if an invalid string is given. The whole point of creating and populating an OptionParser is to call its \method{parse{\_}args()} method: \begin{verbatim} -(options, args) = parser.parse_args(args=None, options=None) +(options, args) = parser.parse_args(args=None, values=None) \end{verbatim} where the input parameters are \begin{description} \item[\code{args}] the list of arguments to process (default: \code{sys.argv{[}1:]}) -\item[\code{options}] +\item[\code{values}] object to store option arguments in (default: a new instance of optparse.Values) \end{description} diff --git a/Doc/lib/librgbimg.tex b/Doc/lib/librgbimg.tex deleted file mode 100644 index ab20fd6..0000000 --- a/Doc/lib/librgbimg.tex +++ /dev/null @@ -1,54 +0,0 @@ -\section{\module{rgbimg} --- - Read and write ``SGI RGB'' files} - -\declaremodule{builtin}{rgbimg} -\modulesynopsis{Read and write image files in ``SGI RGB'' format (the module - is \emph{not} SGI specific though!).} - -\deprecated{2.5}{This module is not maintained anymore and seems to be - unused.} - -The \module{rgbimg} module allows Python programs to access SGI imglib image -files (also known as \file{.rgb} files). The module is far from -complete, but is provided anyway since the functionality that there is -enough in some cases. Currently, colormap files are not supported. - -\note{This module is only built by default for 32-bit platforms; it is -not expected to work properly on other systems.} - -The module defines the following variables and functions: - -\begin{excdesc}{error} -This exception is raised on all errors, such as unsupported file type, etc. -\end{excdesc} - -\begin{funcdesc}{sizeofimage}{file} -This function returns a tuple \code{(\var{x}, \var{y})} where -\var{x} and \var{y} are the size of the image in pixels. -Only 4 byte RGBA pixels, 3 byte RGB pixels, and 1 byte greyscale pixels -are currently supported. -\end{funcdesc} - -\begin{funcdesc}{longimagedata}{file} -This function reads and decodes the image on the specified file, and -returns it as a Python string. The string has 4 byte RGBA pixels. -The bottom left pixel is the first in -the string. This format is suitable to pass to \function{gl.lrectwrite()}, -for instance. -\end{funcdesc} - -\begin{funcdesc}{longstoimage}{data, x, y, z, file} -This function writes the RGBA data in \var{data} to image -file \var{file}. \var{x} and \var{y} give the size of the image. -\var{z} is 1 if the saved image should be 1 byte greyscale, 3 if the -saved image should be 3 byte RGB data, or 4 if the saved images should -be 4 byte RGBA data. The input data always contains 4 bytes per pixel. -These are the formats returned by \function{gl.lrectread()}. -\end{funcdesc} - -\begin{funcdesc}{ttob}{flag} -This function sets a global flag which defines whether the scan lines -of the image are read or written from bottom to top (flag is zero, -compatible with SGI GL) or from top to bottom (flag is one, -compatible with X). The default is zero. -\end{funcdesc} diff --git a/Doc/lib/libsets.tex b/Doc/lib/libsets.tex deleted file mode 100644 index e69de29..0000000 --- a/Doc/lib/libsets.tex +++ /dev/null diff --git a/Doc/lib/liburllib.tex b/Doc/lib/liburllib.tex index 75ee310..77dfb8f 100644 --- a/Doc/lib/liburllib.tex +++ b/Doc/lib/liburllib.tex @@ -70,8 +70,8 @@ see the \function{urlencode()} function below. The \function{urlopen()} function works transparently with proxies which do not require authentication. In a \UNIX{} or Windows -environment, set the \envvar{http_proxy}, \envvar{ftp_proxy} or -\envvar{gopher_proxy} environment variables to a URL that identifies +environment, set the \envvar{http_proxy}, or \envvar{ftp_proxy} +environment variables to a URL that identifies the proxy server before starting the Python interpreter. For example (the \character{\%} is the command prompt): @@ -253,7 +253,7 @@ function uses \function{unquote()} to decode \var{path}. \begin{classdesc}{URLopener}{\optional{proxies\optional{, **x509}}} Base class for opening and reading URLs. Unless you need to support opening objects using schemes other than \file{http:}, \file{ftp:}, -\file{gopher:} or \file{file:}, you probably want to use +or \file{file:}, you probably want to use \class{FancyURLopener}. By default, the \class{URLopener} class sends a @@ -324,9 +324,8 @@ Restrictions: \item Currently, only the following protocols are supported: HTTP, (versions -0.9 and 1.0), Gopher (but not Gopher-+), FTP, and local files. +0.9 and 1.0), FTP, and local files. \indexii{HTTP}{protocol} -\indexii{Gopher}{protocol} \indexii{FTP}{protocol} \item @@ -355,9 +354,7 @@ is the raw data returned by the server. This may be binary data (such as an image), plain text or (for example) HTML\index{HTML}. The HTTP\indexii{HTTP}{protocol} protocol provides type information in the reply header, which can be inspected by looking at the -\mailheader{Content-Type} header. For the -Gopher\indexii{Gopher}{protocol} protocol, type information is encoded -in the URL; there is currently no easy way to extract it. If the +\mailheader{Content-Type} header. If the returned data is HTML, you can use the module \refmodule{htmllib}\refstmodindex{htmllib} to parse it. diff --git a/Doc/lib/liburllib2.tex b/Doc/lib/liburllib2.tex index f6ff513..0df7385 100644 --- a/Doc/lib/liburllib2.tex +++ b/Doc/lib/liburllib2.tex @@ -86,11 +86,6 @@ non-exceptional file-like return value (the same thing that HTTP errors, such as requests for authentication. \end{excdesc} -\begin{excdesc}{GopherError} -A subclass of \exception{URLError}, this is the error raised by the -Gopher handler. -\end{excdesc} - The following classes are provided: @@ -241,10 +236,6 @@ Open FTP URLs, keeping a cache of open FTP connections to minimize delays. \end{classdesc} -\begin{classdesc}{GopherHandler}{} -Open gopher URLs. -\end{classdesc} - \begin{classdesc}{UnknownHandler}{} A catch-all class to handle unknown URLs. \end{classdesc} @@ -744,13 +735,6 @@ Set maximum number of cached connections to \var{m}. \end{methoddesc} -\subsection{GopherHandler Objects \label{gopher-handler}} - -\begin{methoddesc}[GopherHandler]{gopher_open}{req} -Open the gopher resource indicated by \var{req}. -\end{methoddesc} - - \subsection{UnknownHandler Objects \label{unknown-handler-objects}} \begin{methoddesc}[UnknownHandler]{unknown_open}{} |