From 317ad7a5eed5123027b19ee014a37509547f2520 Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Thu, 24 Apr 2003 02:31:14 +0000 Subject: Fixed docs for urlretrieve() to match code in the case of opening a local file. Also some typos and removed trailing whitespace on the lines. --- Doc/lib/liburllib.tex | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/Doc/lib/liburllib.tex b/Doc/lib/liburllib.tex index 20e2796..c458616 100644 --- a/Doc/lib/liburllib.tex +++ b/Doc/lib/liburllib.tex @@ -61,7 +61,7 @@ redirected URL. If the \var{url} uses the \file{http:} scheme identifier, the optional \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; +must be in standard \mimetype{application/x-www-form-urlencoded} format; see the \function{urlencode()} function below. The \function{urlopen()} function works transparently with proxies @@ -78,7 +78,7 @@ the proxy server before starting the Python interpreter. For example ... \end{verbatim} -In a Windows environment, if no proxy envvironment variables are set, +In a Windows environment, if no proxy environment variables are set, proxy settings are obtained from the registry's Internet Settings section. @@ -100,7 +100,7 @@ filehandle = urllib.urlopen(some_url, proxies={}) # Use proxies from environment - both versions are equivalent filehandle = urllib.urlopen(some_url, proxies=None) filehandle = urllib.urlopen(some_url) -\end{verbatim} +\end{verbatim} The \function{urlopen()} function does not support explicit proxy specification. If you need to override environmental proxy settings, @@ -119,10 +119,9 @@ If the URL points to a local file, or a valid cached copy of the object exists, the object is not copied. Return a tuple \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()}. +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 to (if absent, the location will be a tempfile with a generated name). @@ -131,7 +130,7 @@ once on establishment of the network connection and once after each block read thereafter. The hook will be passed three arguments; a 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 +FTP servers which do not return a file size in response to a retrieval request. If the \var{url} uses the \file{http:} scheme identifier, the optional @@ -172,7 +171,7 @@ Clear the cache that may have been built up by previous calls to \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. +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{'/'}. @@ -182,7 +181,8 @@ Example: \code{quote('/\~{}connolly/')} yields \code{'/\%7econnolly/'}. \begin{funcdesc}{quote_plus}{string\optional{, safe}} 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}. +string are escaped unless they are included in \var{safe}. It also +does not have \var{safe} default to \code{'/'}. \end{funcdesc} \begin{funcdesc}{unquote}{string} @@ -198,7 +198,7 @@ required for unquoting HTML form values. \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 +``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} request. The resulting string is a series of @@ -334,10 +334,10 @@ manipulation is in module \refmodule{urlparse}\refstmodindex{urlparse}. following attributes. \begin{methoddesc}[URLopener]{open}{fullurl\optional{, data}} -Open \var{fullurl} using the appropriate protocol. This method sets +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 +\method{open_unknown()} is called. The \var{data} argument has the same meaning as the \var{data} argument of \function{urlopen()}. \end{methoddesc} -- cgit v0.12