Georg Brandl | 8175dae | 2010-11-29 14:53:15 +0000 | [diff] [blame] | 1 | :mod:`urllib.request` --- Extensible library for opening URLs |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 2 | ============================================================= |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 3 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 4 | .. module:: urllib.request |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 5 | :synopsis: Extensible library for opening URLs. |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 6 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 7 | .. moduleauthor:: Jeremy Hylton <jeremy@alum.mit.edu> |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 8 | .. sectionauthor:: Moshe Zadka <moshez@users.sourceforge.net> |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 9 | .. sectionauthor:: Senthil Kumaran <senthil@uthcode.com> |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 10 | |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 11 | **Source code:** :source:`Lib/urllib/request.py` |
| 12 | |
| 13 | -------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 14 | |
Georg Brandl | 0f7ede4 | 2008-06-23 11:23:31 +0000 | [diff] [blame] | 15 | The :mod:`urllib.request` module defines functions and classes which help in |
| 16 | opening URLs (mostly HTTP) in a complex world --- basic and digest |
| 17 | authentication, redirections, cookies and more. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 18 | |
Benjamin Peterson | 6de708f | 2015-04-20 18:18:14 -0400 | [diff] [blame] | 19 | .. seealso:: |
| 20 | |
Andrew Kuchling | d58fc8b | 2016-11-08 22:07:43 -0500 | [diff] [blame^] | 21 | The `Requests package <https://docs.python-requests.org/>`_ |
Martin Panter | fe289c0 | 2016-05-28 02:20:39 +0000 | [diff] [blame] | 22 | is recommended for a higher-level HTTP client interface. |
Benjamin Peterson | 6de708f | 2015-04-20 18:18:14 -0400 | [diff] [blame] | 23 | |
Antoine Pitrou | 79ecd76 | 2010-09-29 11:24:21 +0000 | [diff] [blame] | 24 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 25 | The :mod:`urllib.request` module defines the following functions: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 26 | |
| 27 | |
Senthil Kumaran | a5c85b3 | 2014-09-19 15:23:30 +0800 | [diff] [blame] | 28 | .. function:: urlopen(url, data=None[, timeout], *, cafile=None, capath=None, cadefault=False, context=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 29 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 30 | Open the URL *url*, which can be either a string or a |
| 31 | :class:`Request` object. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 32 | |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 33 | *data* must be a bytes object specifying additional data to be sent to the |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 34 | server, or ``None`` if no such data is needed. *data* may also be an |
| 35 | iterable object and in that case Content-Length value must be specified in |
| 36 | the headers. Currently HTTP requests are the only ones that use *data*; the |
| 37 | HTTP request will be a POST instead of a GET when the *data* parameter is |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 38 | provided. |
| 39 | |
| 40 | *data* should be a buffer in the standard |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 41 | :mimetype:`application/x-www-form-urlencoded` format. The |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 42 | :func:`urllib.parse.urlencode` function takes a mapping or sequence of |
Martin Panter | cda85a0 | 2015-11-24 22:33:18 +0000 | [diff] [blame] | 43 | 2-tuples and returns an ASCII text string in this format. It should |
| 44 | be encoded to bytes before being used as the *data* parameter. |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 45 | |
| 46 | urllib.request module uses HTTP/1.1 and includes ``Connection:close`` header |
| 47 | in its HTTP requests. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 48 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 49 | The optional *timeout* parameter specifies a timeout in seconds for |
| 50 | blocking operations like the connection attempt (if not specified, |
| 51 | the global default timeout setting will be used). This actually |
Senthil Kumaran | c08d907 | 2010-10-05 18:46:56 +0000 | [diff] [blame] | 52 | only works for HTTP, HTTPS and FTP connections. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 53 | |
Senthil Kumaran | a5c85b3 | 2014-09-19 15:23:30 +0800 | [diff] [blame] | 54 | If *context* is specified, it must be a :class:`ssl.SSLContext` instance |
Benjamin Peterson | a5c9c37 | 2014-11-02 13:17:56 -0500 | [diff] [blame] | 55 | describing the various SSL options. See :class:`~http.client.HTTPSConnection` |
| 56 | for more details. |
Senthil Kumaran | a5c85b3 | 2014-09-19 15:23:30 +0800 | [diff] [blame] | 57 | |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 58 | The optional *cafile* and *capath* parameters specify a set of trusted |
| 59 | CA certificates for HTTPS requests. *cafile* should point to a single |
| 60 | file containing a bundle of CA certificates, whereas *capath* should |
| 61 | point to a directory of hashed certificate files. More information can |
| 62 | be found in :meth:`ssl.SSLContext.load_verify_locations`. |
| 63 | |
Benjamin Peterson | 378e15d | 2014-11-23 11:43:33 -0600 | [diff] [blame] | 64 | The *cadefault* parameter is ignored. |
Antoine Pitrou | de9ac6c | 2012-05-16 21:40:01 +0200 | [diff] [blame] | 65 | |
Martin Panter | 3ee6270 | 2016-06-04 04:57:19 +0000 | [diff] [blame] | 66 | This function always returns an object which can work as a |
Senthil Kumaran | b98e96a | 2013-02-07 00:47:01 -0800 | [diff] [blame] | 67 | :term:`context manager` and has methods such as |
| 68 | |
| 69 | * :meth:`~urllib.response.addinfourl.geturl` --- return the URL of the resource retrieved, |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 70 | commonly used to determine if a redirect was followed |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 71 | |
Senthil Kumaran | b98e96a | 2013-02-07 00:47:01 -0800 | [diff] [blame] | 72 | * :meth:`~urllib.response.addinfourl.info` --- return the meta-information of the page, such as headers, |
Senthil Kumaran | 13a7eb4 | 2010-06-28 17:31:40 +0000 | [diff] [blame] | 73 | in the form of an :func:`email.message_from_string` instance (see |
Serhiy Storchaka | 6dff020 | 2016-05-07 10:49:07 +0300 | [diff] [blame] | 74 | `Quick Reference to HTTP Headers <https://www.cs.tut.fi/~jkorpela/http.html>`_) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 75 | |
Senthil Kumaran | b98e96a | 2013-02-07 00:47:01 -0800 | [diff] [blame] | 76 | * :meth:`~urllib.response.addinfourl.getcode` -- return the HTTP status code of the response. |
| 77 | |
Martin Panter | fe289c0 | 2016-05-28 02:20:39 +0000 | [diff] [blame] | 78 | For HTTP and HTTPS URLs, this function returns a |
Martin Panter | 747d48c | 2015-11-26 11:01:58 +0000 | [diff] [blame] | 79 | :class:`http.client.HTTPResponse` object slightly modified. In addition |
| 80 | to the three new methods above, the msg attribute contains the |
| 81 | same information as the :attr:`~http.client.HTTPResponse.reason` |
| 82 | attribute --- the reason phrase returned by server --- instead of |
| 83 | the response headers as it is specified in the documentation for |
| 84 | :class:`~http.client.HTTPResponse`. |
| 85 | |
Martin Panter | fe289c0 | 2016-05-28 02:20:39 +0000 | [diff] [blame] | 86 | For FTP, file, and data URLs and requests explicitly handled by legacy |
Martin Panter | 747d48c | 2015-11-26 11:01:58 +0000 | [diff] [blame] | 87 | :class:`URLopener` and :class:`FancyURLopener` classes, this function |
| 88 | returns a :class:`urllib.response.addinfourl` object. |
| 89 | |
R David Murray | 21dcb93 | 2016-06-03 13:29:17 -0400 | [diff] [blame] | 90 | Raises :exc:`~urllib.error.URLError` on protocol errors. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 91 | |
Georg Brandl | 2dd0104 | 2009-02-27 16:46:46 +0000 | [diff] [blame] | 92 | Note that ``None`` may be returned if no handler handles the request (though |
| 93 | the default installed global :class:`OpenerDirector` uses |
| 94 | :class:`UnknownHandler` to ensure this never happens). |
| 95 | |
R David Murray | 5aea37a | 2013-04-28 11:07:16 -0400 | [diff] [blame] | 96 | In addition, if proxy settings are detected (for example, when a ``*_proxy`` |
| 97 | environment variable like :envvar:`http_proxy` is set), |
| 98 | :class:`ProxyHandler` is default installed and makes sure the requests are |
| 99 | handled through the proxy. |
Senthil Kumaran | a51a1b3 | 2009-10-18 01:42:33 +0000 | [diff] [blame] | 100 | |
Georg Brandl | 2dd0104 | 2009-02-27 16:46:46 +0000 | [diff] [blame] | 101 | The legacy ``urllib.urlopen`` function from Python 2.6 and earlier has been |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 102 | discontinued; :func:`urllib.request.urlopen` corresponds to the old |
| 103 | ``urllib2.urlopen``. Proxy handling, which was done by passing a dictionary |
| 104 | parameter to ``urllib.urlopen``, can be obtained by using |
| 105 | :class:`ProxyHandler` objects. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 106 | |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 107 | .. versionchanged:: 3.2 |
| 108 | *cafile* and *capath* were added. |
| 109 | |
Antoine Pitrou | d532321 | 2010-10-22 18:19:07 +0000 | [diff] [blame] | 110 | .. versionchanged:: 3.2 |
| 111 | HTTPS virtual hosts are now supported if possible (that is, if |
| 112 | :data:`ssl.HAS_SNI` is true). |
| 113 | |
Senthil Kumaran | 7bc0d87 | 2010-12-19 10:49:52 +0000 | [diff] [blame] | 114 | .. versionadded:: 3.2 |
| 115 | *data* can be an iterable object. |
| 116 | |
Antoine Pitrou | de9ac6c | 2012-05-16 21:40:01 +0200 | [diff] [blame] | 117 | .. versionchanged:: 3.3 |
| 118 | *cadefault* was added. |
| 119 | |
Benjamin Peterson | 4a358de | 2014-11-03 17:04:01 -0500 | [diff] [blame] | 120 | .. versionchanged:: 3.4.3 |
Senthil Kumaran | a5c85b3 | 2014-09-19 15:23:30 +0800 | [diff] [blame] | 121 | *context* was added. |
| 122 | |
Benjamin Peterson | 030dbb9 | 2014-11-02 13:19:15 -0500 | [diff] [blame] | 123 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 124 | .. function:: install_opener(opener) |
| 125 | |
| 126 | Install an :class:`OpenerDirector` instance as the default global opener. |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 127 | Installing an opener is only necessary if you want urlopen to use that |
| 128 | opener; otherwise, simply call :meth:`OpenerDirector.open` instead of |
| 129 | :func:`~urllib.request.urlopen`. The code does not check for a real |
| 130 | :class:`OpenerDirector`, and any class with the appropriate interface will |
| 131 | work. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 132 | |
| 133 | |
| 134 | .. function:: build_opener([handler, ...]) |
| 135 | |
| 136 | Return an :class:`OpenerDirector` instance, which chains the handlers in the |
| 137 | order given. *handler*\s can be either instances of :class:`BaseHandler`, or |
| 138 | subclasses of :class:`BaseHandler` (in which case it must be possible to call |
| 139 | the constructor without any parameters). Instances of the following classes |
| 140 | will be in front of the *handler*\s, unless the *handler*\s contain them, |
R David Murray | 5aea37a | 2013-04-28 11:07:16 -0400 | [diff] [blame] | 141 | instances of them or subclasses of them: :class:`ProxyHandler` (if proxy |
R David Murray | 9330a94 | 2013-04-28 11:24:35 -0400 | [diff] [blame] | 142 | settings are detected), :class:`UnknownHandler`, :class:`HTTPHandler`, |
| 143 | :class:`HTTPDefaultErrorHandler`, :class:`HTTPRedirectHandler`, |
| 144 | :class:`FTPHandler`, :class:`FileHandler`, :class:`HTTPErrorProcessor`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 145 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 146 | If the Python installation has SSL support (i.e., if the :mod:`ssl` module |
| 147 | can be imported), :class:`HTTPSHandler` will also be added. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 148 | |
Georg Brandl | e6bcc91 | 2008-05-12 18:05:20 +0000 | [diff] [blame] | 149 | A :class:`BaseHandler` subclass may also change its :attr:`handler_order` |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 150 | attribute to modify its position in the handlers list. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 151 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 152 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 153 | .. function:: pathname2url(path) |
Christian Heimes | 292d351 | 2008-02-03 16:51:08 +0000 | [diff] [blame] | 154 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 155 | Convert the pathname *path* from the local syntax for a path to the form used in |
| 156 | the path component of a URL. This does not produce a complete URL. The return |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 157 | value will already be quoted using the :func:`~urllib.parse.quote` function. |
Christian Heimes | 292d351 | 2008-02-03 16:51:08 +0000 | [diff] [blame] | 158 | |
| 159 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 160 | .. function:: url2pathname(path) |
| 161 | |
Senthil Kumaran | f0769e8 | 2010-08-09 19:53:52 +0000 | [diff] [blame] | 162 | Convert the path component *path* from a percent-encoded URL to the local syntax for a |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 163 | path. This does not accept a complete URL. This function uses |
| 164 | :func:`~urllib.parse.unquote` to decode *path*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 165 | |
Senthil Kumaran | 7e557a6 | 2010-02-26 00:53:23 +0000 | [diff] [blame] | 166 | .. function:: getproxies() |
| 167 | |
| 168 | This helper function returns a dictionary of scheme to proxy server URL |
Senthil Kumaran | 19d85c2 | 2012-01-11 01:29:08 +0800 | [diff] [blame] | 169 | mappings. It scans the environment for variables named ``<scheme>_proxy``, |
| 170 | in a case insensitive approach, for all operating systems first, and when it |
| 171 | cannot find it, looks for proxy information from Mac OSX System |
| 172 | Configuration for Mac OS X and Windows Systems Registry for Windows. |
Senthil Kumaran | a7c0ff2 | 2016-04-25 08:16:23 -0700 | [diff] [blame] | 173 | If both lowercase and uppercase environment variables exist (and disagree), |
| 174 | lowercase is preferred. |
Senthil Kumaran | 7e557a6 | 2010-02-26 00:53:23 +0000 | [diff] [blame] | 175 | |
Senthil Kumaran | 17742f2 | 2016-07-30 23:39:06 -0700 | [diff] [blame] | 176 | .. note:: |
Senthil Kumaran | 4cbb23f | 2016-07-30 23:24:16 -0700 | [diff] [blame] | 177 | |
Senthil Kumaran | 17742f2 | 2016-07-30 23:39:06 -0700 | [diff] [blame] | 178 | If the environment variable ``REQUEST_METHOD`` is set, which usually |
| 179 | indicates your script is running in a CGI environment, the environment |
| 180 | variable ``HTTP_PROXY`` (uppercase ``_PROXY``) will be ignored. This is |
| 181 | because that variable can be injected by a client using the "Proxy:" HTTP |
| 182 | header. If you need to use an HTTP proxy in a CGI environment, either use |
| 183 | ``ProxyHandler`` explicitly, or make sure the variable name is in |
| 184 | lowercase (or at least the ``_proxy`` suffix). |
| 185 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 186 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 187 | The following classes are provided: |
| 188 | |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 189 | .. class:: Request(url, data=None, headers={}, origin_req_host=None, unverifiable=False, method=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 190 | |
| 191 | This class is an abstraction of a URL request. |
| 192 | |
| 193 | *url* should be a string containing a valid URL. |
| 194 | |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 195 | *data* must be a bytes object specifying additional data to send to the |
Senthil Kumaran | 87684e6 | 2012-03-14 18:08:13 -0700 | [diff] [blame] | 196 | server, or ``None`` if no such data is needed. Currently HTTP requests are |
| 197 | the only ones that use *data*; the HTTP request will be a POST instead of a |
| 198 | GET when the *data* parameter is provided. *data* should be a buffer in the |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 199 | standard :mimetype:`application/x-www-form-urlencoded` format. |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 200 | The :func:`urllib.parse.urlencode` function takes a mapping or sequence of |
Martin Panter | cda85a0 | 2015-11-24 22:33:18 +0000 | [diff] [blame] | 201 | 2-tuples and returns an ASCII string in this format. It should be |
| 202 | encoded to bytes before being used as the *data* parameter. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 203 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 204 | *headers* should be a dictionary, and will be treated as if |
| 205 | :meth:`add_header` was called with each key and value as arguments. |
Martin Panter | 7aaaded8 | 2016-06-01 08:10:50 +0000 | [diff] [blame] | 206 | This is often used to "spoof" the ``User-Agent`` header value, which is |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 207 | used by a browser to identify itself -- some HTTP servers only |
| 208 | allow requests coming from common browsers as opposed to scripts. |
| 209 | For example, Mozilla Firefox may identify itself as ``"Mozilla/5.0 |
| 210 | (X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"``, while |
| 211 | :mod:`urllib`'s default user agent string is |
| 212 | ``"Python-urllib/2.6"`` (on Python 2.6). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 213 | |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 214 | An example of using ``Content-Type`` header with *data* argument would be |
Martin Panter | cda85a0 | 2015-11-24 22:33:18 +0000 | [diff] [blame] | 215 | sending a dictionary like ``{"Content-Type": "application/x-www-form-urlencoded"}``. |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 216 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 217 | The final two arguments are only of interest for correct handling |
| 218 | of third-party HTTP cookies: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 219 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 220 | *origin_req_host* should be the request-host of the origin |
| 221 | transaction, as defined by :rfc:`2965`. It defaults to |
| 222 | ``http.cookiejar.request_host(self)``. This is the host name or IP |
| 223 | address of the original request that was initiated by the user. |
| 224 | For example, if the request is for an image in an HTML document, |
| 225 | this should be the request-host of the request for the page |
Georg Brandl | 2442015 | 2008-05-26 16:32:26 +0000 | [diff] [blame] | 226 | containing the image. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 227 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 228 | *unverifiable* should indicate whether the request is unverifiable, |
Serhiy Storchaka | fbc1c26 | 2013-11-29 12:17:13 +0200 | [diff] [blame] | 229 | as defined by RFC 2965. It defaults to ``False``. An unverifiable |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 230 | request is one whose URL the user did not have the option to |
| 231 | approve. For example, if the request is for an image in an HTML |
| 232 | document, and the user had no option to approve the automatic |
| 233 | fetching of the image, this should be true. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 234 | |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 235 | *method* should be a string that indicates the HTTP request method that |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 236 | will be used (e.g. ``'HEAD'``). If provided, its value is stored in the |
Senthil Kumaran | a41c942 | 2011-10-20 02:37:08 +0800 | [diff] [blame] | 237 | :attr:`~Request.method` attribute and is used by :meth:`get_method()`. |
Jason R. Coombs | 0c47f34 | 2013-09-22 09:33:45 -0400 | [diff] [blame] | 238 | Subclasses may indicate a default method by setting the |
| 239 | :attr:`~Request.method` attribute in the class itself. |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 240 | |
| 241 | .. versionchanged:: 3.3 |
Georg Brandl | 61063cc | 2012-06-24 22:48:30 +0200 | [diff] [blame] | 242 | :attr:`Request.method` argument is added to the Request class. |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 243 | |
Jason R. Coombs | 0c47f34 | 2013-09-22 09:33:45 -0400 | [diff] [blame] | 244 | .. versionchanged:: 3.4 |
| 245 | Default :attr:`Request.method` may be indicated at the class level. |
| 246 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 247 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 248 | .. class:: OpenerDirector() |
| 249 | |
| 250 | The :class:`OpenerDirector` class opens URLs via :class:`BaseHandler`\ s chained |
| 251 | together. It manages the chaining of handlers, and recovery from errors. |
| 252 | |
| 253 | |
| 254 | .. class:: BaseHandler() |
| 255 | |
| 256 | This is the base class for all registered handlers --- and handles only the |
| 257 | simple mechanics of registration. |
| 258 | |
| 259 | |
| 260 | .. class:: HTTPDefaultErrorHandler() |
| 261 | |
| 262 | A class which defines a default handler for HTTP error responses; all responses |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 263 | are turned into :exc:`~urllib.error.HTTPError` exceptions. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 264 | |
| 265 | |
| 266 | .. class:: HTTPRedirectHandler() |
| 267 | |
| 268 | A class to handle redirections. |
| 269 | |
| 270 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 271 | .. class:: HTTPCookieProcessor(cookiejar=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 272 | |
| 273 | A class to handle HTTP Cookies. |
| 274 | |
| 275 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 276 | .. class:: ProxyHandler(proxies=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 277 | |
| 278 | Cause requests to go through a proxy. If *proxies* is given, it must be a |
R David Murray | 9330a94 | 2013-04-28 11:24:35 -0400 | [diff] [blame] | 279 | dictionary mapping protocol names to URLs of proxies. The default is to read |
| 280 | the list of proxies from the environment variables |
| 281 | :envvar:`<protocol>_proxy`. If no proxy environment variables are set, then |
| 282 | in a Windows environment proxy settings are obtained from the registry's |
| 283 | Internet Settings section, and in a Mac OS X environment proxy information |
| 284 | is retrieved from the OS X System Configuration Framework. |
Senthil Kumaran | a51a1b3 | 2009-10-18 01:42:33 +0000 | [diff] [blame] | 285 | |
Christian Heimes | e25f35e | 2008-03-20 10:49:03 +0000 | [diff] [blame] | 286 | To disable autodetected proxy pass an empty dictionary. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 287 | |
Senthil Kumaran | 21ce717 | 2016-04-22 20:34:42 -0700 | [diff] [blame] | 288 | The :envvar:`no_proxy` environment variable can be used to specify hosts |
| 289 | which shouldn't be reached via proxy; if set, it should be a comma-separated |
| 290 | list of hostname suffixes, optionally with ``:port`` appended, for example |
| 291 | ``cern.ch,ncsa.uiuc.edu,some.host:8080``. |
| 292 | |
Senthil Kumaran | 17742f2 | 2016-07-30 23:39:06 -0700 | [diff] [blame] | 293 | .. note:: |
| 294 | |
| 295 | ``HTTP_PROXY`` will be ignored if a variable ``REQUEST_METHOD`` is set; |
| 296 | see the documentation on :func:`~urllib.request.getproxies`. |
Senthil Kumaran | 4cbb23f | 2016-07-30 23:24:16 -0700 | [diff] [blame] | 297 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 298 | |
| 299 | .. class:: HTTPPasswordMgr() |
| 300 | |
| 301 | Keep a database of ``(realm, uri) -> (user, password)`` mappings. |
| 302 | |
| 303 | |
| 304 | .. class:: HTTPPasswordMgrWithDefaultRealm() |
| 305 | |
| 306 | Keep a database of ``(realm, uri) -> (user, password)`` mappings. A realm of |
| 307 | ``None`` is considered a catch-all realm, which is searched if no other realm |
| 308 | fits. |
| 309 | |
| 310 | |
R David Murray | 4c7f995 | 2015-04-16 16:36:18 -0400 | [diff] [blame] | 311 | .. class:: HTTPPasswordMgrWithPriorAuth() |
| 312 | |
| 313 | A variant of :class:`HTTPPasswordMgrWithDefaultRealm` that also has a |
| 314 | database of ``uri -> is_authenticated`` mappings. Can be used by a |
| 315 | BasicAuth handler to determine when to send authentication credentials |
| 316 | immediately instead of waiting for a ``401`` response first. |
| 317 | |
| 318 | .. versionadded:: 3.5 |
| 319 | |
| 320 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 321 | .. class:: AbstractBasicAuthHandler(password_mgr=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 322 | |
| 323 | This is a mixin class that helps with HTTP authentication, both to the remote |
| 324 | host and to a proxy. *password_mgr*, if given, should be something that is |
| 325 | compatible with :class:`HTTPPasswordMgr`; refer to section |
| 326 | :ref:`http-password-mgr` for information on the interface that must be |
R David Murray | 4c7f995 | 2015-04-16 16:36:18 -0400 | [diff] [blame] | 327 | supported. If *passwd_mgr* also provides ``is_authenticated`` and |
| 328 | ``update_authenticated`` methods (see |
| 329 | :ref:`http-password-mgr-with-prior-auth`), then the handler will use the |
| 330 | ``is_authenticated`` result for a given URI to determine whether or not to |
| 331 | send authentication credentials with the request. If ``is_authenticated`` |
Berker Peksag | 6d7dced | 2015-04-17 04:58:45 +0300 | [diff] [blame] | 332 | returns ``True`` for the URI, credentials are sent. If ``is_authenticated`` |
R David Murray | 4c7f995 | 2015-04-16 16:36:18 -0400 | [diff] [blame] | 333 | is ``False``, credentials are not sent, and then if a ``401`` response is |
| 334 | received the request is re-sent with the authentication credentials. If |
| 335 | authentication succeeds, ``update_authenticated`` is called to set |
| 336 | ``is_authenticated`` ``True`` for the URI, so that subsequent requests to |
| 337 | the URI or any of its super-URIs will automatically include the |
| 338 | authentication credentials. |
| 339 | |
Berker Peksag | 6d7dced | 2015-04-17 04:58:45 +0300 | [diff] [blame] | 340 | .. versionadded:: 3.5 |
| 341 | Added ``is_authenticated`` support. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 342 | |
| 343 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 344 | .. class:: HTTPBasicAuthHandler(password_mgr=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 345 | |
Senthil Kumaran | 4de00a2 | 2011-05-11 21:17:57 +0800 | [diff] [blame] | 346 | Handle authentication with the remote host. *password_mgr*, if given, should |
| 347 | be something that is compatible with :class:`HTTPPasswordMgr`; refer to |
| 348 | section :ref:`http-password-mgr` for information on the interface that must |
| 349 | be supported. HTTPBasicAuthHandler will raise a :exc:`ValueError` when |
| 350 | presented with a wrong Authentication scheme. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 351 | |
| 352 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 353 | .. class:: ProxyBasicAuthHandler(password_mgr=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 354 | |
| 355 | Handle authentication with the proxy. *password_mgr*, if given, should be |
| 356 | something that is compatible with :class:`HTTPPasswordMgr`; refer to section |
| 357 | :ref:`http-password-mgr` for information on the interface that must be |
| 358 | supported. |
| 359 | |
| 360 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 361 | .. class:: AbstractDigestAuthHandler(password_mgr=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 362 | |
| 363 | This is a mixin class that helps with HTTP authentication, both to the remote |
| 364 | host and to a proxy. *password_mgr*, if given, should be something that is |
| 365 | compatible with :class:`HTTPPasswordMgr`; refer to section |
| 366 | :ref:`http-password-mgr` for information on the interface that must be |
| 367 | supported. |
| 368 | |
| 369 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 370 | .. class:: HTTPDigestAuthHandler(password_mgr=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 371 | |
Senthil Kumaran | 4de00a2 | 2011-05-11 21:17:57 +0800 | [diff] [blame] | 372 | Handle authentication with the remote host. *password_mgr*, if given, should |
| 373 | be something that is compatible with :class:`HTTPPasswordMgr`; refer to |
| 374 | section :ref:`http-password-mgr` for information on the interface that must |
| 375 | be supported. When both Digest Authentication Handler and Basic |
| 376 | Authentication Handler are both added, Digest Authentication is always tried |
| 377 | first. If the Digest Authentication returns a 40x response again, it is sent |
| 378 | to Basic Authentication handler to Handle. This Handler method will raise a |
| 379 | :exc:`ValueError` when presented with an authentication scheme other than |
| 380 | Digest or Basic. |
| 381 | |
Ezio Melotti | e9c7d6c | 2011-05-12 01:10:57 +0300 | [diff] [blame] | 382 | .. versionchanged:: 3.3 |
| 383 | Raise :exc:`ValueError` on unsupported Authentication Scheme. |
Senthil Kumaran | 4de00a2 | 2011-05-11 21:17:57 +0800 | [diff] [blame] | 384 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 385 | |
| 386 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 387 | .. class:: ProxyDigestAuthHandler(password_mgr=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 388 | |
| 389 | Handle authentication with the proxy. *password_mgr*, if given, should be |
| 390 | something that is compatible with :class:`HTTPPasswordMgr`; refer to section |
| 391 | :ref:`http-password-mgr` for information on the interface that must be |
| 392 | supported. |
| 393 | |
| 394 | |
| 395 | .. class:: HTTPHandler() |
| 396 | |
| 397 | A class to handle opening of HTTP URLs. |
| 398 | |
| 399 | |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 400 | .. class:: HTTPSHandler(debuglevel=0, context=None, check_hostname=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 401 | |
Antoine Pitrou | 803e6d6 | 2010-10-13 10:36:15 +0000 | [diff] [blame] | 402 | A class to handle opening of HTTPS URLs. *context* and *check_hostname* |
| 403 | have the same meaning as in :class:`http.client.HTTPSConnection`. |
| 404 | |
| 405 | .. versionchanged:: 3.2 |
| 406 | *context* and *check_hostname* were added. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 407 | |
| 408 | |
| 409 | .. class:: FileHandler() |
| 410 | |
| 411 | Open local files. |
| 412 | |
Antoine Pitrou | df204be | 2012-11-24 17:59:08 +0100 | [diff] [blame] | 413 | .. class:: DataHandler() |
| 414 | |
| 415 | Open data URLs. |
| 416 | |
| 417 | .. versionadded:: 3.4 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 418 | |
| 419 | .. class:: FTPHandler() |
| 420 | |
| 421 | Open FTP URLs. |
| 422 | |
| 423 | |
| 424 | .. class:: CacheFTPHandler() |
| 425 | |
| 426 | Open FTP URLs, keeping a cache of open FTP connections to minimize delays. |
| 427 | |
| 428 | |
| 429 | .. class:: UnknownHandler() |
| 430 | |
| 431 | A catch-all class to handle unknown URLs. |
| 432 | |
| 433 | |
Senthil Kumaran | ed270fa | 2011-07-18 06:42:46 +0800 | [diff] [blame] | 434 | .. class:: HTTPErrorProcessor() |
| 435 | |
| 436 | Process HTTP error responses. |
| 437 | |
| 438 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 439 | .. _request-objects: |
| 440 | |
| 441 | Request Objects |
| 442 | --------------- |
| 443 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 444 | The following methods describe :class:`Request`'s public interface, |
| 445 | and so all may be overridden in subclasses. It also defines several |
| 446 | public attributes that can be used by clients to inspect the parsed |
| 447 | request. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 448 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 449 | .. attribute:: Request.full_url |
| 450 | |
| 451 | The original URL passed to the constructor. |
| 452 | |
Senthil Kumaran | 8307075 | 2013-05-24 09:14:12 -0700 | [diff] [blame] | 453 | .. versionchanged:: 3.4 |
| 454 | |
| 455 | Request.full_url is a property with setter, getter and a deleter. Getting |
| 456 | :attr:`~Request.full_url` returns the original request URL with the |
| 457 | fragment, if it was present. |
| 458 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 459 | .. attribute:: Request.type |
| 460 | |
| 461 | The URI scheme. |
| 462 | |
| 463 | .. attribute:: Request.host |
| 464 | |
| 465 | The URI authority, typically a host, but may also contain a port |
| 466 | separated by a colon. |
| 467 | |
| 468 | .. attribute:: Request.origin_req_host |
| 469 | |
| 470 | The original host for the request, without port. |
| 471 | |
| 472 | .. attribute:: Request.selector |
| 473 | |
| 474 | The URI path. If the :class:`Request` uses a proxy, then selector |
Martin Panter | fe289c0 | 2016-05-28 02:20:39 +0000 | [diff] [blame] | 475 | will be the full URL that is passed to the proxy. |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 476 | |
| 477 | .. attribute:: Request.data |
| 478 | |
Serhiy Storchaka | ecf41da | 2016-10-19 16:29:26 +0300 | [diff] [blame] | 479 | The entity body for the request, or ``None`` if not specified. |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 480 | |
Andrew Svetlov | bff98fe | 2012-11-27 23:06:19 +0200 | [diff] [blame] | 481 | .. versionchanged:: 3.4 |
| 482 | Changing value of :attr:`Request.data` now deletes "Content-Length" |
| 483 | header if it was previously set or calculated. |
| 484 | |
Jeremy Hylton | e257316 | 2009-03-31 14:38:13 +0000 | [diff] [blame] | 485 | .. attribute:: Request.unverifiable |
| 486 | |
| 487 | boolean, indicates whether the request is unverifiable as defined |
| 488 | by RFC 2965. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 489 | |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 490 | .. attribute:: Request.method |
| 491 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 492 | The HTTP request method to use. By default its value is :const:`None`, |
| 493 | which means that :meth:`~Request.get_method` will do its normal computation |
| 494 | of the method to be used. Its value can be set (thus overriding the default |
| 495 | computation in :meth:`~Request.get_method`) either by providing a default |
| 496 | value by setting it at the class level in a :class:`Request` subclass, or by |
| 497 | passing a value in to the :class:`Request` constructor via the *method* |
| 498 | argument. |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 499 | |
Senthil Kumaran | a41c942 | 2011-10-20 02:37:08 +0800 | [diff] [blame] | 500 | .. versionadded:: 3.3 |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 501 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 502 | .. versionchanged:: 3.4 |
| 503 | A default value can now be set in subclasses; previously it could only |
| 504 | be set via the constructor argument. |
| 505 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 506 | |
| 507 | .. method:: Request.get_method() |
| 508 | |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 509 | Return a string indicating the HTTP request method. If |
| 510 | :attr:`Request.method` is not ``None``, return its value, otherwise return |
| 511 | ``'GET'`` if :attr:`Request.data` is ``None``, or ``'POST'`` if it's not. |
| 512 | This is only meaningful for HTTP requests. |
| 513 | |
Florent Xicluna | 95483b6 | 2011-10-19 11:44:51 +0200 | [diff] [blame] | 514 | .. versionchanged:: 3.3 |
Senthil Kumaran | a41c942 | 2011-10-20 02:37:08 +0800 | [diff] [blame] | 515 | get_method now looks at the value of :attr:`Request.method`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 516 | |
| 517 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 518 | .. method:: Request.add_header(key, val) |
| 519 | |
| 520 | Add another header to the request. Headers are currently ignored by all |
| 521 | handlers except HTTP handlers, where they are added to the list of headers sent |
| 522 | to the server. Note that there cannot be more than one header with the same |
| 523 | name, and later calls will overwrite previous calls in case the *key* collides. |
| 524 | Currently, this is no loss of HTTP functionality, since all headers which have |
| 525 | meaning when used more than once have a (header-specific) way of gaining the |
| 526 | same functionality using only one header. |
| 527 | |
| 528 | |
| 529 | .. method:: Request.add_unredirected_header(key, header) |
| 530 | |
| 531 | Add a header that will not be added to a redirected request. |
| 532 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 533 | |
| 534 | .. method:: Request.has_header(header) |
| 535 | |
| 536 | Return whether the instance has the named header (checks both regular and |
| 537 | unredirected). |
| 538 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 539 | |
Andrew Svetlov | bff98fe | 2012-11-27 23:06:19 +0200 | [diff] [blame] | 540 | .. method:: Request.remove_header(header) |
| 541 | |
| 542 | Remove named header from the request instance (both from regular and |
| 543 | unredirected headers). |
| 544 | |
Georg Brandl | c0fc958 | 2012-12-22 10:36:45 +0100 | [diff] [blame] | 545 | .. versionadded:: 3.4 |
| 546 | |
Andrew Svetlov | bff98fe | 2012-11-27 23:06:19 +0200 | [diff] [blame] | 547 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 548 | .. method:: Request.get_full_url() |
| 549 | |
| 550 | Return the URL given in the constructor. |
| 551 | |
Senthil Kumaran | 8307075 | 2013-05-24 09:14:12 -0700 | [diff] [blame] | 552 | .. versionchanged:: 3.4 |
| 553 | |
| 554 | Returns :attr:`Request.full_url` |
| 555 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 556 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 557 | .. method:: Request.set_proxy(host, type) |
| 558 | |
| 559 | Prepare the request by connecting to a proxy server. The *host* and *type* will |
| 560 | replace those of the instance, and the instance's selector will be the original |
| 561 | URL given in the constructor. |
| 562 | |
| 563 | |
Senthil Kumaran | 8dc5004 | 2012-04-29 11:50:39 +0800 | [diff] [blame] | 564 | .. method:: Request.get_header(header_name, default=None) |
| 565 | |
| 566 | Return the value of the given header. If the header is not present, return |
| 567 | the default value. |
| 568 | |
| 569 | |
| 570 | .. method:: Request.header_items() |
| 571 | |
| 572 | Return a list of tuples (header_name, header_value) of the Request headers. |
| 573 | |
Senthil Kumaran | 6ddec17 | 2013-03-19 18:03:39 -0700 | [diff] [blame] | 574 | .. versionchanged:: 3.4 |
Georg Brandl | df48b97 | 2014-03-24 09:06:18 +0100 | [diff] [blame] | 575 | The request methods add_data, has_data, get_data, get_type, get_host, |
| 576 | get_selector, get_origin_req_host and is_unverifiable that were deprecated |
| 577 | since 3.3 have been removed. |
| 578 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 579 | |
| 580 | .. _opener-director-objects: |
| 581 | |
| 582 | OpenerDirector Objects |
| 583 | ---------------------- |
| 584 | |
| 585 | :class:`OpenerDirector` instances have the following methods: |
| 586 | |
| 587 | |
| 588 | .. method:: OpenerDirector.add_handler(handler) |
| 589 | |
| 590 | *handler* should be an instance of :class:`BaseHandler`. The following methods |
| 591 | are searched, and added to the possible chains (note that HTTP errors are a |
| 592 | special case). |
| 593 | |
| 594 | * :meth:`protocol_open` --- signal that the handler knows how to open *protocol* |
| 595 | URLs. |
| 596 | |
| 597 | * :meth:`http_error_type` --- signal that the handler knows how to handle HTTP |
| 598 | errors with HTTP error code *type*. |
| 599 | |
| 600 | * :meth:`protocol_error` --- signal that the handler knows how to handle errors |
| 601 | from (non-\ ``http``) *protocol*. |
| 602 | |
| 603 | * :meth:`protocol_request` --- signal that the handler knows how to pre-process |
| 604 | *protocol* requests. |
| 605 | |
| 606 | * :meth:`protocol_response` --- signal that the handler knows how to |
| 607 | post-process *protocol* responses. |
| 608 | |
| 609 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 610 | .. method:: OpenerDirector.open(url, data=None[, timeout]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 611 | |
| 612 | Open the given *url* (which can be a request object or a string), optionally |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 613 | passing the given *data*. Arguments, return values and exceptions raised are |
| 614 | the same as those of :func:`urlopen` (which simply calls the :meth:`open` |
| 615 | method on the currently installed global :class:`OpenerDirector`). The |
| 616 | optional *timeout* parameter specifies a timeout in seconds for blocking |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 617 | operations like the connection attempt (if not specified, the global default |
Georg Brandl | 325524e | 2010-05-21 20:57:33 +0000 | [diff] [blame] | 618 | timeout setting will be used). The timeout feature actually works only for |
Senthil Kumaran | c08d907 | 2010-10-05 18:46:56 +0000 | [diff] [blame] | 619 | HTTP, HTTPS and FTP connections). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 620 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 621 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 622 | .. method:: OpenerDirector.error(proto, *args) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 623 | |
| 624 | Handle an error of the given protocol. This will call the registered error |
| 625 | handlers for the given protocol with the given arguments (which are protocol |
| 626 | specific). The HTTP protocol is a special case which uses the HTTP response |
| 627 | code to determine the specific error handler; refer to the :meth:`http_error_\*` |
| 628 | methods of the handler classes. |
| 629 | |
| 630 | Return values and exceptions raised are the same as those of :func:`urlopen`. |
| 631 | |
| 632 | OpenerDirector objects open URLs in three stages: |
| 633 | |
| 634 | The order in which these methods are called within each stage is determined by |
| 635 | sorting the handler instances. |
| 636 | |
| 637 | #. Every handler with a method named like :meth:`protocol_request` has that |
| 638 | method called to pre-process the request. |
| 639 | |
| 640 | #. Handlers with a method named like :meth:`protocol_open` are called to handle |
| 641 | the request. This stage ends when a handler either returns a non-\ :const:`None` |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 642 | value (ie. a response), or raises an exception (usually |
| 643 | :exc:`~urllib.error.URLError`). Exceptions are allowed to propagate. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 644 | |
| 645 | In fact, the above algorithm is first tried for methods named |
| 646 | :meth:`default_open`. If all such methods return :const:`None`, the algorithm |
| 647 | is repeated for methods named like :meth:`protocol_open`. If all such methods |
| 648 | return :const:`None`, the algorithm is repeated for methods named |
| 649 | :meth:`unknown_open`. |
| 650 | |
| 651 | Note that the implementation of these methods may involve calls of the parent |
Georg Brandl | a5eacee | 2010-07-23 16:55:26 +0000 | [diff] [blame] | 652 | :class:`OpenerDirector` instance's :meth:`~OpenerDirector.open` and |
| 653 | :meth:`~OpenerDirector.error` methods. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 654 | |
| 655 | #. Every handler with a method named like :meth:`protocol_response` has that |
| 656 | method called to post-process the response. |
| 657 | |
| 658 | |
| 659 | .. _base-handler-objects: |
| 660 | |
| 661 | BaseHandler Objects |
| 662 | ------------------- |
| 663 | |
| 664 | :class:`BaseHandler` objects provide a couple of methods that are directly |
| 665 | useful, and others that are meant to be used by derived classes. These are |
| 666 | intended for direct use: |
| 667 | |
| 668 | |
| 669 | .. method:: BaseHandler.add_parent(director) |
| 670 | |
| 671 | Add a director as parent. |
| 672 | |
| 673 | |
| 674 | .. method:: BaseHandler.close() |
| 675 | |
| 676 | Remove any parents. |
| 677 | |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 678 | The following attribute and methods should only be used by classes derived from |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 679 | :class:`BaseHandler`. |
| 680 | |
| 681 | .. note:: |
| 682 | |
| 683 | The convention has been adopted that subclasses defining |
| 684 | :meth:`protocol_request` or :meth:`protocol_response` methods are named |
| 685 | :class:`\*Processor`; all others are named :class:`\*Handler`. |
| 686 | |
| 687 | |
| 688 | .. attribute:: BaseHandler.parent |
| 689 | |
| 690 | A valid :class:`OpenerDirector`, which can be used to open using a different |
| 691 | protocol, or handle errors. |
| 692 | |
| 693 | |
| 694 | .. method:: BaseHandler.default_open(req) |
| 695 | |
| 696 | This method is *not* defined in :class:`BaseHandler`, but subclasses should |
| 697 | define it if they want to catch all URLs. |
| 698 | |
| 699 | This method, if implemented, will be called by the parent |
| 700 | :class:`OpenerDirector`. It should return a file-like object as described in |
| 701 | the return value of the :meth:`open` of :class:`OpenerDirector`, or ``None``. |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 702 | It should raise :exc:`~urllib.error.URLError`, unless a truly exceptional |
| 703 | thing happens (for example, :exc:`MemoryError` should not be mapped to |
| 704 | :exc:`URLError`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 705 | |
| 706 | This method will be called before any protocol-specific open method. |
| 707 | |
| 708 | |
| 709 | .. method:: BaseHandler.protocol_open(req) |
| 710 | :noindex: |
| 711 | |
| 712 | This method is *not* defined in :class:`BaseHandler`, but subclasses should |
| 713 | define it if they want to handle URLs with the given protocol. |
| 714 | |
| 715 | This method, if defined, will be called by the parent :class:`OpenerDirector`. |
| 716 | Return values should be the same as for :meth:`default_open`. |
| 717 | |
| 718 | |
| 719 | .. method:: BaseHandler.unknown_open(req) |
| 720 | |
| 721 | This method is *not* defined in :class:`BaseHandler`, but subclasses should |
| 722 | define it if they want to catch all URLs with no specific registered handler to |
| 723 | open it. |
| 724 | |
| 725 | This method, if implemented, will be called by the :attr:`parent` |
| 726 | :class:`OpenerDirector`. Return values should be the same as for |
| 727 | :meth:`default_open`. |
| 728 | |
| 729 | |
| 730 | .. method:: BaseHandler.http_error_default(req, fp, code, msg, hdrs) |
| 731 | |
| 732 | This method is *not* defined in :class:`BaseHandler`, but subclasses should |
| 733 | override it if they intend to provide a catch-all for otherwise unhandled HTTP |
| 734 | errors. It will be called automatically by the :class:`OpenerDirector` getting |
| 735 | the error, and should not normally be called in other circumstances. |
| 736 | |
| 737 | *req* will be a :class:`Request` object, *fp* will be a file-like object with |
| 738 | the HTTP error body, *code* will be the three-digit code of the error, *msg* |
| 739 | will be the user-visible explanation of the code and *hdrs* will be a mapping |
| 740 | object with the headers of the error. |
| 741 | |
| 742 | Return values and exceptions raised should be the same as those of |
| 743 | :func:`urlopen`. |
| 744 | |
| 745 | |
| 746 | .. method:: BaseHandler.http_error_nnn(req, fp, code, msg, hdrs) |
| 747 | |
| 748 | *nnn* should be a three-digit HTTP error code. This method is also not defined |
| 749 | in :class:`BaseHandler`, but will be called, if it exists, on an instance of a |
| 750 | subclass, when an HTTP error with code *nnn* occurs. |
| 751 | |
| 752 | Subclasses should override this method to handle specific HTTP errors. |
| 753 | |
| 754 | Arguments, return values and exceptions raised should be the same as for |
| 755 | :meth:`http_error_default`. |
| 756 | |
| 757 | |
| 758 | .. method:: BaseHandler.protocol_request(req) |
| 759 | :noindex: |
| 760 | |
| 761 | This method is *not* defined in :class:`BaseHandler`, but subclasses should |
| 762 | define it if they want to pre-process requests of the given protocol. |
| 763 | |
| 764 | This method, if defined, will be called by the parent :class:`OpenerDirector`. |
| 765 | *req* will be a :class:`Request` object. The return value should be a |
| 766 | :class:`Request` object. |
| 767 | |
| 768 | |
| 769 | .. method:: BaseHandler.protocol_response(req, response) |
| 770 | :noindex: |
| 771 | |
| 772 | This method is *not* defined in :class:`BaseHandler`, but subclasses should |
| 773 | define it if they want to post-process responses of the given protocol. |
| 774 | |
| 775 | This method, if defined, will be called by the parent :class:`OpenerDirector`. |
| 776 | *req* will be a :class:`Request` object. *response* will be an object |
| 777 | implementing the same interface as the return value of :func:`urlopen`. The |
| 778 | return value should implement the same interface as the return value of |
| 779 | :func:`urlopen`. |
| 780 | |
| 781 | |
| 782 | .. _http-redirect-handler: |
| 783 | |
| 784 | HTTPRedirectHandler Objects |
| 785 | --------------------------- |
| 786 | |
| 787 | .. note:: |
| 788 | |
| 789 | Some HTTP redirections require action from this module's client code. If this |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 790 | is the case, :exc:`~urllib.error.HTTPError` is raised. See :rfc:`2616` for |
| 791 | details of the precise meanings of the various redirection codes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 792 | |
guido@google.com | a119df9 | 2011-03-29 11:41:02 -0700 | [diff] [blame] | 793 | An :class:`HTTPError` exception raised as a security consideration if the |
Martin Panter | fe289c0 | 2016-05-28 02:20:39 +0000 | [diff] [blame] | 794 | HTTPRedirectHandler is presented with a redirected URL which is not an HTTP, |
| 795 | HTTPS or FTP URL. |
guido@google.com | a119df9 | 2011-03-29 11:41:02 -0700 | [diff] [blame] | 796 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 797 | |
Georg Brandl | 9617a59 | 2009-02-13 10:40:43 +0000 | [diff] [blame] | 798 | .. method:: HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 799 | |
| 800 | Return a :class:`Request` or ``None`` in response to a redirect. This is called |
| 801 | by the default implementations of the :meth:`http_error_30\*` methods when a |
| 802 | redirection is received from the server. If a redirection should take place, |
| 803 | return a new :class:`Request` to allow :meth:`http_error_30\*` to perform the |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 804 | redirect to *newurl*. Otherwise, raise :exc:`~urllib.error.HTTPError` if |
| 805 | no other handler should try to handle this URL, or return ``None`` if you |
| 806 | can't but another handler might. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 807 | |
| 808 | .. note:: |
| 809 | |
| 810 | The default implementation of this method does not strictly follow :rfc:`2616`, |
| 811 | which says that 301 and 302 responses to ``POST`` requests must not be |
| 812 | automatically redirected without confirmation by the user. In reality, browsers |
| 813 | do allow automatic redirection of these responses, changing the POST to a |
| 814 | ``GET``, and the default implementation reproduces this behavior. |
| 815 | |
| 816 | |
| 817 | .. method:: HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs) |
| 818 | |
Georg Brandl | 9617a59 | 2009-02-13 10:40:43 +0000 | [diff] [blame] | 819 | Redirect to the ``Location:`` or ``URI:`` URL. This method is called by the |
| 820 | parent :class:`OpenerDirector` when getting an HTTP 'moved permanently' response. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 821 | |
| 822 | |
| 823 | .. method:: HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs) |
| 824 | |
| 825 | The same as :meth:`http_error_301`, but called for the 'found' response. |
| 826 | |
| 827 | |
| 828 | .. method:: HTTPRedirectHandler.http_error_303(req, fp, code, msg, hdrs) |
| 829 | |
| 830 | The same as :meth:`http_error_301`, but called for the 'see other' response. |
| 831 | |
| 832 | |
| 833 | .. method:: HTTPRedirectHandler.http_error_307(req, fp, code, msg, hdrs) |
| 834 | |
| 835 | The same as :meth:`http_error_301`, but called for the 'temporary redirect' |
| 836 | response. |
| 837 | |
| 838 | |
| 839 | .. _http-cookie-processor: |
| 840 | |
| 841 | HTTPCookieProcessor Objects |
| 842 | --------------------------- |
| 843 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 844 | :class:`HTTPCookieProcessor` instances have one attribute: |
| 845 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 846 | .. attribute:: HTTPCookieProcessor.cookiejar |
| 847 | |
Georg Brandl | 2442015 | 2008-05-26 16:32:26 +0000 | [diff] [blame] | 848 | The :class:`http.cookiejar.CookieJar` in which cookies are stored. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 849 | |
| 850 | |
| 851 | .. _proxy-handler: |
| 852 | |
| 853 | ProxyHandler Objects |
| 854 | -------------------- |
| 855 | |
| 856 | |
| 857 | .. method:: ProxyHandler.protocol_open(request) |
| 858 | :noindex: |
| 859 | |
| 860 | The :class:`ProxyHandler` will have a method :meth:`protocol_open` for every |
| 861 | *protocol* which has a proxy in the *proxies* dictionary given in the |
| 862 | constructor. The method will modify requests to go through the proxy, by |
| 863 | calling ``request.set_proxy()``, and call the next handler in the chain to |
| 864 | actually execute the protocol. |
| 865 | |
| 866 | |
| 867 | .. _http-password-mgr: |
| 868 | |
| 869 | HTTPPasswordMgr Objects |
| 870 | ----------------------- |
| 871 | |
| 872 | These methods are available on :class:`HTTPPasswordMgr` and |
| 873 | :class:`HTTPPasswordMgrWithDefaultRealm` objects. |
| 874 | |
| 875 | |
| 876 | .. method:: HTTPPasswordMgr.add_password(realm, uri, user, passwd) |
| 877 | |
| 878 | *uri* can be either a single URI, or a sequence of URIs. *realm*, *user* and |
| 879 | *passwd* must be strings. This causes ``(user, passwd)`` to be used as |
| 880 | authentication tokens when authentication for *realm* and a super-URI of any of |
| 881 | the given URIs is given. |
| 882 | |
| 883 | |
| 884 | .. method:: HTTPPasswordMgr.find_user_password(realm, authuri) |
| 885 | |
| 886 | Get user/password for given realm and URI, if any. This method will return |
| 887 | ``(None, None)`` if there is no matching user/password. |
| 888 | |
| 889 | For :class:`HTTPPasswordMgrWithDefaultRealm` objects, the realm ``None`` will be |
| 890 | searched if the given *realm* has no matching user/password. |
| 891 | |
| 892 | |
R David Murray | 4c7f995 | 2015-04-16 16:36:18 -0400 | [diff] [blame] | 893 | .. _http-password-mgr-with-prior-auth: |
| 894 | |
| 895 | HTTPPasswordMgrWithPriorAuth Objects |
| 896 | ------------------------------------ |
| 897 | |
| 898 | This password manager extends :class:`HTTPPasswordMgrWithDefaultRealm` to support |
| 899 | tracking URIs for which authentication credentials should always be sent. |
| 900 | |
| 901 | |
| 902 | .. method:: HTTPPasswordMgrWithPriorAuth.add_password(realm, uri, user, \ |
| 903 | passwd, is_authenticated=False) |
| 904 | |
| 905 | *realm*, *uri*, *user*, *passwd* are as for |
| 906 | :meth:`HTTPPasswordMgr.add_password`. *is_authenticated* sets the initial |
| 907 | value of the ``is_authenticated`` flag for the given URI or list of URIs. |
| 908 | If *is_authenticated* is specified as ``True``, *realm* is ignored. |
| 909 | |
| 910 | |
| 911 | .. method:: HTTPPasswordMgr.find_user_password(realm, authuri) |
| 912 | |
| 913 | Same as for :class:`HTTPPasswordMgrWithDefaultRealm` objects |
| 914 | |
| 915 | |
| 916 | .. method:: HTTPPasswordMgrWithPriorAuth.update_authenticated(self, uri, \ |
| 917 | is_authenticated=False) |
| 918 | |
| 919 | Update the ``is_authenticated`` flag for the given *uri* or list |
| 920 | of URIs. |
| 921 | |
| 922 | |
| 923 | .. method:: HTTPPasswordMgrWithPriorAuth.is_authenticated(self, authuri) |
| 924 | |
| 925 | Returns the current state of the ``is_authenticated`` flag for |
| 926 | the given URI. |
| 927 | |
| 928 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 929 | .. _abstract-basic-auth-handler: |
| 930 | |
| 931 | AbstractBasicAuthHandler Objects |
| 932 | -------------------------------- |
| 933 | |
| 934 | |
| 935 | .. method:: AbstractBasicAuthHandler.http_error_auth_reqed(authreq, host, req, headers) |
| 936 | |
| 937 | Handle an authentication request by getting a user/password pair, and re-trying |
| 938 | the request. *authreq* should be the name of the header where the information |
| 939 | about the realm is included in the request, *host* specifies the URL and path to |
| 940 | authenticate for, *req* should be the (failed) :class:`Request` object, and |
| 941 | *headers* should be the error headers. |
| 942 | |
| 943 | *host* is either an authority (e.g. ``"python.org"``) or a URL containing an |
| 944 | authority component (e.g. ``"http://python.org/"``). In either case, the |
| 945 | authority must not contain a userinfo component (so, ``"python.org"`` and |
| 946 | ``"python.org:80"`` are fine, ``"joe:password@python.org"`` is not). |
| 947 | |
| 948 | |
| 949 | .. _http-basic-auth-handler: |
| 950 | |
| 951 | HTTPBasicAuthHandler Objects |
| 952 | ---------------------------- |
| 953 | |
| 954 | |
| 955 | .. method:: HTTPBasicAuthHandler.http_error_401(req, fp, code, msg, hdrs) |
| 956 | |
| 957 | Retry the request with authentication information, if available. |
| 958 | |
| 959 | |
| 960 | .. _proxy-basic-auth-handler: |
| 961 | |
| 962 | ProxyBasicAuthHandler Objects |
| 963 | ----------------------------- |
| 964 | |
| 965 | |
| 966 | .. method:: ProxyBasicAuthHandler.http_error_407(req, fp, code, msg, hdrs) |
| 967 | |
| 968 | Retry the request with authentication information, if available. |
| 969 | |
| 970 | |
| 971 | .. _abstract-digest-auth-handler: |
| 972 | |
| 973 | AbstractDigestAuthHandler Objects |
| 974 | --------------------------------- |
| 975 | |
| 976 | |
| 977 | .. method:: AbstractDigestAuthHandler.http_error_auth_reqed(authreq, host, req, headers) |
| 978 | |
| 979 | *authreq* should be the name of the header where the information about the realm |
| 980 | is included in the request, *host* should be the host to authenticate to, *req* |
| 981 | should be the (failed) :class:`Request` object, and *headers* should be the |
| 982 | error headers. |
| 983 | |
| 984 | |
| 985 | .. _http-digest-auth-handler: |
| 986 | |
| 987 | HTTPDigestAuthHandler Objects |
| 988 | ----------------------------- |
| 989 | |
| 990 | |
| 991 | .. method:: HTTPDigestAuthHandler.http_error_401(req, fp, code, msg, hdrs) |
| 992 | |
| 993 | Retry the request with authentication information, if available. |
| 994 | |
| 995 | |
| 996 | .. _proxy-digest-auth-handler: |
| 997 | |
| 998 | ProxyDigestAuthHandler Objects |
| 999 | ------------------------------ |
| 1000 | |
| 1001 | |
| 1002 | .. method:: ProxyDigestAuthHandler.http_error_407(req, fp, code, msg, hdrs) |
| 1003 | |
| 1004 | Retry the request with authentication information, if available. |
| 1005 | |
| 1006 | |
| 1007 | .. _http-handler-objects: |
| 1008 | |
| 1009 | HTTPHandler Objects |
| 1010 | ------------------- |
| 1011 | |
| 1012 | |
| 1013 | .. method:: HTTPHandler.http_open(req) |
| 1014 | |
| 1015 | Send an HTTP request, which can be either GET or POST, depending on |
| 1016 | ``req.has_data()``. |
| 1017 | |
| 1018 | |
| 1019 | .. _https-handler-objects: |
| 1020 | |
| 1021 | HTTPSHandler Objects |
| 1022 | -------------------- |
| 1023 | |
| 1024 | |
| 1025 | .. method:: HTTPSHandler.https_open(req) |
| 1026 | |
| 1027 | Send an HTTPS request, which can be either GET or POST, depending on |
| 1028 | ``req.has_data()``. |
| 1029 | |
| 1030 | |
| 1031 | .. _file-handler-objects: |
| 1032 | |
| 1033 | FileHandler Objects |
| 1034 | ------------------- |
| 1035 | |
| 1036 | |
| 1037 | .. method:: FileHandler.file_open(req) |
| 1038 | |
| 1039 | Open the file locally, if there is no host name, or the host name is |
Senthil Kumaran | 383c32d | 2010-10-14 11:57:35 +0000 | [diff] [blame] | 1040 | ``'localhost'``. |
| 1041 | |
Georg Brandl | 61063cc | 2012-06-24 22:48:30 +0200 | [diff] [blame] | 1042 | .. versionchanged:: 3.2 |
| 1043 | This method is applicable only for local hostnames. When a remote |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 1044 | hostname is given, an :exc:`~urllib.error.URLError` is raised. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1045 | |
| 1046 | |
Antoine Pitrou | df204be | 2012-11-24 17:59:08 +0100 | [diff] [blame] | 1047 | .. _data-handler-objects: |
| 1048 | |
| 1049 | DataHandler Objects |
| 1050 | ------------------- |
| 1051 | |
| 1052 | .. method:: DataHandler.data_open(req) |
| 1053 | |
| 1054 | Read a data URL. This kind of URL contains the content encoded in the URL |
| 1055 | itself. The data URL syntax is specified in :rfc:`2397`. This implementation |
| 1056 | ignores white spaces in base64 encoded data URLs so the URL may be wrapped |
| 1057 | in whatever source file it comes from. But even though some browsers don't |
| 1058 | mind about a missing padding at the end of a base64 encoded data URL, this |
| 1059 | implementation will raise an :exc:`ValueError` in that case. |
| 1060 | |
| 1061 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1062 | .. _ftp-handler-objects: |
| 1063 | |
| 1064 | FTPHandler Objects |
| 1065 | ------------------ |
| 1066 | |
| 1067 | |
| 1068 | .. method:: FTPHandler.ftp_open(req) |
| 1069 | |
| 1070 | Open the FTP file indicated by *req*. The login is always done with empty |
| 1071 | username and password. |
| 1072 | |
| 1073 | |
| 1074 | .. _cacheftp-handler-objects: |
| 1075 | |
| 1076 | CacheFTPHandler Objects |
| 1077 | ----------------------- |
| 1078 | |
| 1079 | :class:`CacheFTPHandler` objects are :class:`FTPHandler` objects with the |
| 1080 | following additional methods: |
| 1081 | |
| 1082 | |
| 1083 | .. method:: CacheFTPHandler.setTimeout(t) |
| 1084 | |
| 1085 | Set timeout of connections to *t* seconds. |
| 1086 | |
| 1087 | |
| 1088 | .. method:: CacheFTPHandler.setMaxConns(m) |
| 1089 | |
| 1090 | Set maximum number of cached connections to *m*. |
| 1091 | |
| 1092 | |
| 1093 | .. _unknown-handler-objects: |
| 1094 | |
| 1095 | UnknownHandler Objects |
| 1096 | ---------------------- |
| 1097 | |
| 1098 | |
| 1099 | .. method:: UnknownHandler.unknown_open() |
| 1100 | |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 1101 | Raise a :exc:`~urllib.error.URLError` exception. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1102 | |
| 1103 | |
| 1104 | .. _http-error-processor-objects: |
| 1105 | |
| 1106 | HTTPErrorProcessor Objects |
| 1107 | -------------------------- |
| 1108 | |
Senthil Kumaran | 0215d09 | 2011-07-18 07:12:40 +0800 | [diff] [blame] | 1109 | .. method:: HTTPErrorProcessor.http_response() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1110 | |
| 1111 | Process HTTP error responses. |
| 1112 | |
| 1113 | For 200 error codes, the response object is returned immediately. |
| 1114 | |
| 1115 | For non-200 error codes, this simply passes the job on to the |
| 1116 | :meth:`protocol_error_code` handler methods, via :meth:`OpenerDirector.error`. |
Georg Brandl | 0f7ede4 | 2008-06-23 11:23:31 +0000 | [diff] [blame] | 1117 | Eventually, :class:`HTTPDefaultErrorHandler` will raise an |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 1118 | :exc:`~urllib.error.HTTPError` if no other handler handles the error. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1119 | |
Georg Brandl | 0f7ede4 | 2008-06-23 11:23:31 +0000 | [diff] [blame] | 1120 | |
Senthil Kumaran | 0215d09 | 2011-07-18 07:12:40 +0800 | [diff] [blame] | 1121 | .. method:: HTTPErrorProcessor.https_response() |
| 1122 | |
Senthil Kumaran | 3e7f33f | 2011-07-18 07:17:20 +0800 | [diff] [blame] | 1123 | Process HTTPS error responses. |
| 1124 | |
Senthil Kumaran | 0215d09 | 2011-07-18 07:12:40 +0800 | [diff] [blame] | 1125 | The behavior is same as :meth:`http_response`. |
| 1126 | |
| 1127 | |
Georg Brandl | 0f7ede4 | 2008-06-23 11:23:31 +0000 | [diff] [blame] | 1128 | .. _urllib-request-examples: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1129 | |
| 1130 | Examples |
| 1131 | -------- |
| 1132 | |
Martin Panter | 7aaaded8 | 2016-06-01 08:10:50 +0000 | [diff] [blame] | 1133 | In addition to the examples below, more examples are given in |
| 1134 | :ref:`urllib-howto`. |
| 1135 | |
Senthil Kumaran | 0c2d8b8 | 2010-04-22 10:53:30 +0000 | [diff] [blame] | 1136 | This example gets the python.org main page and displays the first 300 bytes of |
Georg Brandl | bdc55ab | 2010-04-20 18:15:54 +0000 | [diff] [blame] | 1137 | it. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1138 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1139 | >>> import urllib.request |
Berker Peksag | 9575e18 | 2015-04-12 13:52:49 +0300 | [diff] [blame] | 1140 | >>> with urllib.request.urlopen('http://www.python.org/') as f: |
| 1141 | ... print(f.read(300)) |
| 1142 | ... |
Senthil Kumaran | 0c2d8b8 | 2010-04-22 10:53:30 +0000 | [diff] [blame] | 1143 | b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 1144 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html |
| 1145 | xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n |
| 1146 | <meta http-equiv="content-type" content="text/html; charset=utf-8" />\n |
| 1147 | <title>Python Programming ' |
Senthil Kumaran | b213ee3 | 2010-04-15 17:18:22 +0000 | [diff] [blame] | 1148 | |
Senthil Kumaran | 0c2d8b8 | 2010-04-22 10:53:30 +0000 | [diff] [blame] | 1149 | Note that urlopen returns a bytes object. This is because there is no way |
| 1150 | for urlopen to automatically determine the encoding of the byte stream |
Martin Panter | fe289c0 | 2016-05-28 02:20:39 +0000 | [diff] [blame] | 1151 | it receives from the HTTP server. In general, a program will decode |
Senthil Kumaran | 0c2d8b8 | 2010-04-22 10:53:30 +0000 | [diff] [blame] | 1152 | the returned bytes object to string once it determines or guesses |
| 1153 | the appropriate encoding. |
Senthil Kumaran | b213ee3 | 2010-04-15 17:18:22 +0000 | [diff] [blame] | 1154 | |
Serhiy Storchaka | 6dff020 | 2016-05-07 10:49:07 +0300 | [diff] [blame] | 1155 | The following W3C document, https://www.w3.org/International/O-charset\ , lists |
Martin Panter | 204bf0b | 2016-07-11 07:51:37 +0000 | [diff] [blame] | 1156 | the various ways in which an (X)HTML or an XML document could have specified its |
Senthil Kumaran | 0c2d8b8 | 2010-04-22 10:53:30 +0000 | [diff] [blame] | 1157 | encoding information. |
| 1158 | |
Donald Stufft | 8b852f1 | 2014-05-20 12:58:38 -0400 | [diff] [blame] | 1159 | As the python.org website uses *utf-8* encoding as specified in its meta tag, we |
Senthil Kumaran | 21c71ba | 2012-03-13 19:47:51 -0700 | [diff] [blame] | 1160 | will use the same for decoding the bytes object. :: |
| 1161 | |
| 1162 | >>> with urllib.request.urlopen('http://www.python.org/') as f: |
| 1163 | ... print(f.read(100).decode('utf-8')) |
| 1164 | ... |
| 1165 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 1166 | "http://www.w3.org/TR/xhtml1/DTD/xhtm |
| 1167 | |
| 1168 | It is also possible to achieve the same result without using the |
| 1169 | :term:`context manager` approach. :: |
Senthil Kumaran | b213ee3 | 2010-04-15 17:18:22 +0000 | [diff] [blame] | 1170 | |
| 1171 | >>> import urllib.request |
| 1172 | >>> f = urllib.request.urlopen('http://www.python.org/') |
Georg Brandl | fe4fd83 | 2010-05-21 21:01:32 +0000 | [diff] [blame] | 1173 | >>> print(f.read(100).decode('utf-8')) |
Senthil Kumaran | 0c2d8b8 | 2010-04-22 10:53:30 +0000 | [diff] [blame] | 1174 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 1175 | "http://www.w3.org/TR/xhtml1/DTD/xhtm |
| 1176 | |
Senthil Kumaran | b213ee3 | 2010-04-15 17:18:22 +0000 | [diff] [blame] | 1177 | In the following example, we are sending a data-stream to the stdin of a CGI |
| 1178 | and reading the data it returns to us. Note that this example will only work |
| 1179 | when the Python installation supports SSL. :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1180 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1181 | >>> import urllib.request |
| 1182 | >>> req = urllib.request.Request(url='https://localhost/cgi-bin/test.cgi', |
Senthil Kumaran | 2933312 | 2011-02-11 11:25:47 +0000 | [diff] [blame] | 1183 | ... data=b'This data is passed to stdin of the CGI') |
Berker Peksag | 9575e18 | 2015-04-12 13:52:49 +0300 | [diff] [blame] | 1184 | >>> with urllib.request.urlopen(req) as f: |
| 1185 | ... print(f.read().decode('utf-8')) |
| 1186 | ... |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1187 | Got Data: "This data is passed to stdin of the CGI" |
| 1188 | |
| 1189 | The code for the sample CGI used in the above example is:: |
| 1190 | |
| 1191 | #!/usr/bin/env python |
| 1192 | import sys |
| 1193 | data = sys.stdin.read() |
Martin Panter | ac34e09 | 2015-11-14 00:58:32 +0000 | [diff] [blame] | 1194 | print('Content-type: text/plain\n\nGot Data: "%s"' % data) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1195 | |
Senthil Kumaran | e66cc81 | 2013-03-13 13:42:47 -0700 | [diff] [blame] | 1196 | Here is an example of doing a ``PUT`` request using :class:`Request`:: |
| 1197 | |
| 1198 | import urllib.request |
Serhiy Storchaka | dba9039 | 2016-05-10 12:01:23 +0300 | [diff] [blame] | 1199 | DATA = b'some data' |
Senthil Kumaran | e66cc81 | 2013-03-13 13:42:47 -0700 | [diff] [blame] | 1200 | req = urllib.request.Request(url='http://localhost:8080', data=DATA,method='PUT') |
Berker Peksag | 9575e18 | 2015-04-12 13:52:49 +0300 | [diff] [blame] | 1201 | with urllib.request.urlopen(req) as f: |
| 1202 | pass |
Senthil Kumaran | e66cc81 | 2013-03-13 13:42:47 -0700 | [diff] [blame] | 1203 | print(f.status) |
| 1204 | print(f.reason) |
| 1205 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1206 | Use of Basic HTTP Authentication:: |
| 1207 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1208 | import urllib.request |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1209 | # Create an OpenerDirector with support for Basic HTTP Authentication... |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1210 | auth_handler = urllib.request.HTTPBasicAuthHandler() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1211 | auth_handler.add_password(realm='PDQ Application', |
| 1212 | uri='https://mahler:8092/site-updates.py', |
| 1213 | user='klem', |
| 1214 | passwd='kadidd!ehopper') |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1215 | opener = urllib.request.build_opener(auth_handler) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1216 | # ...and install it globally so it can be used with urlopen. |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1217 | urllib.request.install_opener(opener) |
| 1218 | urllib.request.urlopen('http://www.example.com/login.html') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1219 | |
| 1220 | :func:`build_opener` provides many handlers by default, including a |
| 1221 | :class:`ProxyHandler`. By default, :class:`ProxyHandler` uses the environment |
| 1222 | variables named ``<scheme>_proxy``, where ``<scheme>`` is the URL scheme |
| 1223 | involved. For example, the :envvar:`http_proxy` environment variable is read to |
| 1224 | obtain the HTTP proxy's URL. |
| 1225 | |
| 1226 | This example replaces the default :class:`ProxyHandler` with one that uses |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 1227 | programmatically-supplied proxy URLs, and adds proxy authorization support with |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1228 | :class:`ProxyBasicAuthHandler`. :: |
| 1229 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1230 | proxy_handler = urllib.request.ProxyHandler({'http': 'http://www.example.com:3128/'}) |
Senthil Kumaran | 037f836 | 2009-12-24 02:24:37 +0000 | [diff] [blame] | 1231 | proxy_auth_handler = urllib.request.ProxyBasicAuthHandler() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1232 | proxy_auth_handler.add_password('realm', 'host', 'username', 'password') |
| 1233 | |
Senthil Kumaran | 037f836 | 2009-12-24 02:24:37 +0000 | [diff] [blame] | 1234 | opener = urllib.request.build_opener(proxy_handler, proxy_auth_handler) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1235 | # This time, rather than install the OpenerDirector, we use it directly: |
| 1236 | opener.open('http://www.example.com/login.html') |
| 1237 | |
| 1238 | Adding HTTP headers: |
| 1239 | |
| 1240 | Use the *headers* argument to the :class:`Request` constructor, or:: |
| 1241 | |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 1242 | import urllib.request |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1243 | req = urllib.request.Request('http://www.example.com/') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1244 | req.add_header('Referer', 'http://www.python.org/') |
Martin Panter | 7aaaded8 | 2016-06-01 08:10:50 +0000 | [diff] [blame] | 1245 | # Customize the default User-Agent header value: |
| 1246 | req.add_header('User-Agent', 'urllib-example/0.1 (Contact: . . .)') |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1247 | r = urllib.request.urlopen(req) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1248 | |
| 1249 | :class:`OpenerDirector` automatically adds a :mailheader:`User-Agent` header to |
| 1250 | every :class:`Request`. To change this:: |
| 1251 | |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 1252 | import urllib.request |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1253 | opener = urllib.request.build_opener() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1254 | opener.addheaders = [('User-agent', 'Mozilla/5.0')] |
| 1255 | opener.open('http://www.example.com/') |
| 1256 | |
| 1257 | Also, remember that a few standard headers (:mailheader:`Content-Length`, |
Martin Panter | cda85a0 | 2015-11-24 22:33:18 +0000 | [diff] [blame] | 1258 | :mailheader:`Content-Type` and :mailheader:`Host`) |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 1259 | are added when the :class:`Request` is passed to :func:`urlopen` (or |
| 1260 | :meth:`OpenerDirector.open`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1261 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1262 | .. _urllib-examples: |
| 1263 | |
| 1264 | Here is an example session that uses the ``GET`` method to retrieve a URL |
| 1265 | containing parameters:: |
| 1266 | |
| 1267 | >>> import urllib.request |
| 1268 | >>> import urllib.parse |
| 1269 | >>> params = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0}) |
Berker Peksag | 9575e18 | 2015-04-12 13:52:49 +0300 | [diff] [blame] | 1270 | >>> url = "http://www.musi-cal.com/cgi-bin/query?%s" % params |
| 1271 | >>> with urllib.request.urlopen(url) as f: |
| 1272 | ... print(f.read().decode('utf-8')) |
| 1273 | ... |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1274 | |
Senthil Kumaran | 2933312 | 2011-02-11 11:25:47 +0000 | [diff] [blame] | 1275 | The following example uses the ``POST`` method instead. Note that params output |
| 1276 | from urlencode is encoded to bytes before it is sent to urlopen as data:: |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1277 | |
| 1278 | >>> import urllib.request |
| 1279 | >>> import urllib.parse |
Senthil Kumaran | 6b3434a | 2012-03-15 18:11:16 -0700 | [diff] [blame] | 1280 | >>> data = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0}) |
Martin Panter | cda85a0 | 2015-11-24 22:33:18 +0000 | [diff] [blame] | 1281 | >>> data = data.encode('ascii') |
| 1282 | >>> with urllib.request.urlopen("http://requestb.in/xrbl82xr", data) as f: |
Berker Peksag | 9575e18 | 2015-04-12 13:52:49 +0300 | [diff] [blame] | 1283 | ... print(f.read().decode('utf-8')) |
| 1284 | ... |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1285 | |
| 1286 | The following example uses an explicitly specified HTTP proxy, overriding |
| 1287 | environment settings:: |
| 1288 | |
| 1289 | >>> import urllib.request |
| 1290 | >>> proxies = {'http': 'http://proxy.example.com:8080/'} |
| 1291 | >>> opener = urllib.request.FancyURLopener(proxies) |
Berker Peksag | 9575e18 | 2015-04-12 13:52:49 +0300 | [diff] [blame] | 1292 | >>> with opener.open("http://www.python.org") as f: |
| 1293 | ... f.read().decode('utf-8') |
| 1294 | ... |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1295 | |
| 1296 | The following example uses no proxies at all, overriding environment settings:: |
| 1297 | |
| 1298 | >>> import urllib.request |
| 1299 | >>> opener = urllib.request.FancyURLopener({}) |
Berker Peksag | 9575e18 | 2015-04-12 13:52:49 +0300 | [diff] [blame] | 1300 | >>> with opener.open("http://www.python.org/") as f: |
| 1301 | ... f.read().decode('utf-8') |
| 1302 | ... |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1303 | |
| 1304 | |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1305 | Legacy interface |
| 1306 | ---------------- |
| 1307 | |
| 1308 | The following functions and classes are ported from the Python 2 module |
| 1309 | ``urllib`` (as opposed to ``urllib2``). They might become deprecated at |
| 1310 | some point in the future. |
| 1311 | |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1312 | .. function:: urlretrieve(url, filename=None, reporthook=None, data=None) |
| 1313 | |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 1314 | Copy a network object denoted by a URL to a local file. If the URL |
| 1315 | points to a local file, the object will not be copied unless filename is supplied. |
| 1316 | Return a tuple ``(filename, headers)`` where *filename* is the |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1317 | local file name under which the object can be found, and *headers* is whatever |
| 1318 | the :meth:`info` method of the object returned by :func:`urlopen` returned (for |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 1319 | a remote object). Exceptions are the same as for :func:`urlopen`. |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1320 | |
| 1321 | The second argument, if present, specifies the file location to copy to (if |
| 1322 | absent, the location will be a tempfile with a generated name). The third |
| 1323 | argument, if present, is a hook function that will be called once on |
| 1324 | establishment of the network connection and once after each block read |
| 1325 | thereafter. The hook will be passed three arguments; a count of blocks |
| 1326 | transferred so far, a block size in bytes, and the total size of the file. The |
| 1327 | third argument may be ``-1`` on older FTP servers which do not return a file |
| 1328 | size in response to a retrieval request. |
| 1329 | |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 1330 | The following example illustrates the most common usage scenario:: |
| 1331 | |
| 1332 | >>> import urllib.request |
| 1333 | >>> local_filename, headers = urllib.request.urlretrieve('http://python.org/') |
| 1334 | >>> html = open(local_filename) |
| 1335 | >>> html.close() |
| 1336 | |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1337 | If the *url* uses the :file:`http:` scheme identifier, the optional *data* |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 1338 | argument may be given to specify a ``POST`` request (normally the request |
Senthil Kumaran | 87684e6 | 2012-03-14 18:08:13 -0700 | [diff] [blame] | 1339 | type is ``GET``). The *data* argument must be a bytes object in standard |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 1340 | :mimetype:`application/x-www-form-urlencoded` format; see the |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 1341 | :func:`urllib.parse.urlencode` function. |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1342 | |
| 1343 | :func:`urlretrieve` will raise :exc:`ContentTooShortError` when it detects that |
| 1344 | the amount of data available was less than the expected amount (which is the |
| 1345 | size reported by a *Content-Length* header). This can occur, for example, when |
| 1346 | the download is interrupted. |
| 1347 | |
| 1348 | The *Content-Length* is treated as a lower bound: if there's more data to read, |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 1349 | urlretrieve reads more data, but if less data is available, it raises the |
| 1350 | exception. |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1351 | |
| 1352 | You can still retrieve the downloaded data in this case, it is stored in the |
| 1353 | :attr:`content` attribute of the exception instance. |
| 1354 | |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 1355 | If no *Content-Length* header was supplied, urlretrieve can not check the size |
| 1356 | of the data it has downloaded, and just returns it. In this case you just have |
| 1357 | to assume that the download was successful. |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1358 | |
| 1359 | .. function:: urlcleanup() |
| 1360 | |
Senthil Kumaran | e24f96a | 2012-03-13 19:29:33 -0700 | [diff] [blame] | 1361 | Cleans up temporary files that may have been left behind by previous |
| 1362 | calls to :func:`urlretrieve`. |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1363 | |
| 1364 | .. class:: URLopener(proxies=None, **x509) |
| 1365 | |
Senthil Kumaran | 6227c69 | 2013-03-18 17:09:50 -0700 | [diff] [blame] | 1366 | .. deprecated:: 3.3 |
| 1367 | |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1368 | Base class for opening and reading URLs. Unless you need to support opening |
| 1369 | objects using schemes other than :file:`http:`, :file:`ftp:`, or :file:`file:`, |
| 1370 | you probably want to use :class:`FancyURLopener`. |
| 1371 | |
| 1372 | By default, the :class:`URLopener` class sends a :mailheader:`User-Agent` header |
| 1373 | of ``urllib/VVV``, where *VVV* is the :mod:`urllib` version number. |
| 1374 | Applications can define their own :mailheader:`User-Agent` header by subclassing |
| 1375 | :class:`URLopener` or :class:`FancyURLopener` and setting the class attribute |
| 1376 | :attr:`version` to an appropriate string value in the subclass definition. |
| 1377 | |
| 1378 | The optional *proxies* parameter should be a dictionary mapping scheme names to |
| 1379 | proxy URLs, where an empty dictionary turns proxies off completely. Its default |
| 1380 | value is ``None``, in which case environmental proxy settings will be used if |
| 1381 | present, as discussed in the definition of :func:`urlopen`, above. |
| 1382 | |
| 1383 | Additional keyword parameters, collected in *x509*, may be used for |
| 1384 | authentication of the client when using the :file:`https:` scheme. The keywords |
| 1385 | *key_file* and *cert_file* are supported to provide an SSL key and certificate; |
| 1386 | both are needed to support client authentication. |
| 1387 | |
Antoine Pitrou | 4272d6a | 2011-10-12 19:10:10 +0200 | [diff] [blame] | 1388 | :class:`URLopener` objects will raise an :exc:`OSError` exception if the server |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1389 | returns an error code. |
| 1390 | |
| 1391 | .. method:: open(fullurl, data=None) |
| 1392 | |
| 1393 | Open *fullurl* using the appropriate protocol. This method sets up cache and |
| 1394 | proxy information, then calls the appropriate open method with its input |
| 1395 | arguments. If the scheme is not recognized, :meth:`open_unknown` is called. |
| 1396 | The *data* argument has the same meaning as the *data* argument of |
| 1397 | :func:`urlopen`. |
| 1398 | |
| 1399 | |
| 1400 | .. method:: open_unknown(fullurl, data=None) |
| 1401 | |
| 1402 | Overridable interface to open unknown URL types. |
| 1403 | |
| 1404 | |
| 1405 | .. method:: retrieve(url, filename=None, reporthook=None, data=None) |
| 1406 | |
| 1407 | Retrieves the contents of *url* and places it in *filename*. The return value |
Serhiy Storchaka | d65c949 | 2015-11-02 14:10:23 +0200 | [diff] [blame] | 1408 | is a tuple consisting of a local filename and either an |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1409 | :class:`email.message.Message` object containing the response headers (for remote |
| 1410 | URLs) or ``None`` (for local URLs). The caller must then open and read the |
| 1411 | contents of *filename*. If *filename* is not given and the URL refers to a |
| 1412 | local file, the input filename is returned. If the URL is non-local and |
| 1413 | *filename* is not given, the filename is the output of :func:`tempfile.mktemp` |
| 1414 | with a suffix that matches the suffix of the last path component of the input |
| 1415 | URL. If *reporthook* is given, it must be a function accepting three numeric |
Gregory P. Smith | 6b0bdab | 2012-11-10 13:43:44 -0800 | [diff] [blame] | 1416 | parameters: A chunk number, the maximum size chunks are read in and the total size of the download |
| 1417 | (-1 if unknown). It will be called once at the start and after each chunk of data is read from the |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1418 | network. *reporthook* is ignored for local URLs. |
| 1419 | |
| 1420 | If the *url* uses the :file:`http:` scheme identifier, the optional *data* |
| 1421 | argument may be given to specify a ``POST`` request (normally the request type |
| 1422 | is ``GET``). The *data* argument must in standard |
Serhiy Storchaka | 5e1c053 | 2013-10-13 20:06:50 +0300 | [diff] [blame] | 1423 | :mimetype:`application/x-www-form-urlencoded` format; see the |
| 1424 | :func:`urllib.parse.urlencode` function. |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1425 | |
| 1426 | |
| 1427 | .. attribute:: version |
| 1428 | |
| 1429 | Variable that specifies the user agent of the opener object. To get |
| 1430 | :mod:`urllib` to tell servers that it is a particular user agent, set this in a |
| 1431 | subclass as a class variable or in the constructor before calling the base |
| 1432 | constructor. |
| 1433 | |
| 1434 | |
| 1435 | .. class:: FancyURLopener(...) |
| 1436 | |
Senthil Kumaran | 6227c69 | 2013-03-18 17:09:50 -0700 | [diff] [blame] | 1437 | .. deprecated:: 3.3 |
| 1438 | |
Antoine Pitrou | b8eb9cb | 2010-12-15 19:07:26 +0000 | [diff] [blame] | 1439 | :class:`FancyURLopener` subclasses :class:`URLopener` providing default handling |
| 1440 | for the following HTTP response codes: 301, 302, 303, 307 and 401. For the 30x |
| 1441 | response codes listed above, the :mailheader:`Location` header is used to fetch |
| 1442 | the actual URL. For 401 response codes (authentication required), basic HTTP |
| 1443 | authentication is performed. For the 30x response codes, recursion is bounded |
| 1444 | by the value of the *maxtries* attribute, which defaults to 10. |
| 1445 | |
| 1446 | For all other response codes, the method :meth:`http_error_default` is called |
| 1447 | which you can override in subclasses to handle the error appropriately. |
| 1448 | |
| 1449 | .. note:: |
| 1450 | |
| 1451 | According to the letter of :rfc:`2616`, 301 and 302 responses to POST requests |
| 1452 | must not be automatically redirected without confirmation by the user. In |
| 1453 | reality, browsers do allow automatic redirection of these responses, changing |
| 1454 | the POST to a GET, and :mod:`urllib` reproduces this behaviour. |
| 1455 | |
| 1456 | The parameters to the constructor are the same as those for :class:`URLopener`. |
| 1457 | |
| 1458 | .. note:: |
| 1459 | |
| 1460 | When performing basic authentication, a :class:`FancyURLopener` instance calls |
| 1461 | its :meth:`prompt_user_passwd` method. The default implementation asks the |
| 1462 | users for the required information on the controlling terminal. A subclass may |
| 1463 | override this method to support more appropriate behavior if needed. |
| 1464 | |
| 1465 | The :class:`FancyURLopener` class offers one additional method that should be |
| 1466 | overloaded to provide the appropriate behavior: |
| 1467 | |
| 1468 | .. method:: prompt_user_passwd(host, realm) |
| 1469 | |
| 1470 | Return information needed to authenticate the user at the given host in the |
| 1471 | specified security realm. The return value should be a tuple, ``(user, |
| 1472 | password)``, which can be used for basic authentication. |
| 1473 | |
| 1474 | The implementation prompts for this information on the terminal; an application |
| 1475 | should override this method to use an appropriate interaction model in the local |
| 1476 | environment. |
| 1477 | |
| 1478 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1479 | :mod:`urllib.request` Restrictions |
| 1480 | ---------------------------------- |
| 1481 | |
| 1482 | .. index:: |
| 1483 | pair: HTTP; protocol |
| 1484 | pair: FTP; protocol |
| 1485 | |
Florent Xicluna | 83386da | 2011-10-28 22:03:55 +0200 | [diff] [blame] | 1486 | * Currently, only the following protocols are supported: HTTP (versions 0.9 and |
Antoine Pitrou | df204be | 2012-11-24 17:59:08 +0100 | [diff] [blame] | 1487 | 1.0), FTP, local files, and data URLs. |
| 1488 | |
| 1489 | .. versionchanged:: 3.4 Added support for data URLs. |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1490 | |
Florent Xicluna | 305bb66 | 2011-10-28 22:14:41 +0200 | [diff] [blame] | 1491 | * The caching feature of :func:`urlretrieve` has been disabled until someone |
| 1492 | finds the time to hack proper processing of Expiration time headers. |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1493 | |
| 1494 | * There should be a function to query whether a particular URL is in the cache. |
| 1495 | |
| 1496 | * For backward compatibility, if a URL appears to point to a local file but the |
| 1497 | file can't be opened, the URL is re-interpreted using the FTP protocol. This |
| 1498 | can sometimes cause confusing error messages. |
| 1499 | |
| 1500 | * The :func:`urlopen` and :func:`urlretrieve` functions can cause arbitrarily |
| 1501 | long delays while waiting for a network connection to be set up. This means |
| 1502 | that it is difficult to build an interactive Web client using these functions |
| 1503 | without using threads. |
| 1504 | |
| 1505 | .. index:: |
| 1506 | single: HTML |
| 1507 | pair: HTTP; protocol |
| 1508 | |
| 1509 | * The data returned by :func:`urlopen` or :func:`urlretrieve` is the raw data |
| 1510 | returned by the server. This may be binary data (such as an image), plain text |
| 1511 | or (for example) HTML. The HTTP protocol provides type information in the reply |
| 1512 | header, which can be inspected by looking at the :mailheader:`Content-Type` |
| 1513 | header. If the returned data is HTML, you can use the module |
| 1514 | :mod:`html.parser` to parse it. |
| 1515 | |
| 1516 | .. index:: single: FTP |
| 1517 | |
| 1518 | * The code handling the FTP protocol cannot differentiate between a file and a |
| 1519 | directory. This can lead to unexpected behavior when attempting to read a URL |
| 1520 | that points to a file that is not accessible. If the URL ends in a ``/``, it is |
| 1521 | assumed to refer to a directory and will be handled accordingly. But if an |
| 1522 | attempt to read a file leads to a 550 error (meaning the URL cannot be found or |
| 1523 | is not accessible, often for permission reasons), then the path is treated as a |
| 1524 | directory in order to handle the case when a directory is specified by a URL but |
| 1525 | the trailing ``/`` has been left off. This can cause misleading results when |
| 1526 | you try to fetch a file whose read permissions make it inaccessible; the FTP |
| 1527 | code will try to read it, fail with a 550 error, and then perform a directory |
| 1528 | listing for the unreadable file. If fine-grained control is needed, consider |
Éric Araujo | 09eb980 | 2011-03-20 18:30:37 +0100 | [diff] [blame] | 1529 | using the :mod:`ftplib` module, subclassing :class:`FancyURLopener`, or changing |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1530 | *_urlopener* to meet your needs. |
| 1531 | |
Georg Brandl | 0f7ede4 | 2008-06-23 11:23:31 +0000 | [diff] [blame] | 1532 | |
| 1533 | |
Georg Brandl | 8175dae | 2010-11-29 14:53:15 +0000 | [diff] [blame] | 1534 | :mod:`urllib.response` --- Response classes used by urllib |
| 1535 | ========================================================== |
Georg Brandl | 0f7ede4 | 2008-06-23 11:23:31 +0000 | [diff] [blame] | 1536 | |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1537 | .. module:: urllib.response |
| 1538 | :synopsis: Response classes used by urllib. |
| 1539 | |
| 1540 | The :mod:`urllib.response` module defines functions and classes which define a |
Georg Brandl | 0f7ede4 | 2008-06-23 11:23:31 +0000 | [diff] [blame] | 1541 | minimal file like interface, including ``read()`` and ``readline()``. The |
Ezio Melotti | b970142 | 2010-11-18 19:48:27 +0000 | [diff] [blame] | 1542 | typical response object is an addinfourl instance, which defines an ``info()`` |
Georg Brandl | 0f7ede4 | 2008-06-23 11:23:31 +0000 | [diff] [blame] | 1543 | method and that returns headers and a ``geturl()`` method that returns the url. |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 1544 | Functions defined by this module are used internally by the |
| 1545 | :mod:`urllib.request` module. |
| 1546 | |