<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>21.5. urllib.request — Extensible library for opening URLs — Python v3.3.0 documentation</title>
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '3.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python v3.3.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="top" title="Python v3.3.0 documentation" href="../index.html" />
<link rel="up" title="21. Internet Protocols and Support" href="internet.html" />
<link rel="next" title="21.7. urllib.parse — Parse URLs into components" href="urllib.parse.html" />
<link rel="prev" title="21.4. wsgiref — WSGI Utilities and Reference Implementation" href="wsgiref.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
<script type="text/javascript" src="../_static/copybutton.js"></script>
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="urllib.parse.html" title="21.7. urllib.parse — Parse URLs into components"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="wsgiref.html" title="21.4. wsgiref — WSGI Utilities and Reference Implementation"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="http://www.python.org/">Python</a> »</li>
<li><a href="../index.html">3.3.0 Documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="internet.html" accesskey="U">21. Internet Protocols and Support</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-urllib.request">
<span id="urllib-request-extensible-library-for-opening-urls"></span><h1>21.5. <a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><tt class="xref py py-mod docutils literal"><span class="pre">urllib.request</span></tt></a> — Extensible library for opening URLs<a class="headerlink" href="#module-urllib.request" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><tt class="xref py py-mod docutils literal"><span class="pre">urllib.request</span></tt></a> module defines functions and classes which help in
opening URLs (mostly HTTP) in a complex world — basic and digest
authentication, redirections, cookies and more.</p>
<p>The <a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><tt class="xref py py-mod docutils literal"><span class="pre">urllib.request</span></tt></a> module defines the following functions:</p>
<dl class="function">
<dt id="urllib.request.urlopen">
<tt class="descclassname">urllib.request.</tt><tt class="descname">urlopen</tt><big>(</big><em>url</em>, <em>data=None</em><span class="optional">[</span>, <em>timeout</em><span class="optional">]</span>, <em>*</em>, <em>cafile=None</em>, <em>capath=None</em>, <em>cadefault=True</em><big>)</big><a class="headerlink" href="#urllib.request.urlopen" title="Permalink to this definition">¶</a></dt>
<dd><p>Open the URL <em>url</em>, which can be either a string or a
<a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object.</p>
<p><em>data</em> must be a bytes object specifying additional data to be sent to the
server, or <tt class="xref docutils literal"><span class="pre">None</span></tt> if no such data is needed. <em>data</em> may also be an
iterable object and in that case Content-Length value must be specified in
the headers. Currently HTTP requests are the only ones that use <em>data</em>; the
HTTP request will be a POST instead of a GET when the <em>data</em> parameter is
provided.</p>
<p><em>data</em> should be a buffer in the standard
<em class="mimetype">application/x-www-form-urlencoded</em> format. The
<a class="reference internal" href="urllib.parse.html#urllib.parse.urlencode" title="urllib.parse.urlencode"><tt class="xref py py-func docutils literal"><span class="pre">urllib.parse.urlencode()</span></tt></a> function takes a mapping or sequence of
2-tuples and returns a string in this format. It should be encoded to bytes
before being used as the <em>data</em> parameter. The charset parameter in
<tt class="docutils literal"><span class="pre">Content-Type</span></tt> header may be used to specify the encoding. If charset
parameter is not sent with the Content-Type header, the server following the
HTTP 1.1 recommendation may assume that the data is encoded in ISO-8859-1
encoding. It is advisable to use charset parameter with encoding used in
<tt class="docutils literal"><span class="pre">Content-Type</span></tt> header with the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a>.</p>
<p>urllib.request module uses HTTP/1.1 and includes <tt class="docutils literal"><span class="pre">Connection:close</span></tt> header
in its HTTP requests.</p>
<p>The optional <em>timeout</em> parameter specifies a timeout in seconds for
blocking operations like the connection attempt (if not specified,
the global default timeout setting will be used). This actually
only works for HTTP, HTTPS and FTP connections.</p>
<p>The optional <em>cafile</em> and <em>capath</em> parameters specify a set of trusted
CA certificates for HTTPS requests. <em>cafile</em> should point to a single
file containing a bundle of CA certificates, whereas <em>capath</em> should
point to a directory of hashed certificate files. More information can
be found in <a class="reference internal" href="ssl.html#ssl.SSLContext.load_verify_locations" title="ssl.SSLContext.load_verify_locations"><tt class="xref py py-meth docutils literal"><span class="pre">ssl.SSLContext.load_verify_locations()</span></tt></a>.</p>
<p>The <em>cadefault</em> parameter specifies whether to fall back to loading a
default certificate store defined by the underlying OpenSSL library if the
<em>cafile</em> and <em>capath</em> parameters are omitted. This will only work on
some non-Windows platforms.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">If neither <em>cafile</em> nor <em>capath</em> is specified, and <em>cadefault</em> is False,
an HTTPS request will not do any verification of the server’s
certificate.</p>
</div>
<p>This function returns a file-like object that works as a <a class="reference internal" href="../glossary.html#term-context-manager"><em class="xref std std-term">context manager</em></a>,
with two additional methods from the <a class="reference internal" href="#module-urllib.response" title="urllib.response: Response classes used by urllib."><tt class="xref py py-mod docutils literal"><span class="pre">urllib.response</span></tt></a> module</p>
<ul class="simple">
<li><tt class="xref py py-meth docutils literal"><span class="pre">geturl()</span></tt> — return the URL of the resource retrieved,
commonly used to determine if a redirect was followed</li>
<li><tt class="xref py py-meth docutils literal"><span class="pre">info()</span></tt> — return the meta-information of the page, such as headers,
in the form of an <a class="reference internal" href="email.parser.html#email.message_from_string" title="email.message_from_string"><tt class="xref py py-func docutils literal"><span class="pre">email.message_from_string()</span></tt></a> instance (see
<a class="reference external" href="http://www.cs.tut.fi/~jkorpela/http.html">Quick Reference to HTTP Headers</a>)</li>
</ul>
<p>Raises <tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt> on errors.</p>
<p>Note that <tt class="xref docutils literal"><span class="pre">None</span></tt> may be returned if no handler handles the request (though
the default installed global <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> uses
<a class="reference internal" href="#urllib.request.UnknownHandler" title="urllib.request.UnknownHandler"><tt class="xref py py-class docutils literal"><span class="pre">UnknownHandler</span></tt></a> to ensure this never happens).</p>
<p>In addition, default installed <a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> makes sure the requests
are handled through the proxy when they are set.</p>
<p>The legacy <tt class="docutils literal"><span class="pre">urllib.urlopen</span></tt> function from Python 2.6 and earlier has been
discontinued; <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urllib.request.urlopen()</span></tt></a> corresponds to the old
<tt class="docutils literal"><span class="pre">urllib2.urlopen</span></tt>. Proxy handling, which was done by passing a dictionary
parameter to <tt class="docutils literal"><span class="pre">urllib.urlopen</span></tt>, can be obtained by using
<a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> objects.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 3.2:</span> <em>cafile</em> and <em>capath</em> were added.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 3.2:</span> HTTPS virtual hosts are now supported if possible (that is, if
<a class="reference internal" href="ssl.html#ssl.HAS_SNI" title="ssl.HAS_SNI"><tt class="xref py py-data docutils literal"><span class="pre">ssl.HAS_SNI</span></tt></a> is true).</p>
<p class="versionadded">
<span class="versionmodified">New in version 3.2:</span> <em>data</em> can be an iterable object.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 3.3:</span> <em>cadefault</em> was added.</p>
</dd></dl>
<dl class="function">
<dt id="urllib.request.install_opener">
<tt class="descclassname">urllib.request.</tt><tt class="descname">install_opener</tt><big>(</big><em>opener</em><big>)</big><a class="headerlink" href="#urllib.request.install_opener" title="Permalink to this definition">¶</a></dt>
<dd><p>Install an <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> instance as the default global opener.
Installing an opener is only necessary if you want urlopen to use that
opener; otherwise, simply call <a class="reference internal" href="#urllib.request.OpenerDirector.open" title="urllib.request.OpenerDirector.open"><tt class="xref py py-meth docutils literal"><span class="pre">OpenerDirector.open()</span></tt></a> instead of
<a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>. The code does not check for a real
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>, and any class with the appropriate interface will
work.</p>
</dd></dl>
<dl class="function">
<dt id="urllib.request.build_opener">
<tt class="descclassname">urllib.request.</tt><tt class="descname">build_opener</tt><big>(</big><span class="optional">[</span><em>handler</em>, <em>...</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib.request.build_opener" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> instance, which chains the handlers in the
order given. <em>handler</em>s can be either instances of <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, or
subclasses of <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a> (in which case it must be possible to call
the constructor without any parameters). Instances of the following classes
will be in front of the <em>handler</em>s, unless the <em>handler</em>s contain them,
instances of them or subclasses of them: <a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a>,
<a class="reference internal" href="#urllib.request.UnknownHandler" title="urllib.request.UnknownHandler"><tt class="xref py py-class docutils literal"><span class="pre">UnknownHandler</span></tt></a>, <a class="reference internal" href="#urllib.request.HTTPHandler" title="urllib.request.HTTPHandler"><tt class="xref py py-class docutils literal"><span class="pre">HTTPHandler</span></tt></a>, <a class="reference internal" href="#urllib.request.HTTPDefaultErrorHandler" title="urllib.request.HTTPDefaultErrorHandler"><tt class="xref py py-class docutils literal"><span class="pre">HTTPDefaultErrorHandler</span></tt></a>,
<a class="reference internal" href="#urllib.request.HTTPRedirectHandler" title="urllib.request.HTTPRedirectHandler"><tt class="xref py py-class docutils literal"><span class="pre">HTTPRedirectHandler</span></tt></a>, <a class="reference internal" href="#urllib.request.FTPHandler" title="urllib.request.FTPHandler"><tt class="xref py py-class docutils literal"><span class="pre">FTPHandler</span></tt></a>, <a class="reference internal" href="#urllib.request.FileHandler" title="urllib.request.FileHandler"><tt class="xref py py-class docutils literal"><span class="pre">FileHandler</span></tt></a>,
<a class="reference internal" href="#urllib.request.HTTPErrorProcessor" title="urllib.request.HTTPErrorProcessor"><tt class="xref py py-class docutils literal"><span class="pre">HTTPErrorProcessor</span></tt></a>.</p>
<p>If the Python installation has SSL support (i.e., if the <a class="reference internal" href="ssl.html#module-ssl" title="ssl: TLS/SSL wrapper for socket objects"><tt class="xref py py-mod docutils literal"><span class="pre">ssl</span></tt></a> module
can be imported), <a class="reference internal" href="#urllib.request.HTTPSHandler" title="urllib.request.HTTPSHandler"><tt class="xref py py-class docutils literal"><span class="pre">HTTPSHandler</span></tt></a> will also be added.</p>
<p>A <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a> subclass may also change its <tt class="xref py py-attr docutils literal"><span class="pre">handler_order</span></tt>
attribute to modify its position in the handlers list.</p>
</dd></dl>
<dl class="function">
<dt id="urllib.request.pathname2url">
<tt class="descclassname">urllib.request.</tt><tt class="descname">pathname2url</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#urllib.request.pathname2url" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the pathname <em>path</em> from the local syntax for a path to the form used in
the path component of a URL. This does not produce a complete URL. The return
value will already be quoted using the <tt class="xref py py-func docutils literal"><span class="pre">quote()</span></tt> function.</p>
</dd></dl>
<dl class="function">
<dt id="urllib.request.url2pathname">
<tt class="descclassname">urllib.request.</tt><tt class="descname">url2pathname</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#urllib.request.url2pathname" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the path component <em>path</em> from a percent-encoded URL to the local syntax for a
path. This does not accept a complete URL. This function uses <tt class="xref py py-func docutils literal"><span class="pre">unquote()</span></tt>
to decode <em>path</em>.</p>
</dd></dl>
<dl class="function">
<dt id="urllib.request.getproxies">
<tt class="descclassname">urllib.request.</tt><tt class="descname">getproxies</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.getproxies" title="Permalink to this definition">¶</a></dt>
<dd><p>This helper function returns a dictionary of scheme to proxy server URL
mappings. It scans the environment for variables named <tt class="docutils literal"><span class="pre"><scheme>_proxy</span></tt>,
in a case insensitive approach, for all operating systems first, and when it
cannot find it, looks for proxy information from Mac OSX System
Configuration for Mac OS X and Windows Systems Registry for Windows.</p>
</dd></dl>
<p>The following classes are provided:</p>
<dl class="class">
<dt id="urllib.request.Request">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">Request</tt><big>(</big><em>url</em>, <em>data=None</em>, <em>headers={}</em>, <em>origin_req_host=None</em>, <em>unverifiable=False</em>, <em>method=None</em><big>)</big><a class="headerlink" href="#urllib.request.Request" title="Permalink to this definition">¶</a></dt>
<dd><p>This class is an abstraction of a URL request.</p>
<p><em>url</em> should be a string containing a valid URL.</p>
<p><em>data</em> must be a bytes object specifying additional data to send to the
server, or <tt class="xref docutils literal"><span class="pre">None</span></tt> if no such data is needed. Currently HTTP requests are
the only ones that use <em>data</em>; the HTTP request will be a POST instead of a
GET when the <em>data</em> parameter is provided. <em>data</em> should be a buffer in the
standard <em class="mimetype">application/x-www-form-urlencoded</em> format.</p>
<p>The <a class="reference internal" href="urllib.parse.html#urllib.parse.urlencode" title="urllib.parse.urlencode"><tt class="xref py py-func docutils literal"><span class="pre">urllib.parse.urlencode()</span></tt></a> function takes a mapping or sequence of
2-tuples and returns a string in this format. It should be encoded to bytes
before being used as the <em>data</em> parameter. The charset parameter in
<tt class="docutils literal"><span class="pre">Content-Type</span></tt> header may be used to specify the encoding. If charset
parameter is not sent with the Content-Type header, the server following the
HTTP 1.1 recommendation may assume that the data is encoded in ISO-8859-1
encoding. It is advisable to use charset parameter with encoding used in
<tt class="docutils literal"><span class="pre">Content-Type</span></tt> header with the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a>.</p>
<p><em>headers</em> should be a dictionary, and will be treated as if
<a class="reference internal" href="#urllib.request.Request.add_header" title="urllib.request.Request.add_header"><tt class="xref py py-meth docutils literal"><span class="pre">add_header()</span></tt></a> was called with each key and value as arguments.
This is often used to “spoof” the <tt class="docutils literal"><span class="pre">User-Agent</span></tt> header, which is
used by a browser to identify itself – some HTTP servers only
allow requests coming from common browsers as opposed to scripts.
For example, Mozilla Firefox may identify itself as <tt class="docutils literal"><span class="pre">"Mozilla/5.0</span>
<span class="pre">(X11;</span> <span class="pre">U;</span> <span class="pre">Linux</span> <span class="pre">i686)</span> <span class="pre">Gecko/20071127</span> <span class="pre">Firefox/2.0.0.11"</span></tt>, while
<tt class="xref py py-mod docutils literal"><span class="pre">urllib</span></tt>‘s default user agent string is
<tt class="docutils literal"><span class="pre">"Python-urllib/2.6"</span></tt> (on Python 2.6).</p>
<p>An example of using <tt class="docutils literal"><span class="pre">Content-Type</span></tt> header with <em>data</em> argument would be
sending a dictionary like <tt class="docutils literal"><span class="pre">{"Content-Type":"</span> <span class="pre">application/x-www-form-urlencoded;charset=utf-8"}</span></tt></p>
<p>The final two arguments are only of interest for correct handling
of third-party HTTP cookies:</p>
<p><em>origin_req_host</em> should be the request-host of the origin
transaction, as defined by <span class="target" id="index-0"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2965.html"><strong>RFC 2965</strong></a>. It defaults to
<tt class="docutils literal"><span class="pre">http.cookiejar.request_host(self)</span></tt>. This is the host name or IP
address of the original request that was initiated by the user.
For example, if the request is for an image in an HTML document,
this should be the request-host of the request for the page
containing the image.</p>
<p><em>unverifiable</em> should indicate whether the request is unverifiable,
as defined by RFC 2965. It defaults to False. An unverifiable
request is one whose URL the user did not have the option to
approve. For example, if the request is for an image in an HTML
document, and the user had no option to approve the automatic
fetching of the image, this should be true.</p>
<p><em>method</em> should be a string that indicates the HTTP request method that
will be used (e.g. <tt class="docutils literal"><span class="pre">'HEAD'</span></tt>). Its value is stored in the
<a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><tt class="xref py py-attr docutils literal"><span class="pre">method</span></tt></a> attribute and is used by <a class="reference internal" href="#urllib.request.Request.get_method" title="urllib.request.Request.get_method"><tt class="xref py py-meth docutils literal"><span class="pre">get_method()</span></tt></a>.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 3.3:</span> <a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><tt class="xref py py-attr docutils literal"><span class="pre">Request.method</span></tt></a> argument is added to the Request class.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.OpenerDirector">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">OpenerDirector</tt><a class="headerlink" href="#urllib.request.OpenerDirector" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> class opens URLs via <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>s chained
together. It manages the chaining of handlers, and recovery from errors.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.BaseHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">BaseHandler</tt><a class="headerlink" href="#urllib.request.BaseHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the base class for all registered handlers — and handles only the
simple mechanics of registration.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPDefaultErrorHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPDefaultErrorHandler</tt><a class="headerlink" href="#urllib.request.HTTPDefaultErrorHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>A class which defines a default handler for HTTP error responses; all responses
are turned into <tt class="xref py py-exc docutils literal"><span class="pre">HTTPError</span></tt> exceptions.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPRedirectHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPRedirectHandler</tt><a class="headerlink" href="#urllib.request.HTTPRedirectHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>A class to handle redirections.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPCookieProcessor">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPCookieProcessor</tt><big>(</big><em>cookiejar=None</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPCookieProcessor" title="Permalink to this definition">¶</a></dt>
<dd><p>A class to handle HTTP Cookies.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.ProxyHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">ProxyHandler</tt><big>(</big><em>proxies=None</em><big>)</big><a class="headerlink" href="#urllib.request.ProxyHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Cause requests to go through a proxy. If <em>proxies</em> is given, it must be a
dictionary mapping protocol names to URLs of proxies. The default is to read the
list of proxies from the environment variables <span class="target" id="index-1"></span><tt class="xref std std-envvar docutils literal"><span class="pre"><protocol>_proxy</span></tt>.
If no proxy environment variables are set, in a Windows environment, proxy
settings are obtained from the registry’s Internet Settings section and in a
Mac OS X environment, proxy information is retrieved from the OS X System
Configuration Framework.</p>
<p>To disable autodetected proxy pass an empty dictionary.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPPasswordMgr">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPPasswordMgr</tt><a class="headerlink" href="#urllib.request.HTTPPasswordMgr" title="Permalink to this definition">¶</a></dt>
<dd><p>Keep a database of <tt class="docutils literal"><span class="pre">(realm,</span> <span class="pre">uri)</span> <span class="pre">-></span> <span class="pre">(user,</span> <span class="pre">password)</span></tt> mappings.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPPasswordMgrWithDefaultRealm">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPPasswordMgrWithDefaultRealm</tt><a class="headerlink" href="#urllib.request.HTTPPasswordMgrWithDefaultRealm" title="Permalink to this definition">¶</a></dt>
<dd><p>Keep a database of <tt class="docutils literal"><span class="pre">(realm,</span> <span class="pre">uri)</span> <span class="pre">-></span> <span class="pre">(user,</span> <span class="pre">password)</span></tt> mappings. A realm of
<tt class="xref docutils literal"><span class="pre">None</span></tt> is considered a catch-all realm, which is searched if no other realm
fits.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.AbstractBasicAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">AbstractBasicAuthHandler</tt><big>(</big><em>password_mgr=None</em><big>)</big><a class="headerlink" href="#urllib.request.AbstractBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a mixin class that helps with HTTP authentication, both to the remote
host and to a proxy. <em>password_mgr</em>, if given, should be something that is
compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section
<a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be
supported.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPBasicAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPBasicAuthHandler</tt><big>(</big><em>password_mgr=None</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle authentication with the remote host. <em>password_mgr</em>, if given, should
be something that is compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to
section <a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must
be supported. HTTPBasicAuthHandler will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> when
presented with a wrong Authentication scheme.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.ProxyBasicAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">ProxyBasicAuthHandler</tt><big>(</big><em>password_mgr=None</em><big>)</big><a class="headerlink" href="#urllib.request.ProxyBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle authentication with the proxy. <em>password_mgr</em>, if given, should be
something that is compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section
<a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be
supported.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.AbstractDigestAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">AbstractDigestAuthHandler</tt><big>(</big><em>password_mgr=None</em><big>)</big><a class="headerlink" href="#urllib.request.AbstractDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a mixin class that helps with HTTP authentication, both to the remote
host and to a proxy. <em>password_mgr</em>, if given, should be something that is
compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section
<a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be
supported.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPDigestAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPDigestAuthHandler</tt><big>(</big><em>password_mgr=None</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle authentication with the remote host. <em>password_mgr</em>, if given, should
be something that is compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to
section <a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must
be supported. When both Digest Authentication Handler and Basic
Authentication Handler are both added, Digest Authentication is always tried
first. If the Digest Authentication returns a 40x response again, it is sent
to Basic Authentication handler to Handle. This Handler method will raise a
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> when presented with an authentication scheme other than
Digest or Basic.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 3.3:</span> Raise <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> on unsupported Authentication Scheme.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.ProxyDigestAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">ProxyDigestAuthHandler</tt><big>(</big><em>password_mgr=None</em><big>)</big><a class="headerlink" href="#urllib.request.ProxyDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle authentication with the proxy. <em>password_mgr</em>, if given, should be
something that is compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section
<a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be
supported.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPHandler</tt><a class="headerlink" href="#urllib.request.HTTPHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>A class to handle opening of HTTP URLs.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPSHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPSHandler</tt><big>(</big><em>debuglevel=0</em>, <em>context=None</em>, <em>check_hostname=None</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPSHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>A class to handle opening of HTTPS URLs. <em>context</em> and <em>check_hostname</em>
have the same meaning as in <a class="reference internal" href="http.client.html#http.client.HTTPSConnection" title="http.client.HTTPSConnection"><tt class="xref py py-class docutils literal"><span class="pre">http.client.HTTPSConnection</span></tt></a>.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 3.2:</span> <em>context</em> and <em>check_hostname</em> were added.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.FileHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">FileHandler</tt><a class="headerlink" href="#urllib.request.FileHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Open local files.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.FTPHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">FTPHandler</tt><a class="headerlink" href="#urllib.request.FTPHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Open FTP URLs.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.CacheFTPHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">CacheFTPHandler</tt><a class="headerlink" href="#urllib.request.CacheFTPHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Open FTP URLs, keeping a cache of open FTP connections to minimize delays.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.UnknownHandler">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">UnknownHandler</tt><a class="headerlink" href="#urllib.request.UnknownHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>A catch-all class to handle unknown URLs.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.HTTPErrorProcessor">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">HTTPErrorProcessor</tt><a class="headerlink" href="#urllib.request.HTTPErrorProcessor" title="Permalink to this definition">¶</a></dt>
<dd><p>Process HTTP error responses.</p>
</dd></dl>
<div class="section" id="request-objects">
<span id="id1"></span><h2>21.5.1. Request Objects<a class="headerlink" href="#request-objects" title="Permalink to this headline">¶</a></h2>
<p>The following methods describe <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a>‘s public interface,
and so all may be overridden in subclasses. It also defines several
public attributes that can be used by clients to inspect the parsed
request.</p>
<dl class="attribute">
<dt id="urllib.request.Request.full_url">
<tt class="descclassname">Request.</tt><tt class="descname">full_url</tt><a class="headerlink" href="#urllib.request.Request.full_url" title="Permalink to this definition">¶</a></dt>
<dd><p>The original URL passed to the constructor.</p>
</dd></dl>
<dl class="attribute">
<dt id="urllib.request.Request.type">
<tt class="descclassname">Request.</tt><tt class="descname">type</tt><a class="headerlink" href="#urllib.request.Request.type" title="Permalink to this definition">¶</a></dt>
<dd><p>The URI scheme.</p>
</dd></dl>
<dl class="attribute">
<dt id="urllib.request.Request.host">
<tt class="descclassname">Request.</tt><tt class="descname">host</tt><a class="headerlink" href="#urllib.request.Request.host" title="Permalink to this definition">¶</a></dt>
<dd><p>The URI authority, typically a host, but may also contain a port
separated by a colon.</p>
</dd></dl>
<dl class="attribute">
<dt id="urllib.request.Request.origin_req_host">
<tt class="descclassname">Request.</tt><tt class="descname">origin_req_host</tt><a class="headerlink" href="#urllib.request.Request.origin_req_host" title="Permalink to this definition">¶</a></dt>
<dd><p>The original host for the request, without port.</p>
</dd></dl>
<dl class="attribute">
<dt id="urllib.request.Request.selector">
<tt class="descclassname">Request.</tt><tt class="descname">selector</tt><a class="headerlink" href="#urllib.request.Request.selector" title="Permalink to this definition">¶</a></dt>
<dd><p>The URI path. If the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> uses a proxy, then selector
will be the full url that is passed to the proxy.</p>
</dd></dl>
<dl class="attribute">
<dt id="urllib.request.Request.data">
<tt class="descclassname">Request.</tt><tt class="descname">data</tt><a class="headerlink" href="#urllib.request.Request.data" title="Permalink to this definition">¶</a></dt>
<dd><p>The entity body for the request, or None if not specified.</p>
</dd></dl>
<dl class="attribute">
<dt id="urllib.request.Request.unverifiable">
<tt class="descclassname">Request.</tt><tt class="descname">unverifiable</tt><a class="headerlink" href="#urllib.request.Request.unverifiable" title="Permalink to this definition">¶</a></dt>
<dd><p>boolean, indicates whether the request is unverifiable as defined
by RFC 2965.</p>
</dd></dl>
<dl class="attribute">
<dt id="urllib.request.Request.method">
<tt class="descclassname">Request.</tt><tt class="descname">method</tt><a class="headerlink" href="#urllib.request.Request.method" title="Permalink to this definition">¶</a></dt>
<dd><p>The HTTP request method to use. This value is used by
<a class="reference internal" href="#urllib.request.Request.get_method" title="urllib.request.Request.get_method"><tt class="xref py py-meth docutils literal"><span class="pre">get_method()</span></tt></a> to override the computed HTTP request
method that would otherwise be returned. This attribute is initialized with
the value of the <em>method</em> argument passed to the constructor.</p>
<p class="versionadded">
<span class="versionmodified">New in version 3.3.</span> </p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.get_method">
<tt class="descclassname">Request.</tt><tt class="descname">get_method</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.get_method" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a string indicating the HTTP request method. If
<a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><tt class="xref py py-attr docutils literal"><span class="pre">Request.method</span></tt></a> is not <tt class="xref docutils literal"><span class="pre">None</span></tt>, return its value, otherwise return
<tt class="docutils literal"><span class="pre">'GET'</span></tt> if <a class="reference internal" href="#urllib.request.Request.data" title="urllib.request.Request.data"><tt class="xref py py-attr docutils literal"><span class="pre">Request.data</span></tt></a> is <tt class="xref docutils literal"><span class="pre">None</span></tt>, or <tt class="docutils literal"><span class="pre">'POST'</span></tt> if it’s not.
This is only meaningful for HTTP requests.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 3.3:</span> get_method now looks at the value of <a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><tt class="xref py py-attr docutils literal"><span class="pre">Request.method</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.add_header">
<tt class="descclassname">Request.</tt><tt class="descname">add_header</tt><big>(</big><em>key</em>, <em>val</em><big>)</big><a class="headerlink" href="#urllib.request.Request.add_header" title="Permalink to this definition">¶</a></dt>
<dd><p>Add another header to the request. Headers are currently ignored by all
handlers except HTTP handlers, where they are added to the list of headers sent
to the server. Note that there cannot be more than one header with the same
name, and later calls will overwrite previous calls in case the <em>key</em> collides.
Currently, this is no loss of HTTP functionality, since all headers which have
meaning when used more than once have a (header-specific) way of gaining the
same functionality using only one header.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.add_unredirected_header">
<tt class="descclassname">Request.</tt><tt class="descname">add_unredirected_header</tt><big>(</big><em>key</em>, <em>header</em><big>)</big><a class="headerlink" href="#urllib.request.Request.add_unredirected_header" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a header that will not be added to a redirected request.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.has_header">
<tt class="descclassname">Request.</tt><tt class="descname">has_header</tt><big>(</big><em>header</em><big>)</big><a class="headerlink" href="#urllib.request.Request.has_header" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the instance has the named header (checks both regular and
unredirected).</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.get_full_url">
<tt class="descclassname">Request.</tt><tt class="descname">get_full_url</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.get_full_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the URL given in the constructor.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.set_proxy">
<tt class="descclassname">Request.</tt><tt class="descname">set_proxy</tt><big>(</big><em>host</em>, <em>type</em><big>)</big><a class="headerlink" href="#urllib.request.Request.set_proxy" title="Permalink to this definition">¶</a></dt>
<dd><p>Prepare the request by connecting to a proxy server. The <em>host</em> and <em>type</em> will
replace those of the instance, and the instance’s selector will be the original
URL given in the constructor.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.add_data">
<tt class="descclassname">Request.</tt><tt class="descname">add_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#urllib.request.Request.add_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> data to <em>data</em>. This is ignored by all handlers except
HTTP handlers — and there it should be a byte string, and will change the
request to be <tt class="docutils literal"><span class="pre">POST</span></tt> rather than <tt class="docutils literal"><span class="pre">GET</span></tt>. Deprecated in 3.3, use
<a class="reference internal" href="#urllib.request.Request.data" title="urllib.request.Request.data"><tt class="xref py py-attr docutils literal"><span class="pre">Request.data</span></tt></a>.</p>
<p class="deprecated">
<span class="versionmodified">Deprecated since version 3.3.</span> </p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.has_data">
<tt class="descclassname">Request.</tt><tt class="descname">has_data</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.has_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the instance has a non-<tt class="xref docutils literal"><span class="pre">None</span></tt> data. Deprecated in 3.3,
use <a class="reference internal" href="#urllib.request.Request.data" title="urllib.request.Request.data"><tt class="xref py py-attr docutils literal"><span class="pre">Request.data</span></tt></a>.</p>
<p class="deprecated">
<span class="versionmodified">Deprecated since version 3.3.</span> </p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.get_data">
<tt class="descclassname">Request.</tt><tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.get_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the instance’s data. Deprecated in 3.3, use <a class="reference internal" href="#urllib.request.Request.data" title="urllib.request.Request.data"><tt class="xref py py-attr docutils literal"><span class="pre">Request.data</span></tt></a>.</p>
<p class="deprecated">
<span class="versionmodified">Deprecated since version 3.3.</span> </p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.get_type">
<tt class="descclassname">Request.</tt><tt class="descname">get_type</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.get_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the type of the URL — also known as the scheme. Deprecated in 3.3,
use <a class="reference internal" href="#urllib.request.Request.type" title="urllib.request.Request.type"><tt class="xref py py-attr docutils literal"><span class="pre">Request.type</span></tt></a>.</p>
<p class="deprecated">
<span class="versionmodified">Deprecated since version 3.3.</span> </p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.get_host">
<tt class="descclassname">Request.</tt><tt class="descname">get_host</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.get_host" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the host to which a connection will be made. Deprecated in 3.3, use
<a class="reference internal" href="#urllib.request.Request.host" title="urllib.request.Request.host"><tt class="xref py py-attr docutils literal"><span class="pre">Request.host</span></tt></a>.</p>
<p class="deprecated">
<span class="versionmodified">Deprecated since version 3.3.</span> </p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.get_selector">
<tt class="descclassname">Request.</tt><tt class="descname">get_selector</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.get_selector" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the selector — the part of the URL that is sent to the server.
Deprecated in 3.3, use <a class="reference internal" href="#urllib.request.Request.selector" title="urllib.request.Request.selector"><tt class="xref py py-attr docutils literal"><span class="pre">Request.selector</span></tt></a>.</p>
<p class="deprecated">
<span class="versionmodified">Deprecated since version 3.3.</span> </p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.get_header">
<tt class="descclassname">Request.</tt><tt class="descname">get_header</tt><big>(</big><em>header_name</em>, <em>default=None</em><big>)</big><a class="headerlink" href="#urllib.request.Request.get_header" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the value of the given header. If the header is not present, return
the default value.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.header_items">
<tt class="descclassname">Request.</tt><tt class="descname">header_items</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.header_items" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of tuples (header_name, header_value) of the Request headers.</p>
</dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">Request.</tt><tt class="descname">set_proxy</tt><big>(</big><em>host</em>, <em>type</em><big>)</big></dt>
<dd></dd></dl>
<dl class="method">
<dt id="urllib.request.Request.get_origin_req_host">
<tt class="descclassname">Request.</tt><tt class="descname">get_origin_req_host</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.get_origin_req_host" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the request-host of the origin transaction, as defined by
<span class="target" id="index-2"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2965.html"><strong>RFC 2965</strong></a>. See the documentation for the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> constructor.
Deprecated in 3.3, use <a class="reference internal" href="#urllib.request.Request.origin_req_host" title="urllib.request.Request.origin_req_host"><tt class="xref py py-attr docutils literal"><span class="pre">Request.origin_req_host</span></tt></a>.</p>
<p class="deprecated">
<span class="versionmodified">Deprecated since version 3.3.</span> </p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.Request.is_unverifiable">
<tt class="descclassname">Request.</tt><tt class="descname">is_unverifiable</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.Request.is_unverifiable" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the request is unverifiable, as defined by RFC 2965. See the
documentation for the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> constructor. Deprecated in 3.3, use
<a class="reference internal" href="#urllib.request.Request.unverifiable" title="urllib.request.Request.unverifiable"><tt class="xref py py-attr docutils literal"><span class="pre">Request.unverifiable</span></tt></a>.</p>
<p class="deprecated">
<span class="versionmodified">Deprecated since version 3.3.</span> </p>
</dd></dl>
</div>
<div class="section" id="openerdirector-objects">
<span id="opener-director-objects"></span><h2>21.5.2. OpenerDirector Objects<a class="headerlink" href="#openerdirector-objects" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> instances have the following methods:</p>
<dl class="method">
<dt id="urllib.request.OpenerDirector.add_handler">
<tt class="descclassname">OpenerDirector.</tt><tt class="descname">add_handler</tt><big>(</big><em>handler</em><big>)</big><a class="headerlink" href="#urllib.request.OpenerDirector.add_handler" title="Permalink to this definition">¶</a></dt>
<dd><p><em>handler</em> should be an instance of <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>. The following methods
are searched, and added to the possible chains (note that HTTP errors are a
special case).</p>
<ul class="simple">
<li><tt class="xref py py-meth docutils literal"><span class="pre">protocol_open()</span></tt> — signal that the handler knows how to open <em>protocol</em>
URLs.</li>
<li><tt class="xref py py-meth docutils literal"><span class="pre">http_error_type()</span></tt> — signal that the handler knows how to handle HTTP
errors with HTTP error code <em>type</em>.</li>
<li><tt class="xref py py-meth docutils literal"><span class="pre">protocol_error()</span></tt> — signal that the handler knows how to handle errors
from (non-<tt class="docutils literal"><span class="pre">http</span></tt>) <em>protocol</em>.</li>
<li><tt class="xref py py-meth docutils literal"><span class="pre">protocol_request()</span></tt> — signal that the handler knows how to pre-process
<em>protocol</em> requests.</li>
<li><tt class="xref py py-meth docutils literal"><span class="pre">protocol_response()</span></tt> — signal that the handler knows how to
post-process <em>protocol</em> responses.</li>
</ul>
</dd></dl>
<dl class="method">
<dt id="urllib.request.OpenerDirector.open">
<tt class="descclassname">OpenerDirector.</tt><tt class="descname">open</tt><big>(</big><em>url</em>, <em>data=None</em><span class="optional">[</span>, <em>timeout</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib.request.OpenerDirector.open" title="Permalink to this definition">¶</a></dt>
<dd><p>Open the given <em>url</em> (which can be a request object or a string), optionally
passing the given <em>data</em>. Arguments, return values and exceptions raised are
the same as those of <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a> (which simply calls the <a class="reference internal" href="functions.html#open" title="open"><tt class="xref py py-meth docutils literal"><span class="pre">open()</span></tt></a>
method on the currently installed global <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>). The
optional <em>timeout</em> parameter specifies a timeout in seconds for blocking
operations like the connection attempt (if not specified, the global default
timeout setting will be used). The timeout feature actually works only for
HTTP, HTTPS and FTP connections).</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.OpenerDirector.error">
<tt class="descclassname">OpenerDirector.</tt><tt class="descname">error</tt><big>(</big><em>proto</em>, <em>*args</em><big>)</big><a class="headerlink" href="#urllib.request.OpenerDirector.error" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle an error of the given protocol. This will call the registered error
handlers for the given protocol with the given arguments (which are protocol
specific). The HTTP protocol is a special case which uses the HTTP response
code to determine the specific error handler; refer to the <tt class="xref py py-meth docutils literal"><span class="pre">http_error_*()</span></tt>
methods of the handler classes.</p>
<p>Return values and exceptions raised are the same as those of <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>.</p>
</dd></dl>
<p>OpenerDirector objects open URLs in three stages:</p>
<p>The order in which these methods are called within each stage is determined by
sorting the handler instances.</p>
<ol class="arabic">
<li><p class="first">Every handler with a method named like <tt class="xref py py-meth docutils literal"><span class="pre">protocol_request()</span></tt> has that
method called to pre-process the request.</p>
</li>
<li><p class="first">Handlers with a method named like <tt class="xref py py-meth docutils literal"><span class="pre">protocol_open()</span></tt> are called to handle
the request. This stage ends when a handler either returns a non-<a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const xref docutils literal"><span class="pre">None</span></tt></a>
value (ie. a response), or raises an exception (usually <tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt>).
Exceptions are allowed to propagate.</p>
<p>In fact, the above algorithm is first tried for methods named
<tt class="xref py py-meth docutils literal"><span class="pre">default_open()</span></tt>. If all such methods return <a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const xref docutils literal"><span class="pre">None</span></tt></a>, the algorithm
is repeated for methods named like <tt class="xref py py-meth docutils literal"><span class="pre">protocol_open()</span></tt>. If all such methods
return <a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const xref docutils literal"><span class="pre">None</span></tt></a>, the algorithm is repeated for methods named
<tt class="xref py py-meth docutils literal"><span class="pre">unknown_open()</span></tt>.</p>
<p>Note that the implementation of these methods may involve calls of the parent
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> instance’s <a class="reference internal" href="#urllib.request.OpenerDirector.open" title="urllib.request.OpenerDirector.open"><tt class="xref py py-meth docutils literal"><span class="pre">open()</span></tt></a> and
<a class="reference internal" href="#urllib.request.OpenerDirector.error" title="urllib.request.OpenerDirector.error"><tt class="xref py py-meth docutils literal"><span class="pre">error()</span></tt></a> methods.</p>
</li>
<li><p class="first">Every handler with a method named like <tt class="xref py py-meth docutils literal"><span class="pre">protocol_response()</span></tt> has that
method called to post-process the response.</p>
</li>
</ol>
</div>
<div class="section" id="basehandler-objects">
<span id="base-handler-objects"></span><h2>21.5.3. BaseHandler Objects<a class="headerlink" href="#basehandler-objects" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a> objects provide a couple of methods that are directly
useful, and others that are meant to be used by derived classes. These are
intended for direct use:</p>
<dl class="method">
<dt id="urllib.request.BaseHandler.add_parent">
<tt class="descclassname">BaseHandler.</tt><tt class="descname">add_parent</tt><big>(</big><em>director</em><big>)</big><a class="headerlink" href="#urllib.request.BaseHandler.add_parent" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a director as parent.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.BaseHandler.close">
<tt class="descclassname">BaseHandler.</tt><tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.BaseHandler.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove any parents.</p>
</dd></dl>
<p>The following attribute and methods should only be used by classes derived from
<a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The convention has been adopted that subclasses defining
<tt class="xref py py-meth docutils literal"><span class="pre">protocol_request()</span></tt> or <tt class="xref py py-meth docutils literal"><span class="pre">protocol_response()</span></tt> methods are named
<tt class="xref py py-class docutils literal"><span class="pre">*Processor</span></tt>; all others are named <tt class="xref py py-class docutils literal"><span class="pre">*Handler</span></tt>.</p>
</div>
<dl class="attribute">
<dt id="urllib.request.BaseHandler.parent">
<tt class="descclassname">BaseHandler.</tt><tt class="descname">parent</tt><a class="headerlink" href="#urllib.request.BaseHandler.parent" title="Permalink to this definition">¶</a></dt>
<dd><p>A valid <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>, which can be used to open using a different
protocol, or handle errors.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.BaseHandler.default_open">
<tt class="descclassname">BaseHandler.</tt><tt class="descname">default_open</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#urllib.request.BaseHandler.default_open" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is <em>not</em> defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should
define it if they want to catch all URLs.</p>
<p>This method, if implemented, will be called by the parent
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>. It should return a file-like object as described in
the return value of the <a class="reference internal" href="functions.html#open" title="open"><tt class="xref py py-meth docutils literal"><span class="pre">open()</span></tt></a> of <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>, or <tt class="xref docutils literal"><span class="pre">None</span></tt>.
It should raise <tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt>, unless a truly exceptional thing happens (for
example, <a class="reference internal" href="exceptions.html#MemoryError" title="MemoryError"><tt class="xref py py-exc docutils literal"><span class="pre">MemoryError</span></tt></a> should not be mapped to <tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt>).</p>
<p>This method will be called before any protocol-specific open method.</p>
</dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">BaseHandler.</tt><tt class="descname">protocol_open</tt><big>(</big><em>req</em><big>)</big></dt>
<dd><p>This method is <em>not</em> defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should
define it if they want to handle URLs with the given protocol.</p>
<p>This method, if defined, will be called by the parent <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>.
Return values should be the same as for <tt class="xref py py-meth docutils literal"><span class="pre">default_open()</span></tt>.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.BaseHandler.unknown_open">
<tt class="descclassname">BaseHandler.</tt><tt class="descname">unknown_open</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#urllib.request.BaseHandler.unknown_open" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is <em>not</em> defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should
define it if they want to catch all URLs with no specific registered handler to
open it.</p>
<p>This method, if implemented, will be called by the <a class="reference internal" href="#urllib.request.BaseHandler.parent" title="urllib.request.BaseHandler.parent"><tt class="xref py py-attr docutils literal"><span class="pre">parent</span></tt></a>
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>. Return values should be the same as for
<a class="reference internal" href="#urllib.request.BaseHandler.default_open" title="urllib.request.BaseHandler.default_open"><tt class="xref py py-meth docutils literal"><span class="pre">default_open()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.BaseHandler.http_error_default">
<tt class="descclassname">BaseHandler.</tt><tt class="descname">http_error_default</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.BaseHandler.http_error_default" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is <em>not</em> defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should
override it if they intend to provide a catch-all for otherwise unhandled HTTP
errors. It will be called automatically by the <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> getting
the error, and should not normally be called in other circumstances.</p>
<p><em>req</em> will be a <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object, <em>fp</em> will be a file-like object with
the HTTP error body, <em>code</em> will be the three-digit code of the error, <em>msg</em>
will be the user-visible explanation of the code and <em>hdrs</em> will be a mapping
object with the headers of the error.</p>
<p>Return values and exceptions raised should be the same as those of
<a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.BaseHandler.http_error_nnn">
<tt class="descclassname">BaseHandler.</tt><tt class="descname">http_error_nnn</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.BaseHandler.http_error_nnn" title="Permalink to this definition">¶</a></dt>
<dd><p><em>nnn</em> should be a three-digit HTTP error code. This method is also not defined
in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but will be called, if it exists, on an instance of a
subclass, when an HTTP error with code <em>nnn</em> occurs.</p>
<p>Subclasses should override this method to handle specific HTTP errors.</p>
<p>Arguments, return values and exceptions raised should be the same as for
<a class="reference internal" href="#urllib.request.BaseHandler.http_error_default" title="urllib.request.BaseHandler.http_error_default"><tt class="xref py py-meth docutils literal"><span class="pre">http_error_default()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">BaseHandler.</tt><tt class="descname">protocol_request</tt><big>(</big><em>req</em><big>)</big></dt>
<dd><p>This method is <em>not</em> defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should
define it if they want to pre-process requests of the given protocol.</p>
<p>This method, if defined, will be called by the parent <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>.
<em>req</em> will be a <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object. The return value should be a
<a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object.</p>
</dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">BaseHandler.</tt><tt class="descname">protocol_response</tt><big>(</big><em>req</em>, <em>response</em><big>)</big></dt>
<dd><p>This method is <em>not</em> defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should
define it if they want to post-process responses of the given protocol.</p>
<p>This method, if defined, will be called by the parent <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>.
<em>req</em> will be a <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object. <em>response</em> will be an object
implementing the same interface as the return value of <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>. The
return value should implement the same interface as the return value of
<a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>.</p>
</dd></dl>
</div>
<div class="section" id="httpredirecthandler-objects">
<span id="http-redirect-handler"></span><h2>21.5.4. HTTPRedirectHandler Objects<a class="headerlink" href="#httpredirecthandler-objects" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Some HTTP redirections require action from this module’s client code. If this
is the case, <tt class="xref py py-exc docutils literal"><span class="pre">HTTPError</span></tt> is raised. See <span class="target" id="index-3"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2616.html"><strong>RFC 2616</strong></a> for details of the
precise meanings of the various redirection codes.</p>
<p class="last">An <tt class="xref py py-class docutils literal"><span class="pre">HTTPError</span></tt> exception raised as a security consideration if the
HTTPRedirectHandler is presented with a redirected url which is not an HTTP,
HTTPS or FTP url.</p>
</div>
<dl class="method">
<dt id="urllib.request.HTTPRedirectHandler.redirect_request">
<tt class="descclassname">HTTPRedirectHandler.</tt><tt class="descname">redirect_request</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em>, <em>newurl</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPRedirectHandler.redirect_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> or <tt class="xref docutils literal"><span class="pre">None</span></tt> in response to a redirect. This is called
by the default implementations of the <tt class="xref py py-meth docutils literal"><span class="pre">http_error_30*()</span></tt> methods when a
redirection is received from the server. If a redirection should take place,
return a new <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> to allow <tt class="xref py py-meth docutils literal"><span class="pre">http_error_30*()</span></tt> to perform the
redirect to <em>newurl</em>. Otherwise, raise <tt class="xref py py-exc docutils literal"><span class="pre">HTTPError</span></tt> if no other handler
should try to handle this URL, or return <tt class="xref docutils literal"><span class="pre">None</span></tt> if you can’t but another
handler might.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The default implementation of this method does not strictly follow <span class="target" id="index-4"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2616.html"><strong>RFC 2616</strong></a>,
which says that 301 and 302 responses to <tt class="docutils literal"><span class="pre">POST</span></tt> requests must not be
automatically redirected without confirmation by the user. In reality, browsers
do allow automatic redirection of these responses, changing the POST to a
<tt class="docutils literal"><span class="pre">GET</span></tt>, and the default implementation reproduces this behavior.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="urllib.request.HTTPRedirectHandler.http_error_301">
<tt class="descclassname">HTTPRedirectHandler.</tt><tt class="descname">http_error_301</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPRedirectHandler.http_error_301" title="Permalink to this definition">¶</a></dt>
<dd><p>Redirect to the <tt class="docutils literal"><span class="pre">Location:</span></tt> or <tt class="docutils literal"><span class="pre">URI:</span></tt> URL. This method is called by the
parent <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> when getting an HTTP ‘moved permanently’ response.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.HTTPRedirectHandler.http_error_302">
<tt class="descclassname">HTTPRedirectHandler.</tt><tt class="descname">http_error_302</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPRedirectHandler.http_error_302" title="Permalink to this definition">¶</a></dt>
<dd><p>The same as <a class="reference internal" href="#urllib.request.HTTPRedirectHandler.http_error_301" title="urllib.request.HTTPRedirectHandler.http_error_301"><tt class="xref py py-meth docutils literal"><span class="pre">http_error_301()</span></tt></a>, but called for the ‘found’ response.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.HTTPRedirectHandler.http_error_303">
<tt class="descclassname">HTTPRedirectHandler.</tt><tt class="descname">http_error_303</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPRedirectHandler.http_error_303" title="Permalink to this definition">¶</a></dt>
<dd><p>The same as <a class="reference internal" href="#urllib.request.HTTPRedirectHandler.http_error_301" title="urllib.request.HTTPRedirectHandler.http_error_301"><tt class="xref py py-meth docutils literal"><span class="pre">http_error_301()</span></tt></a>, but called for the ‘see other’ response.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.HTTPRedirectHandler.http_error_307">
<tt class="descclassname">HTTPRedirectHandler.</tt><tt class="descname">http_error_307</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPRedirectHandler.http_error_307" title="Permalink to this definition">¶</a></dt>
<dd><p>The same as <a class="reference internal" href="#urllib.request.HTTPRedirectHandler.http_error_301" title="urllib.request.HTTPRedirectHandler.http_error_301"><tt class="xref py py-meth docutils literal"><span class="pre">http_error_301()</span></tt></a>, but called for the ‘temporary redirect’
response.</p>
</dd></dl>
</div>
<div class="section" id="httpcookieprocessor-objects">
<span id="http-cookie-processor"></span><h2>21.5.5. HTTPCookieProcessor Objects<a class="headerlink" href="#httpcookieprocessor-objects" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="#urllib.request.HTTPCookieProcessor" title="urllib.request.HTTPCookieProcessor"><tt class="xref py py-class docutils literal"><span class="pre">HTTPCookieProcessor</span></tt></a> instances have one attribute:</p>
<dl class="attribute">
<dt id="urllib.request.HTTPCookieProcessor.cookiejar">
<tt class="descclassname">HTTPCookieProcessor.</tt><tt class="descname">cookiejar</tt><a class="headerlink" href="#urllib.request.HTTPCookieProcessor.cookiejar" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="http.cookiejar.html#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><tt class="xref py py-class docutils literal"><span class="pre">http.cookiejar.CookieJar</span></tt></a> in which cookies are stored.</p>
</dd></dl>
</div>
<div class="section" id="proxyhandler-objects">
<span id="proxy-handler"></span><h2>21.5.6. ProxyHandler Objects<a class="headerlink" href="#proxyhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt>
<tt class="descclassname">ProxyHandler.</tt><tt class="descname">protocol_open</tt><big>(</big><em>request</em><big>)</big></dt>
<dd><p>The <a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> will have a method <tt class="xref py py-meth docutils literal"><span class="pre">protocol_open()</span></tt> for every
<em>protocol</em> which has a proxy in the <em>proxies</em> dictionary given in the
constructor. The method will modify requests to go through the proxy, by
calling <tt class="docutils literal"><span class="pre">request.set_proxy()</span></tt>, and call the next handler in the chain to
actually execute the protocol.</p>
</dd></dl>
</div>
<div class="section" id="httppasswordmgr-objects">
<span id="http-password-mgr"></span><h2>21.5.7. HTTPPasswordMgr Objects<a class="headerlink" href="#httppasswordmgr-objects" title="Permalink to this headline">¶</a></h2>
<p>These methods are available on <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a> and
<a class="reference internal" href="#urllib.request.HTTPPasswordMgrWithDefaultRealm" title="urllib.request.HTTPPasswordMgrWithDefaultRealm"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgrWithDefaultRealm</span></tt></a> objects.</p>
<dl class="method">
<dt id="urllib.request.HTTPPasswordMgr.add_password">
<tt class="descclassname">HTTPPasswordMgr.</tt><tt class="descname">add_password</tt><big>(</big><em>realm</em>, <em>uri</em>, <em>user</em>, <em>passwd</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPPasswordMgr.add_password" title="Permalink to this definition">¶</a></dt>
<dd><p><em>uri</em> can be either a single URI, or a sequence of URIs. <em>realm</em>, <em>user</em> and
<em>passwd</em> must be strings. This causes <tt class="docutils literal"><span class="pre">(user,</span> <span class="pre">passwd)</span></tt> to be used as
authentication tokens when authentication for <em>realm</em> and a super-URI of any of
the given URIs is given.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.HTTPPasswordMgr.find_user_password">
<tt class="descclassname">HTTPPasswordMgr.</tt><tt class="descname">find_user_password</tt><big>(</big><em>realm</em>, <em>authuri</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPPasswordMgr.find_user_password" title="Permalink to this definition">¶</a></dt>
<dd><p>Get user/password for given realm and URI, if any. This method will return
<tt class="docutils literal"><span class="pre">(None,</span> <span class="pre">None)</span></tt> if there is no matching user/password.</p>
<p>For <a class="reference internal" href="#urllib.request.HTTPPasswordMgrWithDefaultRealm" title="urllib.request.HTTPPasswordMgrWithDefaultRealm"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgrWithDefaultRealm</span></tt></a> objects, the realm <tt class="xref docutils literal"><span class="pre">None</span></tt> will be
searched if the given <em>realm</em> has no matching user/password.</p>
</dd></dl>
</div>
<div class="section" id="abstractbasicauthhandler-objects">
<span id="abstract-basic-auth-handler"></span><h2>21.5.8. AbstractBasicAuthHandler Objects<a class="headerlink" href="#abstractbasicauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.AbstractBasicAuthHandler.http_error_auth_reqed">
<tt class="descclassname">AbstractBasicAuthHandler.</tt><tt class="descname">http_error_auth_reqed</tt><big>(</big><em>authreq</em>, <em>host</em>, <em>req</em>, <em>headers</em><big>)</big><a class="headerlink" href="#urllib.request.AbstractBasicAuthHandler.http_error_auth_reqed" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle an authentication request by getting a user/password pair, and re-trying
the request. <em>authreq</em> should be the name of the header where the information
about the realm is included in the request, <em>host</em> specifies the URL and path to
authenticate for, <em>req</em> should be the (failed) <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object, and
<em>headers</em> should be the error headers.</p>
<p><em>host</em> is either an authority (e.g. <tt class="docutils literal"><span class="pre">"python.org"</span></tt>) or a URL containing an
authority component (e.g. <tt class="docutils literal"><span class="pre">"http://python.org/"</span></tt>). In either case, the
authority must not contain a userinfo component (so, <tt class="docutils literal"><span class="pre">"python.org"</span></tt> and
<tt class="docutils literal"><span class="pre">"python.org:80"</span></tt> are fine, <tt class="docutils literal"><span class="pre">"joe:password@python.org"</span></tt> is not).</p>
</dd></dl>
</div>
<div class="section" id="httpbasicauthhandler-objects">
<span id="http-basic-auth-handler"></span><h2>21.5.9. HTTPBasicAuthHandler Objects<a class="headerlink" href="#httpbasicauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.HTTPBasicAuthHandler.http_error_401">
<tt class="descclassname">HTTPBasicAuthHandler.</tt><tt class="descname">http_error_401</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPBasicAuthHandler.http_error_401" title="Permalink to this definition">¶</a></dt>
<dd><p>Retry the request with authentication information, if available.</p>
</dd></dl>
</div>
<div class="section" id="proxybasicauthhandler-objects">
<span id="proxy-basic-auth-handler"></span><h2>21.5.10. ProxyBasicAuthHandler Objects<a class="headerlink" href="#proxybasicauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.ProxyBasicAuthHandler.http_error_407">
<tt class="descclassname">ProxyBasicAuthHandler.</tt><tt class="descname">http_error_407</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.ProxyBasicAuthHandler.http_error_407" title="Permalink to this definition">¶</a></dt>
<dd><p>Retry the request with authentication information, if available.</p>
</dd></dl>
</div>
<div class="section" id="abstractdigestauthhandler-objects">
<span id="abstract-digest-auth-handler"></span><h2>21.5.11. AbstractDigestAuthHandler Objects<a class="headerlink" href="#abstractdigestauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.AbstractDigestAuthHandler.http_error_auth_reqed">
<tt class="descclassname">AbstractDigestAuthHandler.</tt><tt class="descname">http_error_auth_reqed</tt><big>(</big><em>authreq</em>, <em>host</em>, <em>req</em>, <em>headers</em><big>)</big><a class="headerlink" href="#urllib.request.AbstractDigestAuthHandler.http_error_auth_reqed" title="Permalink to this definition">¶</a></dt>
<dd><p><em>authreq</em> should be the name of the header where the information about the realm
is included in the request, <em>host</em> should be the host to authenticate to, <em>req</em>
should be the (failed) <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object, and <em>headers</em> should be the
error headers.</p>
</dd></dl>
</div>
<div class="section" id="httpdigestauthhandler-objects">
<span id="http-digest-auth-handler"></span><h2>21.5.12. HTTPDigestAuthHandler Objects<a class="headerlink" href="#httpdigestauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.HTTPDigestAuthHandler.http_error_401">
<tt class="descclassname">HTTPDigestAuthHandler.</tt><tt class="descname">http_error_401</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPDigestAuthHandler.http_error_401" title="Permalink to this definition">¶</a></dt>
<dd><p>Retry the request with authentication information, if available.</p>
</dd></dl>
</div>
<div class="section" id="proxydigestauthhandler-objects">
<span id="proxy-digest-auth-handler"></span><h2>21.5.13. ProxyDigestAuthHandler Objects<a class="headerlink" href="#proxydigestauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.ProxyDigestAuthHandler.http_error_407">
<tt class="descclassname">ProxyDigestAuthHandler.</tt><tt class="descname">http_error_407</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>hdrs</em><big>)</big><a class="headerlink" href="#urllib.request.ProxyDigestAuthHandler.http_error_407" title="Permalink to this definition">¶</a></dt>
<dd><p>Retry the request with authentication information, if available.</p>
</dd></dl>
</div>
<div class="section" id="httphandler-objects">
<span id="http-handler-objects"></span><h2>21.5.14. HTTPHandler Objects<a class="headerlink" href="#httphandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.HTTPHandler.http_open">
<tt class="descclassname">HTTPHandler.</tt><tt class="descname">http_open</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPHandler.http_open" title="Permalink to this definition">¶</a></dt>
<dd><p>Send an HTTP request, which can be either GET or POST, depending on
<tt class="docutils literal"><span class="pre">req.has_data()</span></tt>.</p>
</dd></dl>
</div>
<div class="section" id="httpshandler-objects">
<span id="https-handler-objects"></span><h2>21.5.15. HTTPSHandler Objects<a class="headerlink" href="#httpshandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.HTTPSHandler.https_open">
<tt class="descclassname">HTTPSHandler.</tt><tt class="descname">https_open</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#urllib.request.HTTPSHandler.https_open" title="Permalink to this definition">¶</a></dt>
<dd><p>Send an HTTPS request, which can be either GET or POST, depending on
<tt class="docutils literal"><span class="pre">req.has_data()</span></tt>.</p>
</dd></dl>
</div>
<div class="section" id="filehandler-objects">
<span id="file-handler-objects"></span><h2>21.5.16. FileHandler Objects<a class="headerlink" href="#filehandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.FileHandler.file_open">
<tt class="descclassname">FileHandler.</tt><tt class="descname">file_open</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#urllib.request.FileHandler.file_open" title="Permalink to this definition">¶</a></dt>
<dd><p>Open the file locally, if there is no host name, or the host name is
<tt class="docutils literal"><span class="pre">'localhost'</span></tt>.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 3.2:</span> This method is applicable only for local hostnames. When a remote
hostname is given, an <tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt> is raised.</p>
</dd></dl>
</div>
<div class="section" id="ftphandler-objects">
<span id="ftp-handler-objects"></span><h2>21.5.17. FTPHandler Objects<a class="headerlink" href="#ftphandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.FTPHandler.ftp_open">
<tt class="descclassname">FTPHandler.</tt><tt class="descname">ftp_open</tt><big>(</big><em>req</em><big>)</big><a class="headerlink" href="#urllib.request.FTPHandler.ftp_open" title="Permalink to this definition">¶</a></dt>
<dd><p>Open the FTP file indicated by <em>req</em>. The login is always done with empty
username and password.</p>
</dd></dl>
</div>
<div class="section" id="cacheftphandler-objects">
<span id="cacheftp-handler-objects"></span><h2>21.5.18. CacheFTPHandler Objects<a class="headerlink" href="#cacheftphandler-objects" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="#urllib.request.CacheFTPHandler" title="urllib.request.CacheFTPHandler"><tt class="xref py py-class docutils literal"><span class="pre">CacheFTPHandler</span></tt></a> objects are <a class="reference internal" href="#urllib.request.FTPHandler" title="urllib.request.FTPHandler"><tt class="xref py py-class docutils literal"><span class="pre">FTPHandler</span></tt></a> objects with the
following additional methods:</p>
<dl class="method">
<dt id="urllib.request.CacheFTPHandler.setTimeout">
<tt class="descclassname">CacheFTPHandler.</tt><tt class="descname">setTimeout</tt><big>(</big><em>t</em><big>)</big><a class="headerlink" href="#urllib.request.CacheFTPHandler.setTimeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Set timeout of connections to <em>t</em> seconds.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.CacheFTPHandler.setMaxConns">
<tt class="descclassname">CacheFTPHandler.</tt><tt class="descname">setMaxConns</tt><big>(</big><em>m</em><big>)</big><a class="headerlink" href="#urllib.request.CacheFTPHandler.setMaxConns" title="Permalink to this definition">¶</a></dt>
<dd><p>Set maximum number of cached connections to <em>m</em>.</p>
</dd></dl>
</div>
<div class="section" id="unknownhandler-objects">
<span id="unknown-handler-objects"></span><h2>21.5.19. UnknownHandler Objects<a class="headerlink" href="#unknownhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.UnknownHandler.unknown_open">
<tt class="descclassname">UnknownHandler.</tt><tt class="descname">unknown_open</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.UnknownHandler.unknown_open" title="Permalink to this definition">¶</a></dt>
<dd><p>Raise a <tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt> exception.</p>
</dd></dl>
</div>
<div class="section" id="httperrorprocessor-objects">
<span id="http-error-processor-objects"></span><h2>21.5.20. HTTPErrorProcessor Objects<a class="headerlink" href="#httperrorprocessor-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib.request.HTTPErrorProcessor.http_response">
<tt class="descclassname">HTTPErrorProcessor.</tt><tt class="descname">http_response</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.HTTPErrorProcessor.http_response" title="Permalink to this definition">¶</a></dt>
<dd><p>Process HTTP error responses.</p>
<p>For 200 error codes, the response object is returned immediately.</p>
<p>For non-200 error codes, this simply passes the job on to the
<tt class="xref py py-meth docutils literal"><span class="pre">protocol_error_code()</span></tt> handler methods, via <a class="reference internal" href="#urllib.request.OpenerDirector.error" title="urllib.request.OpenerDirector.error"><tt class="xref py py-meth docutils literal"><span class="pre">OpenerDirector.error()</span></tt></a>.
Eventually, <a class="reference internal" href="#urllib.request.HTTPDefaultErrorHandler" title="urllib.request.HTTPDefaultErrorHandler"><tt class="xref py py-class docutils literal"><span class="pre">HTTPDefaultErrorHandler</span></tt></a> will raise an
<tt class="xref py py-exc docutils literal"><span class="pre">HTTPError</span></tt> if no other handler handles the error.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.HTTPErrorProcessor.https_response">
<tt class="descclassname">HTTPErrorProcessor.</tt><tt class="descname">https_response</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.HTTPErrorProcessor.https_response" title="Permalink to this definition">¶</a></dt>
<dd><p>Process HTTPS error responses.</p>
<p>The behavior is same as <a class="reference internal" href="#urllib.request.HTTPErrorProcessor.http_response" title="urllib.request.HTTPErrorProcessor.http_response"><tt class="xref py py-meth docutils literal"><span class="pre">http_response()</span></tt></a>.</p>
</dd></dl>
</div>
<div class="section" id="examples">
<span id="urllib-request-examples"></span><h2>21.5.21. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>This example gets the python.org main page and displays the first 300 bytes of
it.</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="s">'http://www.python.org/'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">300</span><span class="p">))</span>
<span class="go">b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"</span>
<span class="go">"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html</span>
<span class="go">xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n</span>
<span class="go"><meta http-equiv="content-type" content="text/html; charset=utf-8" />\n</span>
<span class="go"><title>Python Programming '</span>
</pre></div>
</div>
<p>Note that urlopen returns a bytes object. This is because there is no way
for urlopen to automatically determine the encoding of the byte stream
it receives from the http server. In general, a program will decode
the returned bytes object to string once it determines or guesses
the appropriate encoding.</p>
<p>The following W3C document, <a class="reference external" href="http://www.w3.org/International/O-charset">http://www.w3.org/International/O-charset</a> , lists
the various ways in which a (X)HTML or a XML document could have specified its
encoding information.</p>
<p>As the python.org website uses <em>utf-8</em> encoding as specified in it’s meta tag, we
will use the same for decoding the bytes object.</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">with</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="s">'http://www.python.org/'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">))</span>
<span class="gp">...</span>
<span class="go"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"</span>
<span class="go">"http://www.w3.org/TR/xhtml1/DTD/xhtm</span>
</pre></div>
</div>
<p>It is also possible to achieve the same result without using the
<a class="reference internal" href="../glossary.html#term-context-manager"><em class="xref std std-term">context manager</em></a> approach.</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="s">'http://www.python.org/'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">))</span>
<span class="go"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"</span>
<span class="go">"http://www.w3.org/TR/xhtml1/DTD/xhtm</span>
</pre></div>
</div>
<p>In the following example, we are sending a data-stream to the stdin of a CGI
and reading the data it returns to us. Note that this example will only work
when the Python installation supports SSL.</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="gp">>>> </span><span class="n">req</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">Request</span><span class="p">(</span><span class="n">url</span><span class="o">=</span><span class="s">'https://localhost/cgi-bin/test.cgi'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">data</span><span class="o">=</span><span class="n">b</span><span class="s">'This data is passed to stdin of the CGI'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="n">req</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">))</span>
<span class="go">Got Data: "This data is passed to stdin of the CGI"</span>
</pre></div>
</div>
<p>The code for the sample CGI used in the above example is:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="c">#!/usr/bin/env python</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="s">'Content-type: text-plain</span><span class="se">\n\n</span><span class="s">Got Data: "%s"'</span> <span class="o">%</span> <span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
<p>Use of Basic HTTP Authentication:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="c"># Create an OpenerDirector with support for Basic HTTP Authentication...</span>
<span class="n">auth_handler</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">HTTPBasicAuthHandler</span><span class="p">()</span>
<span class="n">auth_handler</span><span class="o">.</span><span class="n">add_password</span><span class="p">(</span><span class="n">realm</span><span class="o">=</span><span class="s">'PDQ Application'</span><span class="p">,</span>
<span class="n">uri</span><span class="o">=</span><span class="s">'https://mahler:8092/site-updates.py'</span><span class="p">,</span>
<span class="n">user</span><span class="o">=</span><span class="s">'klem'</span><span class="p">,</span>
<span class="n">passwd</span><span class="o">=</span><span class="s">'kadidd!ehopper'</span><span class="p">)</span>
<span class="n">opener</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">build_opener</span><span class="p">(</span><span class="n">auth_handler</span><span class="p">)</span>
<span class="c"># ...and install it globally so it can be used with urlopen.</span>
<span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">install_opener</span><span class="p">(</span><span class="n">opener</span><span class="p">)</span>
<span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="s">'http://www.example.com/login.html'</span><span class="p">)</span>
</pre></div>
</div>
<p><a class="reference internal" href="#urllib.request.build_opener" title="urllib.request.build_opener"><tt class="xref py py-func docutils literal"><span class="pre">build_opener()</span></tt></a> provides many handlers by default, including a
<a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a>. By default, <a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> uses the environment
variables named <tt class="docutils literal"><span class="pre"><scheme>_proxy</span></tt>, where <tt class="docutils literal"><span class="pre"><scheme></span></tt> is the URL scheme
involved. For example, the <span class="target" id="index-5"></span><tt class="xref std std-envvar docutils literal"><span class="pre">http_proxy</span></tt> environment variable is read to
obtain the HTTP proxy’s URL.</p>
<p>This example replaces the default <a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> with one that uses
programmatically-supplied proxy URLs, and adds proxy authorization support with
<a class="reference internal" href="#urllib.request.ProxyBasicAuthHandler" title="urllib.request.ProxyBasicAuthHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyBasicAuthHandler</span></tt></a>.</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="n">proxy_handler</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">ProxyHandler</span><span class="p">({</span><span class="s">'http'</span><span class="p">:</span> <span class="s">'http://www.example.com:3128/'</span><span class="p">})</span>
<span class="n">proxy_auth_handler</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">ProxyBasicAuthHandler</span><span class="p">()</span>
<span class="n">proxy_auth_handler</span><span class="o">.</span><span class="n">add_password</span><span class="p">(</span><span class="s">'realm'</span><span class="p">,</span> <span class="s">'host'</span><span class="p">,</span> <span class="s">'username'</span><span class="p">,</span> <span class="s">'password'</span><span class="p">)</span>
<span class="n">opener</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">build_opener</span><span class="p">(</span><span class="n">proxy_handler</span><span class="p">,</span> <span class="n">proxy_auth_handler</span><span class="p">)</span>
<span class="c"># This time, rather than install the OpenerDirector, we use it directly:</span>
<span class="n">opener</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s">'http://www.example.com/login.html'</span><span class="p">)</span>
</pre></div>
</div>
<p>Adding HTTP headers:</p>
<p>Use the <em>headers</em> argument to the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> constructor, or:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="n">req</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">Request</span><span class="p">(</span><span class="s">'http://www.example.com/'</span><span class="p">)</span>
<span class="n">req</span><span class="o">.</span><span class="n">add_header</span><span class="p">(</span><span class="s">'Referer'</span><span class="p">,</span> <span class="s">'http://www.python.org/'</span><span class="p">)</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="n">req</span><span class="p">)</span>
</pre></div>
</div>
<p><a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> automatically adds a <em class="mailheader">User-Agent</em> header to
every <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a>. To change this:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="n">opener</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">build_opener</span><span class="p">()</span>
<span class="n">opener</span><span class="o">.</span><span class="n">addheaders</span> <span class="o">=</span> <span class="p">[(</span><span class="s">'User-agent'</span><span class="p">,</span> <span class="s">'Mozilla/5.0'</span><span class="p">)]</span>
<span class="n">opener</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s">'http://www.example.com/'</span><span class="p">)</span>
</pre></div>
</div>
<p>Also, remember that a few standard headers (<em class="mailheader">Content-Length</em>,
<em class="mailheader">Content-Type</em> without charset parameter and <em class="mailheader">Host</em>)
are added when the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> is passed to <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a> (or
<a class="reference internal" href="#urllib.request.OpenerDirector.open" title="urllib.request.OpenerDirector.open"><tt class="xref py py-meth docutils literal"><span class="pre">OpenerDirector.open()</span></tt></a>).</p>
<p id="urllib-examples">Here is an example session that uses the <tt class="docutils literal"><span class="pre">GET</span></tt> method to retrieve a URL
containing parameters:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.parse</span>
<span class="gp">>>> </span><span class="n">params</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlencode</span><span class="p">({</span><span class="s">'spam'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s">'eggs'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s">'bacon'</span><span class="p">:</span> <span class="mi">0</span><span class="p">})</span>
<span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="s">"http://www.musi-cal.com/cgi-bin/query?%s"</span> <span class="o">%</span> <span class="n">params</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">))</span>
</pre></div>
</div>
<p>The following example uses the <tt class="docutils literal"><span class="pre">POST</span></tt> method instead. Note that params output
from urlencode is encoded to bytes before it is sent to urlopen as data:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.parse</span>
<span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlencode</span><span class="p">({</span><span class="s">'spam'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s">'eggs'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s">'bacon'</span><span class="p">:</span> <span class="mi">0</span><span class="p">})</span>
<span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">request</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">Request</span><span class="p">(</span><span class="s">"http://requestb.in/xrbl82xr"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="c"># adding charset parameter to the Content-Type header.</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">add_header</span><span class="p">(</span><span class="s">"Content-Type"</span><span class="p">,</span><span class="s">"application/x-www-form-urlencoded;charset=utf-8"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlopen</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">))</span>
</pre></div>
</div>
<p>The following example uses an explicitly specified HTTP proxy, overriding
environment settings:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="gp">>>> </span><span class="n">proxies</span> <span class="o">=</span> <span class="p">{</span><span class="s">'http'</span><span class="p">:</span> <span class="s">'http://proxy.example.com:8080/'</span><span class="p">}</span>
<span class="gp">>>> </span><span class="n">opener</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">FancyURLopener</span><span class="p">(</span><span class="n">proxies</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="n">opener</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s">"http://www.python.org"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">)</span>
</pre></div>
</div>
<p>The following example uses no proxies at all, overriding environment settings:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="gp">>>> </span><span class="n">opener</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">FancyURLopener</span><span class="p">({})</span>
<span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="n">opener</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s">"http://www.python.org/"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="legacy-interface">
<h2>21.5.22. Legacy interface<a class="headerlink" href="#legacy-interface" title="Permalink to this headline">¶</a></h2>
<p>The following functions and classes are ported from the Python 2 module
<tt class="docutils literal"><span class="pre">urllib</span></tt> (as opposed to <tt class="docutils literal"><span class="pre">urllib2</span></tt>). They might become deprecated at
some point in the future.</p>
<dl class="function">
<dt id="urllib.request.urlretrieve">
<tt class="descclassname">urllib.request.</tt><tt class="descname">urlretrieve</tt><big>(</big><em>url</em>, <em>filename=None</em>, <em>reporthook=None</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#urllib.request.urlretrieve" title="Permalink to this definition">¶</a></dt>
<dd><p>Copy a network object denoted by a URL to a local file. If the URL
points to a local file, the object will not be copied unless filename is supplied.
Return a tuple <tt class="docutils literal"><span class="pre">(filename,</span> <span class="pre">headers)</span></tt> where <em>filename</em> is the
local file name under which the object can be found, and <em>headers</em> is whatever
the <tt class="xref py py-meth docutils literal"><span class="pre">info()</span></tt> method of the object returned by <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a> returned (for
a remote object). Exceptions are the same as for <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>.</p>
<p>The second argument, if present, specifies the file location to copy to (if
absent, the location will be a tempfile with a generated name). The third
argument, if present, is a hook function that will be called once on
establishment of the network connection and once after each block read
thereafter. The hook will be passed three arguments; a count of blocks
transferred so far, a block size in bytes, and the total size of the file. The
third argument may be <tt class="docutils literal"><span class="pre">-1</span></tt> on older FTP servers which do not return a file
size in response to a retrieval request.</p>
<p>The following example illustrates the most common usage scenario:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib.request</span>
<span class="gp">>>> </span><span class="n">local_filename</span><span class="p">,</span> <span class="n">headers</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlretrieve</span><span class="p">(</span><span class="s">'http://python.org/'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">html</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">local_filename</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">html</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
<p>If the <em>url</em> uses the <tt class="file docutils literal"><span class="pre">http:</span></tt> scheme identifier, the optional <em>data</em>
argument may be given to specify a <tt class="docutils literal"><span class="pre">POST</span></tt> request (normally the request
type is <tt class="docutils literal"><span class="pre">GET</span></tt>). The <em>data</em> argument must be a bytes object in standard
<em class="mimetype">application/x-www-form-urlencoded</em> format; see the
<tt class="xref py py-func docutils literal"><span class="pre">urlencode()</span></tt> function below.</p>
<p><a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><tt class="xref py py-func docutils literal"><span class="pre">urlretrieve()</span></tt></a> will raise <tt class="xref py py-exc docutils literal"><span class="pre">ContentTooShortError</span></tt> when it detects that
the amount of data available was less than the expected amount (which is the
size reported by a <em>Content-Length</em> header). This can occur, for example, when
the download is interrupted.</p>
<p>The <em>Content-Length</em> is treated as a lower bound: if there’s more data to read,
urlretrieve reads more data, but if less data is available, it raises the
exception.</p>
<p>You can still retrieve the downloaded data in this case, it is stored in the
<tt class="xref py py-attr docutils literal"><span class="pre">content</span></tt> attribute of the exception instance.</p>
<p>If no <em>Content-Length</em> header was supplied, urlretrieve can not check the size
of the data it has downloaded, and just returns it. In this case you just have
to assume that the download was successful.</p>
</dd></dl>
<dl class="function">
<dt id="urllib.request.urlcleanup">
<tt class="descclassname">urllib.request.</tt><tt class="descname">urlcleanup</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib.request.urlcleanup" title="Permalink to this definition">¶</a></dt>
<dd><p>Cleans up temporary files that may have been left behind by previous
calls to <a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><tt class="xref py py-func docutils literal"><span class="pre">urlretrieve()</span></tt></a>.</p>
</dd></dl>
<dl class="class">
<dt id="urllib.request.URLopener">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">URLopener</tt><big>(</big><em>proxies=None</em>, <em>**x509</em><big>)</big><a class="headerlink" href="#urllib.request.URLopener" title="Permalink to this definition">¶</a></dt>
<dd><p>Base class for opening and reading URLs. Unless you need to support opening
objects using schemes other than <tt class="file docutils literal"><span class="pre">http:</span></tt>, <tt class="file docutils literal"><span class="pre">ftp:</span></tt>, or <tt class="file docutils literal"><span class="pre">file:</span></tt>,
you probably want to use <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><tt class="xref py py-class docutils literal"><span class="pre">FancyURLopener</span></tt></a>.</p>
<p>By default, the <a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><tt class="xref py py-class docutils literal"><span class="pre">URLopener</span></tt></a> class sends a <em class="mailheader">User-Agent</em> header
of <tt class="docutils literal"><span class="pre">urllib/VVV</span></tt>, where <em>VVV</em> is the <tt class="xref py py-mod docutils literal"><span class="pre">urllib</span></tt> version number.
Applications can define their own <em class="mailheader">User-Agent</em> header by subclassing
<a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><tt class="xref py py-class docutils literal"><span class="pre">URLopener</span></tt></a> or <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><tt class="xref py py-class docutils literal"><span class="pre">FancyURLopener</span></tt></a> and setting the class attribute
<a class="reference internal" href="#urllib.request.URLopener.version" title="urllib.request.URLopener.version"><tt class="xref py py-attr docutils literal"><span class="pre">version</span></tt></a> to an appropriate string value in the subclass definition.</p>
<p>The optional <em>proxies</em> parameter should be a dictionary mapping scheme names to
proxy URLs, where an empty dictionary turns proxies off completely. Its default
value is <tt class="xref docutils literal"><span class="pre">None</span></tt>, in which case environmental proxy settings will be used if
present, as discussed in the definition of <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>, above.</p>
<p>Additional keyword parameters, collected in <em>x509</em>, may be used for
authentication of the client when using the <tt class="file docutils literal"><span class="pre">https:</span></tt> scheme. The keywords
<em>key_file</em> and <em>cert_file</em> are supported to provide an SSL key and certificate;
both are needed to support client authentication.</p>
<p><a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><tt class="xref py py-class docutils literal"><span class="pre">URLopener</span></tt></a> objects will raise an <a class="reference internal" href="exceptions.html#OSError" title="OSError"><tt class="xref py py-exc docutils literal"><span class="pre">OSError</span></tt></a> exception if the server
returns an error code.</p>
<blockquote>
<div><dl class="method">
<dt id="urllib.request.URLopener.open">
<tt class="descname">open</tt><big>(</big><em>fullurl</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#urllib.request.URLopener.open" title="Permalink to this definition">¶</a></dt>
<dd><p>Open <em>fullurl</em> using the appropriate protocol. This method sets up cache and
proxy information, then calls the appropriate open method with its input
arguments. If the scheme is not recognized, <a class="reference internal" href="#urllib.request.URLopener.open_unknown" title="urllib.request.URLopener.open_unknown"><tt class="xref py py-meth docutils literal"><span class="pre">open_unknown()</span></tt></a> is called.
The <em>data</em> argument has the same meaning as the <em>data</em> argument of
<a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.URLopener.open_unknown">
<tt class="descname">open_unknown</tt><big>(</big><em>fullurl</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#urllib.request.URLopener.open_unknown" title="Permalink to this definition">¶</a></dt>
<dd><p>Overridable interface to open unknown URL types.</p>
</dd></dl>
<dl class="method">
<dt id="urllib.request.URLopener.retrieve">
<tt class="descname">retrieve</tt><big>(</big><em>url</em>, <em>filename=None</em>, <em>reporthook=None</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#urllib.request.URLopener.retrieve" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the contents of <em>url</em> and places it in <em>filename</em>. The return value
is a tuple consisting of a local filename and either a
<a class="reference internal" href="email.message.html#email.message.Message" title="email.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">email.message.Message</span></tt></a> object containing the response headers (for remote
URLs) or <tt class="xref docutils literal"><span class="pre">None</span></tt> (for local URLs). The caller must then open and read the
contents of <em>filename</em>. If <em>filename</em> is not given and the URL refers to a
local file, the input filename is returned. If the URL is non-local and
<em>filename</em> is not given, the filename is the output of <a class="reference internal" href="tempfile.html#tempfile.mktemp" title="tempfile.mktemp"><tt class="xref py py-func docutils literal"><span class="pre">tempfile.mktemp()</span></tt></a>
with a suffix that matches the suffix of the last path component of the input
URL. If <em>reporthook</em> is given, it must be a function accepting three numeric
parameters. It will be called after each chunk of data is read from the
network. <em>reporthook</em> is ignored for local URLs.</p>
<p>If the <em>url</em> uses the <tt class="file docutils literal"><span class="pre">http:</span></tt> scheme identifier, the optional <em>data</em>
argument may be given to specify a <tt class="docutils literal"><span class="pre">POST</span></tt> request (normally the request type
is <tt class="docutils literal"><span class="pre">GET</span></tt>). The <em>data</em> argument must in standard
<em class="mimetype">application/x-www-form-urlencoded</em> format; see the <tt class="xref py py-func docutils literal"><span class="pre">urlencode()</span></tt>
function below.</p>
</dd></dl>
<dl class="attribute">
<dt id="urllib.request.URLopener.version">
<tt class="descname">version</tt><a class="headerlink" href="#urllib.request.URLopener.version" title="Permalink to this definition">¶</a></dt>
<dd><p>Variable that specifies the user agent of the opener object. To get
<tt class="xref py py-mod docutils literal"><span class="pre">urllib</span></tt> to tell servers that it is a particular user agent, set this in a
subclass as a class variable or in the constructor before calling the base
constructor.</p>
</dd></dl>
</div></blockquote>
</dd></dl>
<dl class="class">
<dt id="urllib.request.FancyURLopener">
<em class="property">class </em><tt class="descclassname">urllib.request.</tt><tt class="descname">FancyURLopener</tt><big>(</big><em>...</em><big>)</big><a class="headerlink" href="#urllib.request.FancyURLopener" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><tt class="xref py py-class docutils literal"><span class="pre">FancyURLopener</span></tt></a> subclasses <a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><tt class="xref py py-class docutils literal"><span class="pre">URLopener</span></tt></a> providing default handling
for the following HTTP response codes: 301, 302, 303, 307 and 401. For the 30x
response codes listed above, the <em class="mailheader">Location</em> header is used to fetch
the actual URL. For 401 response codes (authentication required), basic HTTP
authentication is performed. For the 30x response codes, recursion is bounded
by the value of the <em>maxtries</em> attribute, which defaults to 10.</p>
<p>For all other response codes, the method <tt class="xref py py-meth docutils literal"><span class="pre">http_error_default()</span></tt> is called
which you can override in subclasses to handle the error appropriately.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">According to the letter of <span class="target" id="index-6"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2616.html"><strong>RFC 2616</strong></a>, 301 and 302 responses to POST requests
must not be automatically redirected without confirmation by the user. In
reality, browsers do allow automatic redirection of these responses, changing
the POST to a GET, and <tt class="xref py py-mod docutils literal"><span class="pre">urllib</span></tt> reproduces this behaviour.</p>
</div>
<p>The parameters to the constructor are the same as those for <a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><tt class="xref py py-class docutils literal"><span class="pre">URLopener</span></tt></a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">When performing basic authentication, a <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><tt class="xref py py-class docutils literal"><span class="pre">FancyURLopener</span></tt></a> instance calls
its <a class="reference internal" href="#urllib.request.FancyURLopener.prompt_user_passwd" title="urllib.request.FancyURLopener.prompt_user_passwd"><tt class="xref py py-meth docutils literal"><span class="pre">prompt_user_passwd()</span></tt></a> method. The default implementation asks the
users for the required information on the controlling terminal. A subclass may
override this method to support more appropriate behavior if needed.</p>
</div>
<p>The <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><tt class="xref py py-class docutils literal"><span class="pre">FancyURLopener</span></tt></a> class offers one additional method that should be
overloaded to provide the appropriate behavior:</p>
<dl class="method">
<dt id="urllib.request.FancyURLopener.prompt_user_passwd">
<tt class="descname">prompt_user_passwd</tt><big>(</big><em>host</em>, <em>realm</em><big>)</big><a class="headerlink" href="#urllib.request.FancyURLopener.prompt_user_passwd" title="Permalink to this definition">¶</a></dt>
<dd><p>Return information needed to authenticate the user at the given host in the
specified security realm. The return value should be a tuple, <tt class="docutils literal"><span class="pre">(user,</span>
<span class="pre">password)</span></tt>, which can be used for basic authentication.</p>
<p>The implementation prompts for this information on the terminal; an application
should override this method to use an appropriate interaction model in the local
environment.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="urllib-request-restrictions">
<h2>21.5.23. <a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><tt class="xref py py-mod docutils literal"><span class="pre">urllib.request</span></tt></a> Restrictions<a class="headerlink" href="#urllib-request-restrictions" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div></div></blockquote>
<ul id="index-7">
<li><p class="first">Currently, only the following protocols are supported: HTTP (versions 0.9 and
1.0), FTP, and local files.</p>
</li>
<li><p class="first">The caching feature of <a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><tt class="xref py py-func docutils literal"><span class="pre">urlretrieve()</span></tt></a> has been disabled until someone
finds the time to hack proper processing of Expiration time headers.</p>
</li>
<li><p class="first">There should be a function to query whether a particular URL is in the cache.</p>
</li>
<li><p class="first">For backward compatibility, if a URL appears to point to a local file but the
file can’t be opened, the URL is re-interpreted using the FTP protocol. This
can sometimes cause confusing error messages.</p>
</li>
<li><p class="first">The <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a> and <a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><tt class="xref py py-func docutils literal"><span class="pre">urlretrieve()</span></tt></a> functions can cause arbitrarily
long delays while waiting for a network connection to be set up. This means
that it is difficult to build an interactive Web client using these functions
without using threads.</p>
</li>
<li id="index-8"><p class="first">The data returned by <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a> or <a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><tt class="xref py py-func docutils literal"><span class="pre">urlretrieve()</span></tt></a> is the raw data
returned by the server. This may be binary data (such as an image), plain text
or (for example) HTML. The HTTP protocol provides type information in the reply
header, which can be inspected by looking at the <em class="mailheader">Content-Type</em>
header. If the returned data is HTML, you can use the module
<a class="reference internal" href="html.parser.html#module-html.parser" title="html.parser: A simple parser that can handle HTML and XHTML."><tt class="xref py py-mod docutils literal"><span class="pre">html.parser</span></tt></a> to parse it.</p>
</li>
<li id="index-9"><p class="first">The code handling the FTP protocol cannot differentiate between a file and a
directory. This can lead to unexpected behavior when attempting to read a URL
that points to a file that is not accessible. If the URL ends in a <tt class="docutils literal"><span class="pre">/</span></tt>, it is
assumed to refer to a directory and will be handled accordingly. But if an
attempt to read a file leads to a 550 error (meaning the URL cannot be found or
is not accessible, often for permission reasons), then the path is treated as a
directory in order to handle the case when a directory is specified by a URL but
the trailing <tt class="docutils literal"><span class="pre">/</span></tt> has been left off. This can cause misleading results when
you try to fetch a file whose read permissions make it inaccessible; the FTP
code will try to read it, fail with a 550 error, and then perform a directory
listing for the unreadable file. If fine-grained control is needed, consider
using the <a class="reference internal" href="ftplib.html#module-ftplib" title="ftplib: FTP protocol client (requires sockets)."><tt class="xref py py-mod docutils literal"><span class="pre">ftplib</span></tt></a> module, subclassing <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><tt class="xref py py-class docutils literal"><span class="pre">FancyURLopener</span></tt></a>, or changing
<em>_urlopener</em> to meet your needs.</p>
</li>
</ul>
</div>
</div>
<div class="section" id="module-urllib.response">
<span id="urllib-response-response-classes-used-by-urllib"></span><h1>21.6. <a class="reference internal" href="#module-urllib.response" title="urllib.response: Response classes used by urllib."><tt class="xref py py-mod docutils literal"><span class="pre">urllib.response</span></tt></a> — Response classes used by urllib<a class="headerlink" href="#module-urllib.response" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference internal" href="#module-urllib.response" title="urllib.response: Response classes used by urllib."><tt class="xref py py-mod docutils literal"><span class="pre">urllib.response</span></tt></a> module defines functions and classes which define a
minimal file like interface, including <tt class="docutils literal"><span class="pre">read()</span></tt> and <tt class="docutils literal"><span class="pre">readline()</span></tt>. The
typical response object is an addinfourl instance, which defines an <tt class="docutils literal"><span class="pre">info()</span></tt>
method and that returns headers and a <tt class="docutils literal"><span class="pre">geturl()</span></tt> method that returns the url.
Functions defined by this module are used internally by the
<a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><tt class="xref py py-mod docutils literal"><span class="pre">urllib.request</span></tt></a> module.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">21.5. <tt class="docutils literal"><span class="pre">urllib.request</span></tt> — Extensible library for opening URLs</a><ul>
<li><a class="reference internal" href="#request-objects">21.5.1. Request Objects</a></li>
<li><a class="reference internal" href="#openerdirector-objects">21.5.2. OpenerDirector Objects</a></li>
<li><a class="reference internal" href="#basehandler-objects">21.5.3. BaseHandler Objects</a></li>
<li><a class="reference internal" href="#httpredirecthandler-objects">21.5.4. HTTPRedirectHandler Objects</a></li>
<li><a class="reference internal" href="#httpcookieprocessor-objects">21.5.5. HTTPCookieProcessor Objects</a></li>
<li><a class="reference internal" href="#proxyhandler-objects">21.5.6. ProxyHandler Objects</a></li>
<li><a class="reference internal" href="#httppasswordmgr-objects">21.5.7. HTTPPasswordMgr Objects</a></li>
<li><a class="reference internal" href="#abstractbasicauthhandler-objects">21.5.8. AbstractBasicAuthHandler Objects</a></li>
<li><a class="reference internal" href="#httpbasicauthhandler-objects">21.5.9. HTTPBasicAuthHandler Objects</a></li>
<li><a class="reference internal" href="#proxybasicauthhandler-objects">21.5.10. ProxyBasicAuthHandler Objects</a></li>
<li><a class="reference internal" href="#abstractdigestauthhandler-objects">21.5.11. AbstractDigestAuthHandler Objects</a></li>
<li><a class="reference internal" href="#httpdigestauthhandler-objects">21.5.12. HTTPDigestAuthHandler Objects</a></li>
<li><a class="reference internal" href="#proxydigestauthhandler-objects">21.5.13. ProxyDigestAuthHandler Objects</a></li>
<li><a class="reference internal" href="#httphandler-objects">21.5.14. HTTPHandler Objects</a></li>
<li><a class="reference internal" href="#httpshandler-objects">21.5.15. HTTPSHandler Objects</a></li>
<li><a class="reference internal" href="#filehandler-objects">21.5.16. FileHandler Objects</a></li>
<li><a class="reference internal" href="#ftphandler-objects">21.5.17. FTPHandler Objects</a></li>
<li><a class="reference internal" href="#cacheftphandler-objects">21.5.18. CacheFTPHandler Objects</a></li>
<li><a class="reference internal" href="#unknownhandler-objects">21.5.19. UnknownHandler Objects</a></li>
<li><a class="reference internal" href="#httperrorprocessor-objects">21.5.20. HTTPErrorProcessor Objects</a></li>
<li><a class="reference internal" href="#examples">21.5.21. Examples</a></li>
<li><a class="reference internal" href="#legacy-interface">21.5.22. Legacy interface</a></li>
<li><a class="reference internal" href="#urllib-request-restrictions">21.5.23. <tt class="docutils literal"><span class="pre">urllib.request</span></tt> Restrictions</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-urllib.response">21.6. <tt class="docutils literal"><span class="pre">urllib.response</span></tt> — Response classes used by urllib</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="wsgiref.html"
title="previous chapter">21.4. <tt class="docutils literal docutils literal"><span class="pre">wsgiref</span></tt> — WSGI Utilities and Reference Implementation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="urllib.parse.html"
title="next chapter">21.7. <tt class="docutils literal docutils literal docutils literal"><span class="pre">urllib.parse</span></tt> — Parse URLs into components</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../bugs.html">Report a Bug</a></li>
<li><a href="../_sources/library/urllib.request.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="urllib.parse.html" title="21.7. urllib.parse — Parse URLs into components"
>next</a> |</li>
<li class="right" >
<a href="wsgiref.html" title="21.4. wsgiref — WSGI Utilities and Reference Implementation"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="http://www.python.org/">Python</a> »</li>
<li><a href="../index.html">3.3.0 Documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="internet.html" >21. Internet Protocols and Support</a> »</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 1990-2012, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="http://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Sep 29, 2012.
<a href="../bugs.html">Found a bug</a>?
<br />
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
distrib
>
Mageia
>
3
>
i586
>
media
>
core-updates
>
by-pkgid
>
50402eac2a16508b365658612a898528
>
files
>
856
