<!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.6. urllib2 — extensible library for opening URLs — Python v2.6.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.6.5',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python v2.6.5 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 v2.6.5 documentation" href="../index.html" />
<link rel="up" title="21. Internet Protocols and Support" href="internet.html" />
<link rel="next" title="21.7. httplib — HTTP protocol client" href="httplib.html" />
<link rel="prev" title="21.5. urllib — Open arbitrary resources by URL" href="urllib.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
</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="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="httplib.html" title="21.7. httplib — HTTP protocol client"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="urllib.html" title="21.5. urllib — Open arbitrary resources by URL"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 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-urllib2">
<h1>21.6. <tt class="xref docutils literal"><span class="pre">urllib2</span></tt> — extensible library for opening URLs<a class="headerlink" href="#module-urllib2" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The <tt class="xref docutils literal"><span class="pre">urllib2</span></tt> module has been split across several modules in
Python 3.0 named <tt class="xref docutils literal"><span class="pre">urllib.request</span></tt> and <tt class="xref docutils literal"><span class="pre">urllib.error</span></tt>.
The <a class="reference external" href="../glossary.html#term-to3"><em class="xref">2to3</em></a> tool will automatically adapt imports when converting
your sources to 3.0.</p>
</div>
<p>The <tt class="xref docutils literal"><span class="pre">urllib2</span></tt> 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 <tt class="xref docutils literal"><span class="pre">urllib2</span></tt> module defines the following functions:</p>
<dl class="function">
<dt id="urllib2.urlopen">
<tt class="descclassname">urllib2.</tt><tt class="descname">urlopen</tt><big>(</big><em>url</em><span class="optional">[</span>, <em>data</em><span class="optional">]</span><span class="optional">[</span>, <em>timeout</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.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 title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a> object.</p>
<p><em>data</em> may be a string 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>application/x-www-form-urlencoded</em> format. The
<a title="urllib.urlencode" class="reference external" href="urllib.html#urllib.urlencode"><tt class="xref docutils literal"><span class="pre">urllib.urlencode()</span></tt></a> function takes a mapping or sequence of 2-tuples and
returns a string in this format.</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,
FTP and FTPS connections.</p>
<p>This function returns a file-like object with two additional methods:</p>
<ul class="simple">
<li><tt class="xref 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 docutils literal"><span class="pre">info()</span></tt> — return the meta-information of the page, such as headers, in
the form of an <tt class="docutils literal"><span class="pre">httplib.HTTPMessage</span></tt> 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 <a title="urllib2.URLError" class="reference internal" href="#urllib2.URLError"><tt class="xref docutils literal"><span class="pre">URLError</span></tt></a> 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 title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a> uses <a title="urllib2.UnknownHandler" class="reference internal" href="#urllib2.UnknownHandler"><tt class="xref docutils literal"><span class="pre">UnknownHandler</span></tt></a> to
ensure this never happens).</p>
<p>In addition, default installed <a title="urllib2.ProxyHandler" class="reference internal" href="#urllib2.ProxyHandler"><tt class="xref docutils literal"><span class="pre">ProxyHandler</span></tt></a> makes sure the requests
are handled through the proxy when they are set.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.6: </span><em>timeout</em> was added.</p>
</dd></dl>
<dl class="function">
<dt id="urllib2.install_opener">
<tt class="descclassname">urllib2.</tt><tt class="descname">install_opener</tt><big>(</big><em>opener</em><big>)</big><a class="headerlink" href="#urllib2.install_opener" title="Permalink to this definition">¶</a></dt>
<dd>Install an <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref 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 title="urllib2.OpenerDirector.open" class="reference internal" href="#urllib2.OpenerDirector.open"><tt class="xref docutils literal"><span class="pre">OpenerDirector.open()</span></tt></a> instead of <a title="urllib2.urlopen" class="reference internal" href="#urllib2.urlopen"><tt class="xref docutils literal"><span class="pre">urlopen()</span></tt></a>.
The code does not check for a real <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a>, and any class with
the appropriate interface will work.</dd></dl>
<dl class="function">
<dt id="urllib2.build_opener">
<tt class="descclassname">urllib2.</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="#urllib2.build_opener" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref 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 title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref docutils literal"><span class="pre">BaseHandler</span></tt></a>, or
subclasses of <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref 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 title="urllib2.ProxyHandler" class="reference internal" href="#urllib2.ProxyHandler"><tt class="xref docutils literal"><span class="pre">ProxyHandler</span></tt></a>,
<a title="urllib2.UnknownHandler" class="reference internal" href="#urllib2.UnknownHandler"><tt class="xref docutils literal"><span class="pre">UnknownHandler</span></tt></a>, <a title="urllib2.HTTPHandler" class="reference internal" href="#urllib2.HTTPHandler"><tt class="xref docutils literal"><span class="pre">HTTPHandler</span></tt></a>, <a title="urllib2.HTTPDefaultErrorHandler" class="reference internal" href="#urllib2.HTTPDefaultErrorHandler"><tt class="xref docutils literal"><span class="pre">HTTPDefaultErrorHandler</span></tt></a>,
<a title="urllib2.HTTPRedirectHandler" class="reference internal" href="#urllib2.HTTPRedirectHandler"><tt class="xref docutils literal"><span class="pre">HTTPRedirectHandler</span></tt></a>, <a title="urllib2.FTPHandler" class="reference internal" href="#urllib2.FTPHandler"><tt class="xref docutils literal"><span class="pre">FTPHandler</span></tt></a>, <a title="urllib2.FileHandler" class="reference internal" href="#urllib2.FileHandler"><tt class="xref docutils literal"><span class="pre">FileHandler</span></tt></a>,
<tt class="xref docutils literal"><span class="pre">HTTPErrorProcessor</span></tt>.</p>
<p>If the Python installation has SSL support (i.e., if the <a title="SSL wrapper for socket objects" class="reference external" href="ssl.html#module-ssl"><tt class="xref docutils literal"><span class="pre">ssl</span></tt></a> module can be imported),
<a title="urllib2.HTTPSHandler" class="reference internal" href="#urllib2.HTTPSHandler"><tt class="xref docutils literal"><span class="pre">HTTPSHandler</span></tt></a> will also be added.</p>
<p>Beginning in Python 2.3, a <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref docutils literal"><span class="pre">BaseHandler</span></tt></a> subclass may also change its
<tt class="xref docutils literal"><span class="pre">handler_order</span></tt> member variable to modify its position in the handlers
list.</p>
</dd></dl>
<p>The following exceptions are raised as appropriate:</p>
<dl class="exception">
<dt id="urllib2.URLError">
<em class="property">exception </em><tt class="descclassname">urllib2.</tt><tt class="descname">URLError</tt><a class="headerlink" href="#urllib2.URLError" title="Permalink to this definition">¶</a></dt>
<dd><p>The handlers raise this exception (or derived exceptions) when they run into a
problem. It is a subclass of <a title="exceptions.IOError" class="reference external" href="exceptions.html#exceptions.IOError"><tt class="xref docutils literal"><span class="pre">IOError</span></tt></a>.</p>
<dl class="attribute">
<dt id="urllib2.URLError.reason">
<tt class="descname">reason</tt><a class="headerlink" href="#urllib2.URLError.reason" title="Permalink to this definition">¶</a></dt>
<dd>The reason for this error. It can be a message string or another exception
instance (<a title="socket.error" class="reference external" href="socket.html#socket.error"><tt class="xref docutils literal"><span class="pre">socket.error</span></tt></a> for remote URLs, <a title="exceptions.OSError" class="reference external" href="exceptions.html#exceptions.OSError"><tt class="xref docutils literal"><span class="pre">OSError</span></tt></a> for local
URLs).</dd></dl>
</dd></dl>
<dl class="exception">
<dt id="urllib2.HTTPError">
<em class="property">exception </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPError</tt><a class="headerlink" href="#urllib2.HTTPError" title="Permalink to this definition">¶</a></dt>
<dd><p>Though being an exception (a subclass of <a title="urllib2.URLError" class="reference internal" href="#urllib2.URLError"><tt class="xref docutils literal"><span class="pre">URLError</span></tt></a>), an <a title="urllib2.HTTPError" class="reference internal" href="#urllib2.HTTPError"><tt class="xref docutils literal"><span class="pre">HTTPError</span></tt></a>
can also function as a non-exceptional file-like return value (the same thing
that <a title="urllib2.urlopen" class="reference internal" href="#urllib2.urlopen"><tt class="xref docutils literal"><span class="pre">urlopen()</span></tt></a> returns). This is useful when handling exotic HTTP
errors, such as requests for authentication.</p>
<dl class="attribute">
<dt id="urllib2.HTTPError.code">
<tt class="descname">code</tt><a class="headerlink" href="#urllib2.HTTPError.code" title="Permalink to this definition">¶</a></dt>
<dd>An HTTP status code as defined in <a class="reference external" href="http://www.faqs.org/rfcs/rfc2616.html">RFC 2616</a>.
This numeric value corresponds to a value found in the dictionary of
codes as found in <a title="BaseHTTPServer.BaseHTTPRequestHandler.responses" class="reference external" href="basehttpserver.html#BaseHTTPServer.BaseHTTPRequestHandler.responses"><tt class="xref docutils literal"><span class="pre">BaseHTTPServer.BaseHTTPRequestHandler.responses</span></tt></a>.</dd></dl>
</dd></dl>
<p>The following classes are provided:</p>
<dl class="class">
<dt id="urllib2.Request">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">Request</tt><big>(</big><em>url</em><span class="optional">[</span>, <em>data</em><span class="optional">]</span><span class="optional">[</span>, <em>headers</em><span class="optional">]</span><span class="optional">[</span>, <em>origin_req_host</em><span class="optional">]</span><span class="optional">[</span>, <em>unverifiable</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.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> may be a string 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>application/x-www-form-urlencoded</em> format. The
<a title="urllib.urlencode" class="reference external" href="urllib.html#urllib.urlencode"><tt class="xref docutils literal"><span class="pre">urllib.urlencode()</span></tt></a> function takes a mapping or sequence of 2-tuples and
returns a string in this format.</p>
<p><em>headers</em> should be a dictionary, and will be treated as if <a title="urllib2.Request.add_header" class="reference internal" href="#urllib2.Request.add_header"><tt class="xref 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 docutils literal"><span class="pre">urllib2</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>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-709"></span><a class="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">cookielib.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>
</dd></dl>
<dl class="class">
<dt id="urllib2.OpenerDirector">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">OpenerDirector</tt><a class="headerlink" href="#urllib2.OpenerDirector" title="Permalink to this definition">¶</a></dt>
<dd>The <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a> class opens URLs via <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref docutils literal"><span class="pre">BaseHandler</span></tt></a>s chained
together. It manages the chaining of handlers, and recovery from errors.</dd></dl>
<dl class="class">
<dt id="urllib2.BaseHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">BaseHandler</tt><a class="headerlink" href="#urllib2.BaseHandler" title="Permalink to this definition">¶</a></dt>
<dd>This is the base class for all registered handlers — and handles only the
simple mechanics of registration.</dd></dl>
<dl class="class">
<dt id="urllib2.HTTPDefaultErrorHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPDefaultErrorHandler</tt><a class="headerlink" href="#urllib2.HTTPDefaultErrorHandler" title="Permalink to this definition">¶</a></dt>
<dd>A class which defines a default handler for HTTP error responses; all responses
are turned into <a title="urllib2.HTTPError" class="reference internal" href="#urllib2.HTTPError"><tt class="xref docutils literal"><span class="pre">HTTPError</span></tt></a> exceptions.</dd></dl>
<dl class="class">
<dt id="urllib2.HTTPRedirectHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPRedirectHandler</tt><a class="headerlink" href="#urllib2.HTTPRedirectHandler" title="Permalink to this definition">¶</a></dt>
<dd>A class to handle redirections.</dd></dl>
<dl class="class">
<dt id="urllib2.HTTPCookieProcessor">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPCookieProcessor</tt><big>(</big><span class="optional">[</span><em>cookiejar</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.HTTPCookieProcessor" title="Permalink to this definition">¶</a></dt>
<dd>A class to handle HTTP Cookies.</dd></dl>
<dl class="class">
<dt id="urllib2.ProxyHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">ProxyHandler</tt><big>(</big><span class="optional">[</span><em>proxies</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.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-710"></span><strong class="xref"></strong>. 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="urllib2.HTTPPasswordMgr">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPPasswordMgr</tt><a class="headerlink" href="#urllib2.HTTPPasswordMgr" title="Permalink to this definition">¶</a></dt>
<dd>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.</dd></dl>
<dl class="class">
<dt id="urllib2.HTTPPasswordMgrWithDefaultRealm">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPPasswordMgrWithDefaultRealm</tt><a class="headerlink" href="#urllib2.HTTPPasswordMgrWithDefaultRealm" title="Permalink to this definition">¶</a></dt>
<dd>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.</dd></dl>
<dl class="class">
<dt id="urllib2.AbstractBasicAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">AbstractBasicAuthHandler</tt><big>(</big><span class="optional">[</span><em>password_mgr</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.AbstractBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>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 title="urllib2.HTTPPasswordMgr" class="reference internal" href="#urllib2.HTTPPasswordMgr"><tt class="xref 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.</dd></dl>
<dl class="class">
<dt id="urllib2.HTTPBasicAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPBasicAuthHandler</tt><big>(</big><span class="optional">[</span><em>password_mgr</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.HTTPBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>Handle authentication with the remote host. <em>password_mgr</em>, if given, should be
something that is compatible with <a title="urllib2.HTTPPasswordMgr" class="reference internal" href="#urllib2.HTTPPasswordMgr"><tt class="xref 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.</dd></dl>
<dl class="class">
<dt id="urllib2.ProxyBasicAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">ProxyBasicAuthHandler</tt><big>(</big><span class="optional">[</span><em>password_mgr</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.ProxyBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>Handle authentication with the proxy. <em>password_mgr</em>, if given, should be
something that is compatible with <a title="urllib2.HTTPPasswordMgr" class="reference internal" href="#urllib2.HTTPPasswordMgr"><tt class="xref 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.</dd></dl>
<dl class="class">
<dt id="urllib2.AbstractDigestAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">AbstractDigestAuthHandler</tt><big>(</big><span class="optional">[</span><em>password_mgr</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.AbstractDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>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 title="urllib2.HTTPPasswordMgr" class="reference internal" href="#urllib2.HTTPPasswordMgr"><tt class="xref 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.</dd></dl>
<dl class="class">
<dt id="urllib2.HTTPDigestAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPDigestAuthHandler</tt><big>(</big><span class="optional">[</span><em>password_mgr</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.HTTPDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>Handle authentication with the remote host. <em>password_mgr</em>, if given, should be
something that is compatible with <a title="urllib2.HTTPPasswordMgr" class="reference internal" href="#urllib2.HTTPPasswordMgr"><tt class="xref 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.</dd></dl>
<dl class="class">
<dt id="urllib2.ProxyDigestAuthHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">ProxyDigestAuthHandler</tt><big>(</big><span class="optional">[</span><em>password_mgr</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.ProxyDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>Handle authentication with the proxy. <em>password_mgr</em>, if given, should be
something that is compatible with <a title="urllib2.HTTPPasswordMgr" class="reference internal" href="#urllib2.HTTPPasswordMgr"><tt class="xref 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.</dd></dl>
<dl class="class">
<dt id="urllib2.HTTPHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPHandler</tt><a class="headerlink" href="#urllib2.HTTPHandler" title="Permalink to this definition">¶</a></dt>
<dd>A class to handle opening of HTTP URLs.</dd></dl>
<dl class="class">
<dt id="urllib2.HTTPSHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPSHandler</tt><a class="headerlink" href="#urllib2.HTTPSHandler" title="Permalink to this definition">¶</a></dt>
<dd>A class to handle opening of HTTPS URLs.</dd></dl>
<dl class="class">
<dt id="urllib2.FileHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">FileHandler</tt><a class="headerlink" href="#urllib2.FileHandler" title="Permalink to this definition">¶</a></dt>
<dd>Open local files.</dd></dl>
<dl class="class">
<dt id="urllib2.FTPHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">FTPHandler</tt><a class="headerlink" href="#urllib2.FTPHandler" title="Permalink to this definition">¶</a></dt>
<dd>Open FTP URLs.</dd></dl>
<dl class="class">
<dt id="urllib2.CacheFTPHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">CacheFTPHandler</tt><a class="headerlink" href="#urllib2.CacheFTPHandler" title="Permalink to this definition">¶</a></dt>
<dd>Open FTP URLs, keeping a cache of open FTP connections to minimize delays.</dd></dl>
<dl class="class">
<dt id="urllib2.UnknownHandler">
<em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">UnknownHandler</tt><a class="headerlink" href="#urllib2.UnknownHandler" title="Permalink to this definition">¶</a></dt>
<dd>A catch-all class to handle unknown URLs.</dd></dl>
<div class="section" id="request-objects">
<span id="id1"></span><h2>21.6.1. Request Objects<a class="headerlink" href="#request-objects" title="Permalink to this headline">¶</a></h2>
<p>The following methods describe all of <a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a>‘s public interface, and
so all must be overridden in subclasses.</p>
<dl class="method">
<dt id="urllib2.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="#urllib2.Request.add_data" title="Permalink to this definition">¶</a></dt>
<dd>Set the <a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref 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>.</dd></dl>
<dl class="method">
<dt id="urllib2.Request.get_method">
<tt class="descclassname">Request.</tt><tt class="descname">get_method</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.Request.get_method" title="Permalink to this definition">¶</a></dt>
<dd>Return a string indicating the HTTP request method. This is only meaningful for
HTTP requests, and currently always returns <tt class="docutils literal"><span class="pre">'GET'</span></tt> or <tt class="docutils literal"><span class="pre">'POST'</span></tt>.</dd></dl>
<dl class="method">
<dt id="urllib2.Request.has_data">
<tt class="descclassname">Request.</tt><tt class="descname">has_data</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.Request.has_data" title="Permalink to this definition">¶</a></dt>
<dd>Return whether the instance has a non-<tt class="xref docutils literal"><span class="pre">None</span></tt> data.</dd></dl>
<dl class="method">
<dt id="urllib2.Request.get_data">
<tt class="descclassname">Request.</tt><tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.Request.get_data" title="Permalink to this definition">¶</a></dt>
<dd>Return the instance’s data.</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.Request.add_header" title="Permalink to this definition">¶</a></dt>
<dd>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.</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.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>
<p class="versionadded">
<span class="versionmodified">New in version 2.4.</span></p>
</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.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>
<p class="versionadded">
<span class="versionmodified">New in version 2.4.</span></p>
</dd></dl>
<dl class="method">
<dt id="urllib2.Request.get_full_url">
<tt class="descclassname">Request.</tt><tt class="descname">get_full_url</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.Request.get_full_url" title="Permalink to this definition">¶</a></dt>
<dd>Return the URL given in the constructor.</dd></dl>
<dl class="method">
<dt id="urllib2.Request.get_type">
<tt class="descclassname">Request.</tt><tt class="descname">get_type</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.Request.get_type" title="Permalink to this definition">¶</a></dt>
<dd>Return the type of the URL — also known as the scheme.</dd></dl>
<dl class="method">
<dt id="urllib2.Request.get_host">
<tt class="descclassname">Request.</tt><tt class="descname">get_host</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.Request.get_host" title="Permalink to this definition">¶</a></dt>
<dd>Return the host to which a connection will be made.</dd></dl>
<dl class="method">
<dt id="urllib2.Request.get_selector">
<tt class="descclassname">Request.</tt><tt class="descname">get_selector</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.Request.get_selector" title="Permalink to this definition">¶</a></dt>
<dd>Return the selector — the part of the URL that is sent to the server.</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.Request.set_proxy" title="Permalink to this definition">¶</a></dt>
<dd>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.</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.Request.get_origin_req_host" title="Permalink to this definition">¶</a></dt>
<dd>Return the request-host of the origin transaction, as defined by <span class="target" id="index-711"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2965.html"><strong>RFC 2965</strong></a>.
See the documentation for the <a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a> constructor.</dd></dl>
<dl class="method">
<dt id="urllib2.Request.is_unverifiable">
<tt class="descclassname">Request.</tt><tt class="descname">is_unverifiable</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.Request.is_unverifiable" title="Permalink to this definition">¶</a></dt>
<dd>Return whether the request is unverifiable, as defined by RFC 2965. See the
documentation for the <a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a> constructor.</dd></dl>
</div>
<div class="section" id="openerdirector-objects">
<span id="opener-director-objects"></span><h2>21.6.2. OpenerDirector Objects<a class="headerlink" href="#openerdirector-objects" title="Permalink to this headline">¶</a></h2>
<p><a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a> instances have the following methods:</p>
<dl class="method">
<dt id="urllib2.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="#urllib2.OpenerDirector.add_handler" title="Permalink to this definition">¶</a></dt>
<dd><p><em>handler</em> should be an instance of <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref 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="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_open</span></tt> — signal that the handler knows how to open
<em>protocol</em> URLs.</li>
<li><tt class="docutils literal"><span class="pre">http_error_</span><em><span class="pre">type</span></em></tt> — signal that the handler knows how to handle
HTTP errors with HTTP error code <em>type</em>.</li>
<li><tt class="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_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="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_request</span></tt> — signal that the handler knows how to
pre-process <em>protocol</em> requests.</li>
<li><tt class="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_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="urllib2.OpenerDirector.open">
<tt class="descclassname">OpenerDirector.</tt><tt class="descname">open</tt><big>(</big><em>url</em><span class="optional">[</span>, <em>data</em><span class="optional">]</span><span class="optional">[</span>, <em>timeout</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.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 title="urllib2.urlopen" class="reference internal" href="#urllib2.urlopen"><tt class="xref docutils literal"><span class="pre">urlopen()</span></tt></a> (which simply calls the <a title="open" class="reference external" href="functions.html#open"><tt class="xref docutils literal"><span class="pre">open()</span></tt></a>
method on the currently installed global <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref 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 usedi). The timeout feature actually works only for
HTTP, HTTPS, FTP and FTPS connections).</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.6: </span><em>timeout</em> was added.</p>
</dd></dl>
<dl class="method">
<dt id="urllib2.OpenerDirector.error">
<tt class="descclassname">OpenerDirector.</tt><tt class="descname">error</tt><big>(</big><em>proto</em><span class="optional">[</span>, <em>arg</em><span class="optional">[</span>, <em>...</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#urllib2.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 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 title="urllib2.urlopen" class="reference internal" href="#urllib2.urlopen"><tt class="xref 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="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_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="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_open</span></tt> are called to handle
the request. This stage ends when a handler either returns a non-<a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a>
value (ie. a response), or raises an exception (usually <a title="urllib2.URLError" class="reference internal" href="#urllib2.URLError"><tt class="xref docutils literal"><span class="pre">URLError</span></tt></a>).
Exceptions are allowed to propagate.</p>
<p>In fact, the above algorithm is first tried for methods named
<tt class="xref docutils literal"><span class="pre">default_open()</span></tt>. If all such methods return <a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a>, the
algorithm is repeated for methods named like <tt class="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_open</span></tt>. If all
such methods return <a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a>, the algorithm is repeated for methods
named <tt class="xref 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 title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a> instance’s <a title="open" class="reference external" href="functions.html#open"><tt class="xref docutils literal"><span class="pre">open()</span></tt></a> and <tt class="xref docutils literal"><span class="pre">error()</span></tt> methods.</p>
</li>
<li><p class="first">Every handler with a method named like <tt class="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_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.6.3. BaseHandler Objects<a class="headerlink" href="#basehandler-objects" title="Permalink to this headline">¶</a></h2>
<p><a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref 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="urllib2.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="#urllib2.BaseHandler.add_parent" title="Permalink to this definition">¶</a></dt>
<dd>Add a director as parent.</dd></dl>
<dl class="method">
<dt id="urllib2.BaseHandler.close">
<tt class="descclassname">BaseHandler.</tt><tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.BaseHandler.close" title="Permalink to this definition">¶</a></dt>
<dd>Remove any parents.</dd></dl>
<p>The following members and methods should only be used by classes derived from
<a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref 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 docutils literal"><span class="pre">protocol_request()</span></tt> or <tt class="xref docutils literal"><span class="pre">protocol_response()</span></tt> methods are named
<tt class="xref docutils literal"><span class="pre">*Processor</span></tt>; all others are named <tt class="xref docutils literal"><span class="pre">*Handler</span></tt>.</p>
</div>
<dl class="attribute">
<dt id="urllib2.BaseHandler.parent">
<tt class="descclassname">BaseHandler.</tt><tt class="descname">parent</tt><a class="headerlink" href="#urllib2.BaseHandler.parent" title="Permalink to this definition">¶</a></dt>
<dd>A valid <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a>, which can be used to open using a different
protocol, or handle errors.</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.BaseHandler.default_open" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is <em>not</em> defined in <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref 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 title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref 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 title="open" class="reference external" href="functions.html#open"><tt class="xref docutils literal"><span class="pre">open()</span></tt></a> of <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a>, or <tt class="xref docutils literal"><span class="pre">None</span></tt>.
It should raise <a title="urllib2.URLError" class="reference internal" href="#urllib2.URLError"><tt class="xref docutils literal"><span class="pre">URLError</span></tt></a>, unless a truly exceptional thing happens (for
example, <a title="exceptions.MemoryError" class="reference external" href="exceptions.html#exceptions.MemoryError"><tt class="xref docutils literal"><span class="pre">MemoryError</span></tt></a> should not be mapped to <a title="urllib2.URLError" class="reference internal" href="#urllib2.URLError"><tt class="xref docutils literal"><span class="pre">URLError</span></tt></a>).</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>(“protocol” is to be replaced by the protocol name.)</p>
<p>This method is <em>not</em> defined in <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should
define it if they want to handle URLs with the given <em>protocol</em>.</p>
<p>This method, if defined, will be called by the parent <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a>.
Return values should be the same as for <tt class="xref docutils literal"><span class="pre">default_open()</span></tt>.</p>
</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.BaseHandler.unknown_open" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is <em>not</em> defined in <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref 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 title="urllib2.BaseHandler.parent" class="reference internal" href="#urllib2.BaseHandler.parent"><tt class="xref docutils literal"><span class="pre">parent</span></tt></a>
<a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a>. Return values should be the same as for
<a title="urllib2.BaseHandler.default_open" class="reference internal" href="#urllib2.BaseHandler.default_open"><tt class="xref docutils literal"><span class="pre">default_open()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.BaseHandler.http_error_default" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is <em>not</em> defined in <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref 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 title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref 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 title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref 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 title="urllib2.urlopen" class="reference internal" href="#urllib2.urlopen"><tt class="xref docutils literal"><span class="pre">urlopen()</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.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 title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref 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 title="urllib2.BaseHandler.http_error_default" class="reference internal" href="#urllib2.BaseHandler.http_error_default"><tt class="xref 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>(“protocol” is to be replaced by the protocol name.)</p>
<p>This method is <em>not</em> defined in <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should
define it if they want to pre-process requests of the given <em>protocol</em>.</p>
<p>This method, if defined, will be called by the parent <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a>.
<em>req</em> will be a <a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a> object. The return value should be a
<a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref 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>(“protocol” is to be replaced by the protocol name.)</p>
<p>This method is <em>not</em> defined in <a title="urllib2.BaseHandler" class="reference internal" href="#urllib2.BaseHandler"><tt class="xref docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should
define it if they want to post-process responses of the given <em>protocol</em>.</p>
<p>This method, if defined, will be called by the parent <a title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a>.
<em>req</em> will be a <a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref 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 title="urllib2.urlopen" class="reference internal" href="#urllib2.urlopen"><tt class="xref docutils literal"><span class="pre">urlopen()</span></tt></a>. The
return value should implement the same interface as the return value of
<a title="urllib2.urlopen" class="reference internal" href="#urllib2.urlopen"><tt class="xref 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.6.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 class="last">Some HTTP redirections require action from this module’s client code. If this
is the case, <a title="urllib2.HTTPError" class="reference internal" href="#urllib2.HTTPError"><tt class="xref docutils literal"><span class="pre">HTTPError</span></tt></a> is raised. See <span class="target" id="index-712"></span><a class="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>
</div>
<dl class="method">
<dt id="urllib2.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="#urllib2.HTTPRedirectHandler.redirect_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref 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 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 title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a> to allow <tt class="xref docutils literal"><span class="pre">http_error_30*()</span></tt> to perform the
redirect to <em>newurl</em>. Otherwise, raise <a title="urllib2.HTTPError" class="reference internal" href="#urllib2.HTTPError"><tt class="xref docutils literal"><span class="pre">HTTPError</span></tt></a> 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-713"></span><a class="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="urllib2.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="#urllib2.HTTPRedirectHandler.http_error_301" title="Permalink to this definition">¶</a></dt>
<dd>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 title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a> when getting an HTTP ‘moved permanently’ response.</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.HTTPRedirectHandler.http_error_302" title="Permalink to this definition">¶</a></dt>
<dd>The same as <a title="urllib2.HTTPRedirectHandler.http_error_301" class="reference internal" href="#urllib2.HTTPRedirectHandler.http_error_301"><tt class="xref docutils literal"><span class="pre">http_error_301()</span></tt></a>, but called for the ‘found’ response.</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.HTTPRedirectHandler.http_error_303" title="Permalink to this definition">¶</a></dt>
<dd>The same as <a title="urllib2.HTTPRedirectHandler.http_error_301" class="reference internal" href="#urllib2.HTTPRedirectHandler.http_error_301"><tt class="xref docutils literal"><span class="pre">http_error_301()</span></tt></a>, but called for the ‘see other’ response.</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.HTTPRedirectHandler.http_error_307" title="Permalink to this definition">¶</a></dt>
<dd>The same as <a title="urllib2.HTTPRedirectHandler.http_error_301" class="reference internal" href="#urllib2.HTTPRedirectHandler.http_error_301"><tt class="xref docutils literal"><span class="pre">http_error_301()</span></tt></a>, but called for the ‘temporary redirect’
response.</dd></dl>
</div>
<div class="section" id="httpcookieprocessor-objects">
<span id="http-cookie-processor"></span><h2>21.6.5. HTTPCookieProcessor Objects<a class="headerlink" href="#httpcookieprocessor-objects" title="Permalink to this headline">¶</a></h2>
<p class="versionadded">
<span class="versionmodified">New in version 2.4.</span></p>
<p><a title="urllib2.HTTPCookieProcessor" class="reference internal" href="#urllib2.HTTPCookieProcessor"><tt class="xref docutils literal"><span class="pre">HTTPCookieProcessor</span></tt></a> instances have one attribute:</p>
<dl class="attribute">
<dt id="urllib2.HTTPCookieProcessor.cookiejar">
<tt class="descclassname">HTTPCookieProcessor.</tt><tt class="descname">cookiejar</tt><a class="headerlink" href="#urllib2.HTTPCookieProcessor.cookiejar" title="Permalink to this definition">¶</a></dt>
<dd>The <a title="cookielib.CookieJar" class="reference external" href="cookielib.html#cookielib.CookieJar"><tt class="xref docutils literal"><span class="pre">cookielib.CookieJar</span></tt></a> in which cookies are stored.</dd></dl>
</div>
<div class="section" id="proxyhandler-objects">
<span id="proxy-handler"></span><h2>21.6.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>(“protocol” is to be replaced by the protocol name.)</p>
<p>The <a title="urllib2.ProxyHandler" class="reference internal" href="#urllib2.ProxyHandler"><tt class="xref docutils literal"><span class="pre">ProxyHandler</span></tt></a> will have a method <tt class="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_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.6.7. HTTPPasswordMgr Objects<a class="headerlink" href="#httppasswordmgr-objects" title="Permalink to this headline">¶</a></h2>
<p>These methods are available on <a title="urllib2.HTTPPasswordMgr" class="reference internal" href="#urllib2.HTTPPasswordMgr"><tt class="xref docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a> and
<a title="urllib2.HTTPPasswordMgrWithDefaultRealm" class="reference internal" href="#urllib2.HTTPPasswordMgrWithDefaultRealm"><tt class="xref docutils literal"><span class="pre">HTTPPasswordMgrWithDefaultRealm</span></tt></a> objects.</p>
<dl class="method">
<dt id="urllib2.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="#urllib2.HTTPPasswordMgr.add_password" title="Permalink to this definition">¶</a></dt>
<dd><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.</dd></dl>
<dl class="method">
<dt id="urllib2.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="#urllib2.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 title="urllib2.HTTPPasswordMgrWithDefaultRealm" class="reference internal" href="#urllib2.HTTPPasswordMgrWithDefaultRealm"><tt class="xref 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.6.8. AbstractBasicAuthHandler Objects<a class="headerlink" href="#abstractbasicauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.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 title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref 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.6.9. HTTPBasicAuthHandler Objects<a class="headerlink" href="#httpbasicauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.HTTPBasicAuthHandler.http_error_401" title="Permalink to this definition">¶</a></dt>
<dd>Retry the request with authentication information, if available.</dd></dl>
</div>
<div class="section" id="proxybasicauthhandler-objects">
<span id="proxy-basic-auth-handler"></span><h2>21.6.10. ProxyBasicAuthHandler Objects<a class="headerlink" href="#proxybasicauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.ProxyBasicAuthHandler.http_error_407" title="Permalink to this definition">¶</a></dt>
<dd>Retry the request with authentication information, if available.</dd></dl>
</div>
<div class="section" id="abstractdigestauthhandler-objects">
<span id="abstract-digest-auth-handler"></span><h2>21.6.11. AbstractDigestAuthHandler Objects<a class="headerlink" href="#abstractdigestauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.AbstractDigestAuthHandler.http_error_auth_reqed" title="Permalink to this definition">¶</a></dt>
<dd><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 title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a> object, and <em>headers</em> should be the
error headers.</dd></dl>
</div>
<div class="section" id="httpdigestauthhandler-objects">
<span id="http-digest-auth-handler"></span><h2>21.6.12. HTTPDigestAuthHandler Objects<a class="headerlink" href="#httpdigestauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.HTTPDigestAuthHandler.http_error_401" title="Permalink to this definition">¶</a></dt>
<dd>Retry the request with authentication information, if available.</dd></dl>
</div>
<div class="section" id="proxydigestauthhandler-objects">
<span id="proxy-digest-auth-handler"></span><h2>21.6.13. ProxyDigestAuthHandler Objects<a class="headerlink" href="#proxydigestauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.ProxyDigestAuthHandler.http_error_407" title="Permalink to this definition">¶</a></dt>
<dd>Retry the request with authentication information, if available.</dd></dl>
</div>
<div class="section" id="httphandler-objects">
<span id="http-handler-objects"></span><h2>21.6.14. HTTPHandler Objects<a class="headerlink" href="#httphandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.HTTPHandler.http_open" title="Permalink to this definition">¶</a></dt>
<dd>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>.</dd></dl>
</div>
<div class="section" id="httpshandler-objects">
<span id="https-handler-objects"></span><h2>21.6.15. HTTPSHandler Objects<a class="headerlink" href="#httpshandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.HTTPSHandler.https_open" title="Permalink to this definition">¶</a></dt>
<dd>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>.</dd></dl>
</div>
<div class="section" id="filehandler-objects">
<span id="file-handler-objects"></span><h2>21.6.16. FileHandler Objects<a class="headerlink" href="#filehandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.FileHandler.file_open" title="Permalink to this definition">¶</a></dt>
<dd>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>. Change the protocol to <tt class="docutils literal"><span class="pre">ftp</span></tt> otherwise, and retry opening it
using <tt class="xref docutils literal"><span class="pre">parent</span></tt>.</dd></dl>
</div>
<div class="section" id="ftphandler-objects">
<span id="ftp-handler-objects"></span><h2>21.6.17. FTPHandler Objects<a class="headerlink" href="#ftphandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.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="#urllib2.FTPHandler.ftp_open" title="Permalink to this definition">¶</a></dt>
<dd>Open the FTP file indicated by <em>req</em>. The login is always done with empty
username and password.</dd></dl>
</div>
<div class="section" id="cacheftphandler-objects">
<span id="cacheftp-handler-objects"></span><h2>21.6.18. CacheFTPHandler Objects<a class="headerlink" href="#cacheftphandler-objects" title="Permalink to this headline">¶</a></h2>
<p><a title="urllib2.CacheFTPHandler" class="reference internal" href="#urllib2.CacheFTPHandler"><tt class="xref docutils literal"><span class="pre">CacheFTPHandler</span></tt></a> objects are <a title="urllib2.FTPHandler" class="reference internal" href="#urllib2.FTPHandler"><tt class="xref docutils literal"><span class="pre">FTPHandler</span></tt></a> objects with the
following additional methods:</p>
<dl class="method">
<dt id="urllib2.CacheFTPHandler.setTimeout">
<tt class="descclassname">CacheFTPHandler.</tt><tt class="descname">setTimeout</tt><big>(</big><em>t</em><big>)</big><a class="headerlink" href="#urllib2.CacheFTPHandler.setTimeout" title="Permalink to this definition">¶</a></dt>
<dd>Set timeout of connections to <em>t</em> seconds.</dd></dl>
<dl class="method">
<dt id="urllib2.CacheFTPHandler.setMaxConns">
<tt class="descclassname">CacheFTPHandler.</tt><tt class="descname">setMaxConns</tt><big>(</big><em>m</em><big>)</big><a class="headerlink" href="#urllib2.CacheFTPHandler.setMaxConns" title="Permalink to this definition">¶</a></dt>
<dd>Set maximum number of cached connections to <em>m</em>.</dd></dl>
</div>
<div class="section" id="unknownhandler-objects">
<span id="unknown-handler-objects"></span><h2>21.6.19. UnknownHandler Objects<a class="headerlink" href="#unknownhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="urllib2.UnknownHandler.unknown_open">
<tt class="descclassname">UnknownHandler.</tt><tt class="descname">unknown_open</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.UnknownHandler.unknown_open" title="Permalink to this definition">¶</a></dt>
<dd>Raise a <a title="urllib2.URLError" class="reference internal" href="#urllib2.URLError"><tt class="xref docutils literal"><span class="pre">URLError</span></tt></a> exception.</dd></dl>
</div>
<div class="section" id="httperrorprocessor-objects">
<span id="http-error-processor-objects"></span><h2>21.6.20. HTTPErrorProcessor Objects<a class="headerlink" href="#httperrorprocessor-objects" title="Permalink to this headline">¶</a></h2>
<p class="versionadded">
<span class="versionmodified">New in version 2.4.</span></p>
<dl class="method">
<dt id="urllib2.HTTPErrorProcessor.unknown_open">
<tt class="descclassname">HTTPErrorProcessor.</tt><tt class="descname">unknown_open</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.HTTPErrorProcessor.unknown_open" 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="docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_error_code</span></tt> handler methods, via
<a title="urllib2.OpenerDirector.error" class="reference internal" href="#urllib2.OpenerDirector.error"><tt class="xref docutils literal"><span class="pre">OpenerDirector.error()</span></tt></a>. Eventually,
<a title="urllib2.HTTPDefaultErrorHandler" class="reference internal" href="#urllib2.HTTPDefaultErrorHandler"><tt class="xref docutils literal"><span class="pre">urllib2.HTTPDefaultErrorHandler</span></tt></a> will raise an <a title="urllib2.HTTPError" class="reference internal" href="#urllib2.HTTPError"><tt class="xref docutils literal"><span class="pre">HTTPError</span></tt></a> if no
other handler handles the error.</p>
</dd></dl>
</div>
<div class="section" id="examples">
<span id="urllib2-examples"></span><h2>21.6.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 100 bytes of
it:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib2</span>
<span class="gp">>>> </span><span class="n">f</span> <span class="o">=</span> <span class="n">urllib2</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="k">print</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="go"><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"></span>
<span class="go"><?xml-stylesheet href="./css/ht2html</span>
</pre></div>
</div>
<p>Here 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-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urllib2</span>
<span class="gp">>>> </span><span class="n">req</span> <span class="o">=</span> <span class="n">urllib2</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="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">urllib2</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="k">print</span> <span class="n">f</span><span class="o">.</span><span class="n">read</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-python"><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="k">print</span> <span class="s">'Content-type: text-plain</span><span class="se">\n\n</span><span class="s">Got Data: "</span><span class="si">%s</span><span class="s">"'</span> <span class="o">%</span> <span class="n">data</span>
</pre></div>
</div>
<p>Use of Basic HTTP Authentication:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">urllib2</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">urllib2</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">urllib2</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">urllib2</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">urllib2</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 title="urllib2.build_opener" class="reference internal" href="#urllib2.build_opener"><tt class="xref docutils literal"><span class="pre">build_opener()</span></tt></a> provides many handlers by default, including a
<a title="urllib2.ProxyHandler" class="reference internal" href="#urllib2.ProxyHandler"><tt class="xref docutils literal"><span class="pre">ProxyHandler</span></tt></a>. By default, <a title="urllib2.ProxyHandler" class="reference internal" href="#urllib2.ProxyHandler"><tt class="xref 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-714"></span><strong class="xref">http_proxy</strong> environment variable is read to
obtain the HTTP proxy’s URL.</p>
<p>This example replaces the default <a title="urllib2.ProxyHandler" class="reference internal" href="#urllib2.ProxyHandler"><tt class="xref docutils literal"><span class="pre">ProxyHandler</span></tt></a> with one that uses
programmatically-supplied proxy URLs, and adds proxy authorization support with
<a title="urllib2.ProxyBasicAuthHandler" class="reference internal" href="#urllib2.ProxyBasicAuthHandler"><tt class="xref docutils literal"><span class="pre">ProxyBasicAuthHandler</span></tt></a>.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">proxy_handler</span> <span class="o">=</span> <span class="n">urllib2</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">urllib2</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">urllib2</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 title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a> constructor, or:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">urllib2</span>
<span class="n">req</span> <span class="o">=</span> <span class="n">urllib2</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">urllib2</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 title="urllib2.OpenerDirector" class="reference internal" href="#urllib2.OpenerDirector"><tt class="xref docutils literal"><span class="pre">OpenerDirector</span></tt></a> automatically adds a <em>User-Agent</em> header to
every <a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a>. To change this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">urllib2</span>
<span class="n">opener</span> <span class="o">=</span> <span class="n">urllib2</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>Content-Length</em>,
<em>Content-Type</em> and <em>Host</em>) are added when the
<a title="urllib2.Request" class="reference internal" href="#urllib2.Request"><tt class="xref docutils literal"><span class="pre">Request</span></tt></a> is passed to <a title="urllib2.urlopen" class="reference internal" href="#urllib2.urlopen"><tt class="xref docutils literal"><span class="pre">urlopen()</span></tt></a> (or <a title="urllib2.OpenerDirector.open" class="reference internal" href="#urllib2.OpenerDirector.open"><tt class="xref docutils literal"><span class="pre">OpenerDirector.open()</span></tt></a>).</p>
</div>
</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 external" href="#">21.6. <tt class="docutils literal"><span class="pre">urllib2</span></tt> — extensible library for opening URLs</a><ul>
<li><a class="reference external" href="#request-objects">21.6.1. Request Objects</a></li>
<li><a class="reference external" href="#openerdirector-objects">21.6.2. OpenerDirector Objects</a></li>
<li><a class="reference external" href="#basehandler-objects">21.6.3. BaseHandler Objects</a></li>
<li><a class="reference external" href="#httpredirecthandler-objects">21.6.4. HTTPRedirectHandler Objects</a></li>
<li><a class="reference external" href="#httpcookieprocessor-objects">21.6.5. HTTPCookieProcessor Objects</a></li>
<li><a class="reference external" href="#proxyhandler-objects">21.6.6. ProxyHandler Objects</a></li>
<li><a class="reference external" href="#httppasswordmgr-objects">21.6.7. HTTPPasswordMgr Objects</a></li>
<li><a class="reference external" href="#abstractbasicauthhandler-objects">21.6.8. AbstractBasicAuthHandler Objects</a></li>
<li><a class="reference external" href="#httpbasicauthhandler-objects">21.6.9. HTTPBasicAuthHandler Objects</a></li>
<li><a class="reference external" href="#proxybasicauthhandler-objects">21.6.10. ProxyBasicAuthHandler Objects</a></li>
<li><a class="reference external" href="#abstractdigestauthhandler-objects">21.6.11. AbstractDigestAuthHandler Objects</a></li>
<li><a class="reference external" href="#httpdigestauthhandler-objects">21.6.12. HTTPDigestAuthHandler Objects</a></li>
<li><a class="reference external" href="#proxydigestauthhandler-objects">21.6.13. ProxyDigestAuthHandler Objects</a></li>
<li><a class="reference external" href="#httphandler-objects">21.6.14. HTTPHandler Objects</a></li>
<li><a class="reference external" href="#httpshandler-objects">21.6.15. HTTPSHandler Objects</a></li>
<li><a class="reference external" href="#filehandler-objects">21.6.16. FileHandler Objects</a></li>
<li><a class="reference external" href="#ftphandler-objects">21.6.17. FTPHandler Objects</a></li>
<li><a class="reference external" href="#cacheftphandler-objects">21.6.18. CacheFTPHandler Objects</a></li>
<li><a class="reference external" href="#unknownhandler-objects">21.6.19. UnknownHandler Objects</a></li>
<li><a class="reference external" href="#httperrorprocessor-objects">21.6.20. HTTPErrorProcessor Objects</a></li>
<li><a class="reference external" href="#examples">21.6.21. Examples</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="urllib.html"
title="previous chapter">21.5. <tt class="docutils literal docutils literal"><span class="pre">urllib</span></tt> — Open arbitrary resources by URL</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="httplib.html"
title="next chapter">21.7. <tt class="docutils literal docutils literal docutils literal"><span class="pre">httplib</span></tt> — HTTP protocol client</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/library/urllib2.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="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="httplib.html" title="21.7. httplib — HTTP protocol client"
>next</a> |</li>
<li class="right" >
<a href="urllib.html" title="21.5. urllib — Open arbitrary resources by URL"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 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-2010, 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 Mar 19, 2010.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.5.
</div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
8f1462e52e1797a02c97073eed0b7f92
>
files
>
934
