[Python-checkins] python/dist/src/Doc/lib liburllib.tex,1.40.8.1,1.40.8.2
bcannon@users.sourceforge.net
bcannon@users.sourceforge.net
Wed, 23 Apr 2003 19:46:37 -0700
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv1714/Doc/lib
Modified Files:
Tag: release22-maint
liburllib.tex
Log Message:
Fix documentation errors in regards to urlretrieve() and local files.
Also fix typos in urllib lib doc.
Index: liburllib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/liburllib.tex,v
retrieving revision 1.40.8.1
retrieving revision 1.40.8.2
diff -C2 -d -r1.40.8.1 -r1.40.8.2
*** liburllib.tex 22 Oct 2002 21:58:39 -0000 1.40.8.1
--- liburllib.tex 24 Apr 2003 02:46:34 -0000 1.40.8.2
***************
*** 61,65 ****
\var{data} argument may be given to specify a \code{POST} request
(normally the request type is \code{GET}). The \var{data} argument
! must in standard \mimetype{application/x-www-form-urlencoded} format;
see the \function{urlencode()} function below.
--- 61,65 ----
\var{data} argument may be given to specify a \code{POST} request
(normally the request type is \code{GET}). The \var{data} argument
! must be in standard \mimetype{application/x-www-form-urlencoded} format;
see the \function{urlencode()} function below.
***************
*** 92,99 ****
\code{(\var{filename}, \var{headers})} where \var{filename} is the
local file name under which the object can be found, and \var{headers}
! is either \code{None} (for a local object) or whatever the
! \method{info()} method of the object returned by \function{urlopen()}
! returned (for a remote object, possibly cached). Exceptions are the
! same as for \function{urlopen()}.
The second argument, if present, specifies the file location to copy
--- 92,98 ----
\code{(\var{filename}, \var{headers})} where \var{filename} is the
local file name under which the object can be found, and \var{headers}
! is whatever the \method{info()} method of the object returned by
! \function{urlopen()} returned (for a remote object, possibly cached).
! Exceptions are the same as for \function{urlopen()}.
The second argument, if present, specifies the file location to copy
***************
*** 104,108 ****
count of blocks transferred so far, a block size in bytes, and the
total size of the file. The third argument may be \code{-1} on older
! FTP servers which do not return a file size in response to a retrieval
request.
--- 103,107 ----
count of blocks transferred so far, a block size in bytes, and the
total size of the file. The third argument may be \code{-1} on older
! FTP servers which do not return a file size in response to a retrieval
request.
***************
*** 145,149 ****
\begin{funcdesc}{quote}{string\optional{, safe}}
Replace special characters in \var{string} using the \samp{\%xx} escape.
! Letters, digits, and the characters \character{_,.-} are never quoted.
The optional \var{safe} parameter specifies additional characters
that should not be quoted --- its default value is \code{'/'}.
--- 144,148 ----
\begin{funcdesc}{quote}{string\optional{, safe}}
Replace special characters in \var{string} using the \samp{\%xx} escape.
! Letters, digits, and the characters \character{_.-} are never quoted.
The optional \var{safe} parameter specifies additional characters
that should not be quoted --- its default value is \code{'/'}.
***************
*** 155,159 ****
Like \function{quote()}, but also replaces spaces by plus signs, as
required for quoting HTML form values. Plus signs in the original
! string are escaped unless they are included in \var{safe}.
\end{funcdesc}
--- 154,159 ----
Like \function{quote()}, but also replaces spaces by plus signs, as
required for quoting HTML form values. Plus signs in the original
! string are escaped unless they are included in \var{safe}. It also
! does not have \var{safe} default to \code{'/'}.
\end{funcdesc}
***************
*** 171,175 ****
\begin{funcdesc}{urlencode}{query\optional{, doseq}}
Convert a mapping object or a sequence of two-element tuples to a
! ``url-encoded'' string, suitable to pass to
\function{urlopen()} above as the optional \var{data} argument. This
is useful to pass a dictionary of form fields to a \code{POST}
--- 171,175 ----
\begin{funcdesc}{urlencode}{query\optional{, doseq}}
Convert a mapping object or a sequence of two-element tuples to a
! ``url-encoded'' string, suitable to pass to
\function{urlopen()} above as the optional \var{data} argument. This
is useful to pass a dictionary of form fields to a \code{POST}
***************
*** 301,308 ****
\begin{methoddesc}[URLopener]{open}{fullurl\optional{, data}}
! Open \var{fullurl} using the appropriate protocol. This method sets
up cache and proxy information, then calls the appropriate open method with
its input arguments. If the scheme is not recognized,
! \method{open_unknown()} is called. The \var{data} argument
has the same meaning as the \var{data} argument of \function{urlopen()}.
\end{methoddesc}
--- 301,308 ----
\begin{methoddesc}[URLopener]{open}{fullurl\optional{, data}}
! Open \var{fullurl} using the appropriate protocol. This method sets
up cache and proxy information, then calls the appropriate open method with
its input arguments. If the scheme is not recognized,
! \method{open_unknown()} is called. The \var{data} argument
has the same meaning as the \var{data} argument of \function{urlopen()}.
\end{methoddesc}