Edit File - File Manager

Edit File: urllib2.html

<!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>HOWTO Fetch Internet Resources Using urllib2 &mdash; Python v2.6.6 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.6',
 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.6 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.6 documentation" href="../index.html" />
 <link rel="up" title="Python HOWTOs" href="index.html" />
 <link rel="next" title="HOWTO Use Python in the web" href="webservers.html" />
 <link rel="prev" title="Unicode HOWTO" href="unicode.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="webservers.html" title="HOWTO Use Python in the web"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="unicode.html" title="Unicode HOWTO"
 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.6 documentation</a> &raquo;</li>

<li><a href="index.html" accesskey="U">Python HOWTOs</a> &raquo;</li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body">
 
 <div class="section" id="howto-fetch-internet-resources-using-urllib2">
<h1>HOWTO Fetch Internet Resources Using urllib2<a class="headerlink" href="#howto-fetch-internet-resources-using-urllib2" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Author:</th><td class="field-body"><a class="reference external" href="http://www.voidspace.org.uk/python/index.shtml">Michael Foord</a></td>
</tr>
</tbody>
</table>
<div class="admonition note">
Note
There is an French translation of an earlier revision of this
HOWTO, available at <a class="reference external" href="http://www.voidspace.org.uk/python/articles/urllib2_francais.shtml">urllib2 - Le Manuel manquant</a>.
</div>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<div class="sidebar">
Related Articles
You may also find useful the following article on fetching web resources
with Python :
<ul class="last">
<li><a class="reference external" href="http://www.voidspace.org.uk/python/articles/authentication.shtml">Basic Authentication</a>
<blockquote>
A tutorial on Basic Authentication, with examples in Python.
</blockquote>
</li>
</ul>
</div>
urllib2 is a <a class="reference external" href="http://www.python.org">Python</a> module for fetching URLs
(Uniform Resource Locators). It offers a very simple interface, in the form of
the urlopen function. This is capable of fetching URLs using a variety of
different protocols. It also offers a slightly more complex interface for
handling common situations - like basic authentication, cookies, proxies and so
on. These are provided by objects called handlers and openers.
urllib2 supports fetching URLs for many &#8220;URL schemes&#8221; (identified by the string
before the &#8220;:&#8221; in URL - for example &#8220;ftp&#8221; is the URL scheme of
&#8220;<a class="reference external" href="ftp://python.org/">ftp://python.org/</a>&#8220;) using their associated network protocols (e.g. FTP, HTTP).
This tutorial focuses on the most common case, HTTP.
For straightforward situations urlopen is very easy to use. But as soon as you
encounter errors or non-trivial cases when opening HTTP URLs, you will need some
understanding of the HyperText Transfer Protocol. The most comprehensive and
authoritative reference to HTTP is <a class="reference external" href="http://tools.ietf.org/html/rfc2616.html">RFC 2616</a>. This is a technical document and
not intended to be easy to read. This HOWTO aims to illustrate using urllib2,
with enough detail about HTTP to help you through. It is not intended to replace
the <a title="Next generation URL opening library." class="reference external" href="../library/urllib2.html#module-urllib2"><tt class="xref docutils literal">urllib2</tt></a> docs, but is supplementary to them.
</div>
<div class="section" id="fetching-urls">
<h2>Fetching URLs<a class="headerlink" href="#fetching-urls" title="Permalink to this headline">¶</a></h2>
The simplest way to use urllib2 is as follows:
<div class="highlight-python"><div class="highlight"><pre>import urllib2
response = urllib2.urlopen(&#39;http://python.org/&#39;)
html = response.read()
</pre></div>
</div>
Many uses of urllib2 will be that simple (note that instead of an &#8216;http:&#8217; URL we
could have used an URL starting with &#8216;ftp:&#8217;, &#8216;file:&#8217;, etc.). However, it&#8217;s the
purpose of this tutorial to explain the more complicated cases, concentrating on
HTTP.
HTTP is based on requests and responses - the client makes requests and servers
send responses. urllib2 mirrors this with a <tt class="docutils literal">Request</tt> object which represents
the HTTP request you are making. In its simplest form you create a Request
object that specifies the URL you want to fetch. Calling <tt class="docutils literal">urlopen</tt> with this
Request object returns a response object for the URL requested. This response is
a file-like object, which means you can for example call <tt class="docutils literal">.read()</tt> on the
response:
<div class="highlight-python"><div class="highlight"><pre>import urllib2

req = urllib2.Request(&#39;http://www.voidspace.org.uk&#39;)
response = urllib2.urlopen(req)
the_page = response.read()
</pre></div>
</div>
Note that urllib2 makes use of the same Request interface to handle all URL
schemes. For example, you can make an FTP request like so:
<div class="highlight-python"><div class="highlight"><pre>req = urllib2.Request(&#39;ftp://example.com/&#39;)
</pre></div>
</div>
In the case of HTTP, there are two extra things that Request objects allow you
to do: First, you can pass data to be sent to the server. Second, you can pass
extra information (&#8220;metadata&#8221;) about the data or the about request itself, to
the server - this information is sent as HTTP &#8220;headers&#8221;. Let&#8217;s look at each of
these in turn.
<div class="section" id="data">
<h3>Data<a class="headerlink" href="#data" title="Permalink to this headline">¶</a></h3>
Sometimes you want to send data to a URL (often the URL will refer to a CGI
(Common Gateway Interface) script <a class="footnote-reference" href="#id9" id="id1">[1]</a> or other web application). With HTTP,
this is often done using what&#8217;s known as a POST request. This is often what
your browser does when you submit a HTML form that you filled in on the web. Not
all POSTs have to come from forms: you can use a POST to transmit arbitrary data
to your own application. In the common case of HTML forms, the data needs to be
encoded in a standard way, and then passed to the Request object as the <tt class="docutils literal">data</tt>
argument. The encoding is done using a function from the <tt class="docutils literal">urllib</tt> library
not from <tt class="docutils literal">urllib2</tt>.
<div class="highlight-python"><div class="highlight"><pre>import urllib
import urllib2

url = &#39;http://www.someserver.com/cgi-bin/register.cgi&#39;
values = {&#39;name&#39; : &#39;Michael Foord&#39;,
 &#39;location&#39; : &#39;Northampton&#39;,
 &#39;language&#39; : &#39;Python&#39; }

data = urllib.urlencode(values)
req = urllib2.Request(url, data)
response = urllib2.urlopen(req)
the_page = response.read()
</pre></div>
</div>
Note that other encodings are sometimes required (e.g. for file upload from HTML
forms - see <a class="reference external" href="http://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13">HTML Specification, Form Submission</a> for more
details).
If you do not pass the <tt class="docutils literal">data</tt> argument, urllib2 uses a GET request. One
way in which GET and POST requests differ is that POST requests often have
&#8220;side-effects&#8221;: they change the state of the system in some way (for example by
placing an order with the website for a hundredweight of tinned spam to be
delivered to your door). Though the HTTP standard makes it clear that POSTs are
intended to always cause side-effects, and GET requests never to cause
side-effects, nothing prevents a GET request from having side-effects, nor a
POST requests from having no side-effects. Data can also be passed in an HTTP
GET request by encoding it in the URL itself.
This is done as follows:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; import urllib2
&gt;&gt;&gt; import urllib
&gt;&gt;&gt; data = {}
&gt;&gt;&gt; data[&#39;name&#39;] = &#39;Somebody Here&#39;
&gt;&gt;&gt; data[&#39;location&#39;] = &#39;Northampton&#39;
&gt;&gt;&gt; data[&#39;language&#39;] = &#39;Python&#39;
&gt;&gt;&gt; url_values = urllib.urlencode(data)
&gt;&gt;&gt; print url_values
name=Somebody+Here&amp;language=Python&amp;location=Northampton
&gt;&gt;&gt; url = &#39;http://www.example.com/example.cgi&#39;
&gt;&gt;&gt; full_url = url + &#39;?&#39; + url_values
&gt;&gt;&gt; data = urllib2.open(full_url)
</pre></div>
</div>
Notice that the full URL is created by adding a <tt class="docutils literal">?</tt> to the URL, followed by
the encoded values.
</div>
<div class="section" id="headers">
<h3>Headers<a class="headerlink" href="#headers" title="Permalink to this headline">¶</a></h3>
We&#8217;ll discuss here one particular HTTP header, to illustrate how to add headers
to your HTTP request.
Some websites <a class="footnote-reference" href="#id10" id="id2">[2]</a> dislike being browsed by programs, or send different versions
to different browsers <a class="footnote-reference" href="#id11" id="id3">[3]</a> . By default urllib2 identifies itself as
<tt class="docutils literal">Python-urllib/x.y</tt> (where <tt class="docutils literal">x</tt> and <tt class="docutils literal">y</tt> are the major and minor version
numbers of the Python release,
e.g. <tt class="docutils literal">Python-urllib/2.5</tt>), which may confuse the site, or just plain
not work. The way a browser identifies itself is through the
<tt class="docutils literal">User-Agent</tt> header <a class="footnote-reference" href="#id12" id="id4">[4]</a>. When you create a Request object you can
pass a dictionary of headers in. The following example makes the same
request as above, but identifies itself as a version of Internet
Explorer <a class="footnote-reference" href="#id13" id="id5">[5]</a>.
<div class="highlight-python"><div class="highlight"><pre>import urllib
import urllib2

url = &#39;http://www.someserver.com/cgi-bin/register.cgi&#39;
user_agent = &#39;Mozilla/4.0 (compatible; MSIE 5.5; Windows NT)&#39;
values = {&#39;name&#39; : &#39;Michael Foord&#39;,
 &#39;location&#39; : &#39;Northampton&#39;,
 &#39;language&#39; : &#39;Python&#39; }
headers = { &#39;User-Agent&#39; : user_agent }

data = urllib.urlencode(values)
req = urllib2.Request(url, data, headers)
response = urllib2.urlopen(req)
the_page = response.read()
</pre></div>
</div>
The response also has two useful methods. See the section on <a class="reference internal" href="#info-and-geturl">info and geturl</a>
which comes after we have a look at what happens when things go wrong.
</div>
</div>
<div class="section" id="handling-exceptions">
<h2>Handling Exceptions<a class="headerlink" href="#handling-exceptions" title="Permalink to this headline">¶</a></h2>
urlopen raises <tt class="xref docutils literal">URLError</tt> when it cannot handle a response (though as
usual with Python APIs, built-in exceptions such as <a title="exceptions.ValueError" class="reference external" href="../library/exceptions.html#exceptions.ValueError"><tt class="xref docutils literal">ValueError</tt></a>,
<a title="exceptions.TypeError" class="reference external" href="../library/exceptions.html#exceptions.TypeError"><tt class="xref docutils literal">TypeError</tt></a> etc. may also be raised).
<tt class="xref docutils literal">HTTPError</tt> is the subclass of <tt class="xref docutils literal">URLError</tt> raised in the specific case of
HTTP URLs.
<div class="section" id="urlerror">
<h3>URLError<a class="headerlink" href="#urlerror" title="Permalink to this headline">¶</a></h3>
Often, URLError is raised because there is no network connection (no route to
the specified server), or the specified server doesn&#8217;t exist. In this case, the
exception raised will have a &#8216;reason&#8217; attribute, which is a tuple containing an
error code and a text error message.
e.g.
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; req = urllib2.Request(&#39;http://www.pretend_server.org&#39;)
&gt;&gt;&gt; try: urllib2.urlopen(req)
&gt;&gt;&gt; except URLError, e:
&gt;&gt;&gt; print e.reason
&gt;&gt;&gt;
(4, &#39;getaddrinfo failed&#39;)
</pre></div>
</div>
</div>
<div class="section" id="httperror">
<h3>HTTPError<a class="headerlink" href="#httperror" title="Permalink to this headline">¶</a></h3>
Every HTTP response from the server contains a numeric &#8220;status code&#8221;. Sometimes
the status code indicates that the server is unable to fulfil the request. The
default handlers will handle some of these responses for you (for example, if
the response is a &#8220;redirection&#8221; that requests the client fetch the document from
a different URL, urllib2 will handle that for you). For those it can&#8217;t handle,
urlopen will raise an <tt class="xref docutils literal">HTTPError</tt>. Typical errors include &#8216;404&#8217; (page not
found), &#8216;403&#8217; (request forbidden), and &#8216;401&#8217; (authentication required).
See section 10 of RFC 2616 for a reference on all the HTTP error codes.
The <tt class="xref docutils literal">HTTPError</tt> instance raised will have an integer &#8216;code&#8217; attribute, which
corresponds to the error sent by the server.
<div class="section" id="error-codes">
<h4>Error Codes<a class="headerlink" href="#error-codes" title="Permalink to this headline">¶</a></h4>
Because the default handlers handle redirects (codes in the 300 range), and
codes in the 100-299 range indicate success, you will usually only see error
codes in the 400-599 range.
<tt class="docutils literal">BaseHTTPServer.BaseHTTPRequestHandler.responses</tt> is a useful dictionary of
response codes in that shows all the response codes used by RFC 2616. The
dictionary is reproduced here for convenience
<div class="highlight-python"><div class="highlight"><pre># Table mapping response codes to messages; entries have the
# form {code: (shortmessage, longmessage)}.
responses = {
 100: (&#39;Continue&#39;, &#39;Request received, please continue&#39;),
 101: (&#39;Switching Protocols&#39;,
 &#39;Switching to new protocol; obey Upgrade header&#39;),

200: (&#39;OK&#39;, &#39;Request fulfilled, document follows&#39;),
 201: (&#39;Created&#39;, &#39;Document created, URL follows&#39;),
 202: (&#39;Accepted&#39;,
 &#39;Request accepted, processing continues off-line&#39;),
 203: (&#39;Non-Authoritative Information&#39;, &#39;Request fulfilled from cache&#39;),
 204: (&#39;No Content&#39;, &#39;Request fulfilled, nothing follows&#39;),
 205: (&#39;Reset Content&#39;, &#39;Clear input form for further input.&#39;),
 206: (&#39;Partial Content&#39;, &#39;Partial content follows.&#39;),

300: (&#39;Multiple Choices&#39;,
 &#39;Object has several resources -- see URI list&#39;),
 301: (&#39;Moved Permanently&#39;, &#39;Object moved permanently -- see URI list&#39;),
 302: (&#39;Found&#39;, &#39;Object moved temporarily -- see URI list&#39;),
 303: (&#39;See Other&#39;, &#39;Object moved -- see Method and URL list&#39;),
 304: (&#39;Not Modified&#39;,
 &#39;Document has not changed since given time&#39;),
 305: (&#39;Use Proxy&#39;,
 &#39;You must use proxy specified in Location to access this &#39;
 &#39;resource.&#39;),
 307: (&#39;Temporary Redirect&#39;,
 &#39;Object moved temporarily -- see URI list&#39;),

400: (&#39;Bad Request&#39;,
 &#39;Bad request syntax or unsupported method&#39;),
 401: (&#39;Unauthorized&#39;,
 &#39;No permission -- see authorization schemes&#39;),
 402: (&#39;Payment Required&#39;,
 &#39;No payment -- see charging schemes&#39;),
 403: (&#39;Forbidden&#39;,
 &#39;Request forbidden -- authorization will not help&#39;),
 404: (&#39;Not Found&#39;, &#39;Nothing matches the given URI&#39;),
 405: (&#39;Method Not Allowed&#39;,
 &#39;Specified method is invalid for this server.&#39;),
 406: (&#39;Not Acceptable&#39;, &#39;URI not available in preferred format.&#39;),
 407: (&#39;Proxy Authentication Required&#39;, &#39;You must authenticate with &#39;
 &#39;this proxy before proceeding.&#39;),
 408: (&#39;Request Timeout&#39;, &#39;Request timed out; try again later.&#39;),
 409: (&#39;Conflict&#39;, &#39;Request conflict.&#39;),
 410: (&#39;Gone&#39;,
 &#39;URI no longer exists and has been permanently removed.&#39;),
 411: (&#39;Length Required&#39;, &#39;Client must specify Content-Length.&#39;),
 412: (&#39;Precondition Failed&#39;, &#39;Precondition in headers is false.&#39;),
 413: (&#39;Request Entity Too Large&#39;, &#39;Entity is too large.&#39;),
 414: (&#39;Request-URI Too Long&#39;, &#39;URI is too long.&#39;),
 415: (&#39;Unsupported Media Type&#39;, &#39;Entity body in unsupported format.&#39;),
 416: (&#39;Requested Range Not Satisfiable&#39;,
 &#39;Cannot satisfy request range.&#39;),
 417: (&#39;Expectation Failed&#39;,
 &#39;Expect condition could not be satisfied.&#39;),

500: (&#39;Internal Server Error&#39;, &#39;Server got itself in trouble&#39;),
 501: (&#39;Not Implemented&#39;,
 &#39;Server does not support this operation&#39;),
 502: (&#39;Bad Gateway&#39;, &#39;Invalid responses from another server/proxy.&#39;),
 503: (&#39;Service Unavailable&#39;,
 &#39;The server cannot process the request due to a high load&#39;),
 504: (&#39;Gateway Timeout&#39;,
 &#39;The gateway server did not receive a timely response&#39;),
 505: (&#39;HTTP Version Not Supported&#39;, &#39;Cannot fulfill request.&#39;),
 }
</pre></div>
</div>
When an error is raised the server responds by returning an HTTP error code
and an error page. You can use the <tt class="xref docutils literal">HTTPError</tt> instance as a response on the
page returned. This means that as well as the code attribute, it also has read,
geturl, and info, methods.
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; req = urllib2.Request(&#39;http://www.python.org/fish.html&#39;)
&gt;&gt;&gt; try:
&gt;&gt;&gt; urllib2.urlopen(req)
&gt;&gt;&gt; except HTTPError, e:
&gt;&gt;&gt; print e.code
&gt;&gt;&gt; print e.read()
&gt;&gt;&gt;
404
&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD HTML 4.01 Transitional//EN&quot;
 &quot;http://www.w3.org/TR/html4/loose.dtd&quot;&gt;
&lt;?xml-stylesheet href=&quot;./css/ht2html.css&quot;
 type=&quot;text/css&quot;?&gt;
&lt;html&gt;&lt;head&gt;&lt;title&gt;Error 404: File Not Found&lt;/title&gt;
...... etc...
</pre></div>
</div>
</div>
</div>
<div class="section" id="wrapping-it-up">
<h3>Wrapping it Up<a class="headerlink" href="#wrapping-it-up" title="Permalink to this headline">¶</a></h3>
So if you want to be prepared for <tt class="xref docutils literal">HTTPError</tt> or <tt class="xref docutils literal">URLError</tt> there are two
basic approaches. I prefer the second approach.
<div class="section" id="number-1">
<h4>Number 1<a class="headerlink" href="#number-1" title="Permalink to this headline">¶</a></h4>
<div class="highlight-python"><pre>from urllib2 import Request, urlopen, URLError, HTTPError
req = Request(someurl)
try:
 response = urlopen(req)
except HTTPError, e:
 print 'The server couldn\'t fulfill the request.'
 print 'Error code: ', e.code
except URLError, e:
 print 'We failed to reach a server.'
 print 'Reason: ', e.reason
else:
 # everything is fine</pre>
</div>
<div class="admonition note">
Note
The <tt class="docutils literal">except HTTPError</tt> must come first, otherwise <tt class="docutils literal">except URLError</tt>
will also catch an <tt class="xref docutils literal">HTTPError</tt>.
</div>
</div>
<div class="section" id="number-2">
<h4>Number 2<a class="headerlink" href="#number-2" title="Permalink to this headline">¶</a></h4>
<div class="highlight-python"><pre>from urllib2 import Request, urlopen, URLError
req = Request(someurl)
try:
 response = urlopen(req)
except URLError, e:
 if hasattr(e, 'reason'):
 print 'We failed to reach a server.'
 print 'Reason: ', e.reason
 elif hasattr(e, 'code'):
 print 'The server couldn\'t fulfill the request.'
 print 'Error code: ', e.code
else:
 # everything is fine</pre>
</div>
</div>
</div>
</div>
<div class="section" id="info-and-geturl">
<h2>info and geturl<a class="headerlink" href="#info-and-geturl" title="Permalink to this headline">¶</a></h2>
The response returned by urlopen (or the <tt class="xref docutils literal">HTTPError</tt> instance) has two useful
methods <tt class="xref docutils literal">info()</tt> and <tt class="xref docutils literal">geturl()</tt>.
geturl - this returns the real URL of the page fetched. This is useful
because <tt class="docutils literal">urlopen</tt> (or the opener object used) may have followed a
redirect. The URL of the page fetched may not be the same as the URL requested.
info - this returns a dictionary-like object that describes the page
fetched, particularly the headers sent by the server. It is currently an
<tt class="docutils literal">httplib.HTTPMessage</tt> instance.
Typical headers include &#8216;Content-length&#8217;, &#8216;Content-type&#8217;, and so on. See the
<a class="reference external" href="http://www.cs.tut.fi/~jkorpela/http.html">Quick Reference to HTTP Headers</a>
for a useful listing of HTTP headers with brief explanations of their meaning
and use.
</div>
<div class="section" id="openers-and-handlers">
<h2>Openers and Handlers<a class="headerlink" href="#openers-and-handlers" title="Permalink to this headline">¶</a></h2>
When you fetch a URL you use an opener (an instance of the perhaps
confusingly-named <a title="urllib2.OpenerDirector" class="reference external" href="../library/urllib2.html#urllib2.OpenerDirector"><tt class="xref docutils literal">urllib2.OpenerDirector</tt></a>). Normally we have been using
the default opener - via <tt class="docutils literal">urlopen</tt> - but you can create custom
openers. Openers use handlers. All the &#8220;heavy lifting&#8221; is done by the
handlers. Each handler knows how to open URLs for a particular URL scheme (http,
ftp, etc.), or how to handle an aspect of URL opening, for example HTTP
redirections or HTTP cookies.
You will want to create openers if you want to fetch URLs with specific handlers
installed, for example to get an opener that handles cookies, or to get an
opener that does not handle redirections.
To create an opener, instantiate an <tt class="docutils literal">OpenerDirector</tt>, and then call
<tt class="docutils literal">.add_handler(some_handler_instance)</tt> repeatedly.
Alternatively, you can use <tt class="docutils literal">build_opener</tt>, which is a convenience function for
creating opener objects with a single function call. <tt class="docutils literal">build_opener</tt> adds
several handlers by default, but provides a quick way to add more and/or
override the default handlers.
Other sorts of handlers you might want to can handle proxies, authentication,
and other common but slightly specialised situations.
<tt class="docutils literal">install_opener</tt> can be used to make an <tt class="docutils literal">opener</tt> object the (global) default
opener. This means that calls to <tt class="docutils literal">urlopen</tt> will use the opener you have
installed.
Opener objects have an <tt class="docutils literal">open</tt> method, which can be called directly to fetch
urls in the same way as the <tt class="docutils literal">urlopen</tt> function: there&#8217;s no need to call
<tt class="docutils literal">install_opener</tt>, except as a convenience.
</div>
<div class="section" id="id6">
<h2>Basic Authentication<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
To illustrate creating and installing a handler we will use the
<tt class="docutils literal">HTTPBasicAuthHandler</tt>. For a more detailed discussion of this subject &#8211;
including an explanation of how Basic Authentication works - see the <a class="reference external" href="http://www.voidspace.org.uk/python/articles/authentication.shtml">Basic
Authentication Tutorial</a>.
When authentication is required, the server sends a header (as well as the 401
error code) requesting authentication. This specifies the authentication scheme
and a &#8216;realm&#8217;. The header looks like : <tt class="docutils literal">Www-authenticate: SCHEME
realm=&quot;REALM&quot;</tt>.
e.g.
<div class="highlight-python"><pre>Www-authenticate: Basic realm="cPanel Users"</pre>
</div>
The client should then retry the request with the appropriate name and password
for the realm included as a header in the request. This is &#8216;basic
authentication&#8217;. In order to simplify this process we can create an instance of
<tt class="docutils literal">HTTPBasicAuthHandler</tt> and an opener to use this handler.
The <tt class="docutils literal">HTTPBasicAuthHandler</tt> uses an object called a password manager to handle
the mapping of URLs and realms to passwords and usernames. If you know what the
realm is (from the authentication header sent by the server), then you can use a
<tt class="docutils literal">HTTPPasswordMgr</tt>. Frequently one doesn&#8217;t care what the realm is. In that
case, it is convenient to use <tt class="docutils literal">HTTPPasswordMgrWithDefaultRealm</tt>. This allows
you to specify a default username and password for a URL. This will be supplied
in the absence of you providing an alternative combination for a specific
realm. We indicate this by providing <tt class="xref docutils literal">None</tt> as the realm argument to the
<tt class="docutils literal">add_password</tt> method.
The top-level URL is the first URL that requires authentication. URLs &#8220;deeper&#8221;
than the URL you pass to .add_password() will also match.
<div class="highlight-python"><div class="highlight"><pre># create a password manager
password_mgr = urllib2.HTTPPasswordMgrWithDefaultRealm()

# Add the username and password.
# If we knew the realm, we could use it instead of None.
top_level_url = &quot;http://example.com/foo/&quot;
password_mgr.add_password(None, top_level_url, username, password)

handler = urllib2.HTTPBasicAuthHandler(password_mgr)

# create &quot;opener&quot; (OpenerDirector instance)
opener = urllib2.build_opener(handler)

# use the opener to fetch a URL
opener.open(a_url)

# Install the opener.
# Now all calls to urllib2.urlopen use our opener.
urllib2.install_opener(opener)
</pre></div>
</div>
<div class="admonition note">
Note
In the above example we only supplied our <tt class="docutils literal">HTTPBasicAuthHandler</tt> to
<tt class="docutils literal">build_opener</tt>. By default openers have the handlers for normal situations
&#8211; <tt class="docutils literal">ProxyHandler</tt>, <tt class="docutils literal">UnknownHandler</tt>, <tt class="docutils literal">HTTPHandler</tt>,
<tt class="docutils literal">HTTPDefaultErrorHandler</tt>, <tt class="docutils literal">HTTPRedirectHandler</tt>, <tt class="docutils literal">FTPHandler</tt>,
<tt class="docutils literal">FileHandler</tt>, <tt class="docutils literal">HTTPErrorProcessor</tt>.
</div>
<tt class="docutils literal">top_level_url</tt> is in fact either a full URL (including the &#8216;http:&#8217; scheme
component and the hostname and optionally the port number)
e.g. &#8220;<a class="reference external" href="http://example.com/">http://example.com/</a>&#8221; or an &#8220;authority&#8221; (i.e. the hostname,
optionally including the port number) e.g. &#8220;example.com&#8221; or &#8220;example.com:8080&#8221;
(the latter example includes a port number). The authority, if present, must
NOT contain the &#8220;userinfo&#8221; component - for example &#8220;joe&#64;password:example.com&#8221; is
not correct.
</div>
<div class="section" id="proxies">
<h2>Proxies<a class="headerlink" href="#proxies" title="Permalink to this headline">¶</a></h2>
urllib2 will auto-detect your proxy settings and use those. This is through
the <tt class="docutils literal">ProxyHandler</tt> which is part of the normal handler chain. Normally that&#8217;s
a good thing, but there are occasions when it may not be helpful <a class="footnote-reference" href="#id14" id="id7">[6]</a>. One way
to do this is to setup our own <tt class="docutils literal">ProxyHandler</tt>, with no proxies defined. This
is done using similar steps to setting up a <a class="reference external" href="http://www.voidspace.org.uk/python/articles/authentication.shtml">Basic Authentication</a> handler :
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; proxy_support = urllib2.ProxyHandler({})
&gt;&gt;&gt; opener = urllib2.build_opener(proxy_support)
&gt;&gt;&gt; urllib2.install_opener(opener)
</pre></div>
</div>
<div class="admonition note">
Note
Currently <tt class="docutils literal">urllib2</tt> does not support fetching of <tt class="docutils literal">https</tt> locations
through a proxy. However, this can be enabled by extending urllib2 as
shown in the recipe <a class="footnote-reference" href="#id15" id="id8">[7]</a>.
</div>
</div>
<div class="section" id="sockets-and-layers">
<h2>Sockets and Layers<a class="headerlink" href="#sockets-and-layers" title="Permalink to this headline">¶</a></h2>
The Python support for fetching resources from the web is layered. urllib2 uses
the httplib library, which in turn uses the socket library.
As of Python 2.3 you can specify how long a socket should wait for a response
before timing out. This can be useful in applications which have to fetch web
pages. By default the socket module has no timeout and can hang. Currently,
the socket timeout is not exposed at the httplib or urllib2 levels. However,
you can set the default timeout globally for all sockets using
<div class="highlight-python"><div class="highlight"><pre>import socket
import urllib2

# timeout in seconds
timeout = 10
socket.setdefaulttimeout(timeout)

# this call to urllib2.urlopen now uses the default timeout
# we have set in the socket module
req = urllib2.Request(&#39;http://www.voidspace.org.uk&#39;)
response = urllib2.urlopen(req)
</pre></div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="footnotes">
<h2>Footnotes<a class="headerlink" href="#footnotes" title="Permalink to this headline">¶</a></h2>
This document was reviewed and revised by John Lee.
<table class="docutils footnote" frame="void" id="id9" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>For an introduction to the CGI protocol see
<a class="reference external" href="http://www.pyzine.com/Issue008/Section_Articles/article_CGIOne.html">Writing Web Applications in Python</a>.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id10" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>Like Google for example. The proper way to use google from a program
is to use <a class="reference external" href="http://pygoogle.sourceforge.net">PyGoogle</a> of course. See
<a class="reference external" href="http://www.voidspace.org.uk/python/recipebook.shtml#google">Voidspace Google</a>
for some examples of using the Google API.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id11" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id3">[3]</a></td><td>Browser sniffing is a very bad practise for website design - building
sites using web standards is much more sensible. Unfortunately a lot of
sites still send different versions to different browsers.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id12" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id4">[4]</a></td><td>The user agent for MSIE 6 is
&#8216;Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)&#8217;</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id13" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id5">[5]</a></td><td>For details of more HTTP request headers, see
<a class="reference external" href="http://www.cs.tut.fi/~jkorpela/http.html">Quick Reference to HTTP Headers</a>.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id14" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id7">[6]</a></td><td>In my case I have to use a proxy to access the internet at work. If you
attempt to fetch localhost URLs through this proxy it blocks them. IE
is set to use the proxy, which urllib2 picks up on. In order to test
scripts with a localhost server, I have to prevent urllib2 from using
the proxy.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id15" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id8">[7]</a></td><td>urllib2 opener for SSL proxy (CONNECT method): <a class="reference external" href="http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/456195">ASPN Cookbook Recipe</a>.</td></tr>
</tbody>
</table>
</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="#">HOWTO Fetch Internet Resources Using urllib2</a><ul>
<li><a class="reference external" href="#introduction">Introduction</a></li>
<li><a class="reference external" href="#fetching-urls">Fetching URLs</a><ul>
<li><a class="reference external" href="#data">Data</a></li>
<li><a class="reference external" href="#headers">Headers</a></li>
</ul>
</li>
<li><a class="reference external" href="#handling-exceptions">Handling Exceptions</a><ul>
<li><a class="reference external" href="#urlerror">URLError</a></li>
<li><a class="reference external" href="#httperror">HTTPError</a><ul>
<li><a class="reference external" href="#error-codes">Error Codes</a></li>
</ul>
</li>
<li><a class="reference external" href="#wrapping-it-up">Wrapping it Up</a><ul>
<li><a class="reference external" href="#number-1">Number 1</a></li>
<li><a class="reference external" href="#number-2">Number 2</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference external" href="#info-and-geturl">info and geturl</a></li>
<li><a class="reference external" href="#openers-and-handlers">Openers and Handlers</a></li>
<li><a class="reference external" href="#id6">Basic Authentication</a></li>
<li><a class="reference external" href="#proxies">Proxies</a></li>
<li><a class="reference external" href="#sockets-and-layers">Sockets and Layers</a></li>
<li><a class="reference external" href="#footnotes">Footnotes</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="unicode.html"
 title="previous chapter">Unicode HOWTO</a>
 <h4>Next topic</h4>
 <a href="webservers.html"
 title="next chapter">HOWTO Use Python in the web</a>
<h3>This Page</h3>
<ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li><a href="../_sources/howto/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>
 
 Enter search terms or a module, class or function name.
 
 </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="webservers.html" title="HOWTO Use Python in the web"
 >next</a> |</li>
 <li class="right" >
 <a href="unicode.html" title="Unicode HOWTO"
 >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.6 documentation</a> &raquo;</li>

<li><a href="index.html" >Python HOWTOs</a> &raquo;</li> 
 </ul>
 </div>
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2011, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation. 
 <a href="http://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on Jul 20, 2011.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6.
 </div>

</body>
</html>

Back to File Manager