traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[Bug #1528258] Mention that the 'data' argument can be None. 

The constructor docs referred the reader to the add_data() method's docs,
but they weren't very helpful.  I've simply copied an earlier explanation
of 'data' that's more useful.
This commit is contained in:
Andrew M. Kuchling 2006-07-29 15:57:08 +00:00
parent aab30d0f08
commit e49741d412
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doc/lib/liburllib2.tex
View File

@ -19,7 +19,8 @@ Open the URL \var{url}, which can be either a string or a \class{Request}
object. object.
\var{data} may be a string specifying additional data to send to the \var{data} may be a string specifying additional data to send to the
server. Currently HTTP requests are the only ones that use \var{data}; server, or \code{None} if no such data is needed.
Currently HTTP requests are the only ones that use \var{data};
the HTTP request will be a POST instead of a GET when the \var{data} the HTTP request will be a POST instead of a GET when the \var{data}
parameter is provided. \var{data} should be a buffer in the standard parameter is provided. \var{data} should be a buffer in the standard
\mimetype{application/x-www-form-urlencoded} format. The \mimetype{application/x-www-form-urlencoded} format. The
@ -97,8 +98,17 @@ The following classes are provided:
\optional{, origin_req_host}\optional{, unverifiable}} \optional{, origin_req_host}\optional{, unverifiable}}
This class is an abstraction of a URL request. This class is an abstraction of a URL request.
\var{url} should be a string which is a valid URL. For a description \var{url} should be a string containing a valid URL.
of \var{data} see the \method{add_data()} description.
\var{data} may be a string specifying additional data to send to the
server, or \code{None} if no such data is needed.
Currently HTTP requests are the only ones that use \var{data};
the HTTP request will be a POST instead of a GET when the \var{data}
parameter is provided. \var{data} should be a buffer in the standard
\mimetype{application/x-www-form-urlencoded} format. The
\function{urllib.urlencode()} function takes a mapping or sequence of
2-tuples and returns a string in this format.
\var{headers} should be a dictionary, and will be treated as if \var{headers} should be a dictionary, and will be treated as if
\method{add_header()} was called with each key and value as arguments. \method{add_header()} was called with each key and value as arguments.