diff options
Diffstat (limited to 'Doc/library/urllib2.rst')
| -rw-r--r-- | Doc/library/urllib2.rst | 32 |
1 files changed, 24 insertions, 8 deletions
diff --git a/Doc/library/urllib2.rst b/Doc/library/urllib2.rst index 0411e18..65d11e1 100644 --- a/Doc/library/urllib2.rst +++ b/Doc/library/urllib2.rst @@ -22,13 +22,10 @@ redirections, cookies and more. The :mod:`urllib2` module defines the following functions: -.. function:: urlopen(url[, data][, timeout]) +.. function:: urlopen(url[, data[, timeout[, cafile[, capath[, cadefault[, context]]]]]) Open the URL *url*, which can be either a string or a :class:`Request` object. - .. warning:: - HTTPS requests do not do any verification of the server's certificate. - *data* may be a string specifying additional data to send to the server, or ``None`` if no such data is needed. Currently HTTP requests are the only ones that use *data*; the HTTP request will be a POST instead of a GET when the @@ -41,7 +38,19 @@ The :mod:`urllib2` module defines the following functions: The optional *timeout* parameter specifies a timeout in seconds for blocking operations like the connection attempt (if not specified, the global default timeout setting will be used). This actually only works for HTTP, HTTPS and - FTP connections. + FTP connections. + + If *context* is specified, it must be a :class:`ssl.SSLContext` instance + describing the various SSL options. See :class:`~httplib.HTTPSConnection` for + more details. + + The optional *cafile* and *capath* parameters specify a set of trusted CA + certificates for HTTPS requests. *cafile* should point to a single file + containing a bundle of CA certificates, whereas *capath* should point to a + directory of hashed certificate files. More information can be found in + :meth:`ssl.SSLContext.load_verify_locations`. + + The *cadefault* parameter is ignored. This function returns a file-like object with three additional methods: @@ -66,7 +75,10 @@ The :mod:`urllib2` module defines the following functions: handled through the proxy. .. versionchanged:: 2.6 - *timeout* was added. + *timeout* was added. + + .. versionchanged:: 2.7.9 + *cafile*, *capath*, *cadefault*, and *context* were added. .. function:: install_opener(opener) @@ -280,9 +292,13 @@ The following classes are provided: A class to handle opening of HTTP URLs. -.. class:: HTTPSHandler() +.. class:: HTTPSHandler([debuglevel[, context[, check_hostname]]]) + + A class to handle opening of HTTPS URLs. *context* and *check_hostname* have + the same meaning as for :class:`httplib.HTTPSConnection`. - A class to handle opening of HTTPS URLs. + .. versionchanged:: 2.7.9 + *context* and *check_hostname* were added. .. class:: FileHandler() |