<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"node483.html" />
<link rel=
"prev" href=
"module-urllib.html" />
<link rel=
"parent" href=
"module-urllib.html" />
<link rel=
"next" href=
"node483.html" />
<meta name='aesop' content='information'
/>
<title>11.4.1 URLopener Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.4 urllib "
href=
"module-urllib.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11.4 urllib "
href=
"module-urllib.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.4.2 Examples"
href=
"node483.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-urllib.html">11.4 urllib
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-urllib.html">11.4 urllib
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"node483.html">11.4.2 Examples
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION0013410000000000000000"></A><A NAME=
"urlopener-objs"></A>
<tt class=
"class">URLopener
</tt> and
<tt class=
"class">FancyURLopener
</tt> objects have the
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3212' xml:id='l2h-
3212'
class=
"method">open
</tt></b>(
</nobr></td>
<td><var>fullurl
</var><big>[
</big><var>, data
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Open
<var>fullurl
</var> using the appropriate protocol. This method sets
up cache and proxy information, then calls the appropriate open method with
its input arguments. If the scheme is not recognized,
<tt class=
"method">open_unknown()
</tt> is called. The
<var>data
</var> argument
has the same meaning as the
<var>data
</var> argument of
<tt class=
"function">urlopen()
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3213' xml:id='l2h-
3213'
class=
"method">open_unknown
</tt></b>(
</nobr></td>
<td><var>fullurl
</var><big>[
</big><var>, data
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Overridable interface to open unknown URL types.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3214' xml:id='l2h-
3214'
class=
"method">retrieve
</tt></b>(
</nobr></td>
<td><var>url
</var><big>[
</big><var>,
filename
</var><big>[
</big><var>,
reporthook
</var><big>[
</big><var>, data
</var><big>]
</big><var></var><big>]
</big><var></var><big>]
</big><var></var>)
</td></tr></table></dt>
Retrieves the contents of
<var>url
</var> and places it in
<var>filename
</var>. The
return value is a tuple consisting of a local filename and either a
<tt class=
"class">mimetools.Message
</tt> object containing the response headers (for remote
URLs) or
<code>None
</code> (for local URLs). The caller must then open and read the
contents of
<var>filename
</var>. If
<var>filename
</var> is not given and the URL
refers to a local file, the input filename is returned. If the URL is
non-local and
<var>filename
</var> is not given, the filename is the output of
<tt class=
"function">tempfile.mktemp()
</tt> with a suffix that matches the suffix of the last
path component of the input URL. If
<var>reporthook
</var> is given, it must be
a function accepting three numeric parameters. It will be called after each
chunk of data is read from the network.
<var>reporthook
</var> is ignored for
If the
<var>url
</var> uses the
<span class=
"file">http:
</span> scheme identifier, the optional
<var>data
</var> argument may be given to specify a
<code>POST
</code> request
(normally the request type is
<code>GET
</code>). The
<var>data
</var> argument
must in standard
<span class=
"mimetype">application/x-www-form-urlencoded
</span> format;
see the
<tt class=
"function">urlencode()
</tt> function below.
<dl><dt><b><tt id='l2h-
3215' xml:id='l2h-
3215'
class=
"member">version
</tt></b></dt>
Variable that specifies the user agent of the opener object. To get
<tt class=
"module"><a href=
"module-urllib.html">urllib
</a></tt> to tell servers that it is a particular user agent,
set this in a subclass as a class variable or in the constructor
before calling the base constructor.
The
<tt class=
"class">FancyURLopener
</tt> class offers one additional method that
should be overloaded to provide the appropriate behavior:
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3216' xml:id='l2h-
3216'
class=
"method">prompt_user_passwd
</tt></b>(
</nobr></td>
<td><var>host, realm
</var>)
</td></tr></table></dt>
Return information needed to authenticate the user at the given host
in the specified security realm. The return value should be a tuple,
<code>(
<var>user
</var>,
<var>password
</var>)
</code>, which can be used for basic
The implementation prompts for this information on the terminal; an
application should override this method to use an appropriate
interaction model in the local environment.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.4 urllib "
href=
"module-urllib.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11.4 urllib "
href=
"module-urllib.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.4.2 Examples"
href=
"node483.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-urllib.html">11.4 urllib
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-urllib.html">11.4 urllib
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"node483.html">11.4.2 Examples
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.