Linux ip-148-66-134-25.ip.secureserver.net 3.10.0-1160.119.1.el7.tuxcare.els11.x86_64 #1 SMP Sun Nov 3 09:06:59 UTC 2024 x86_64
Apache
: 148.66.134.25 | : 3.149.250.65
66 Domain
8.0.30
amvm
www.github.com/MadExploits
Terminal
AUTO ROOT
Adminer
Backdoor Destroyer
Linux Exploit
Lock Shell
Lock File
Create User
CREATE RDP
PHP Mailer
BACKCONNECT
UNLOCK SHELL
HASH IDENTIFIER
CPANEL RESET
BLACK DEFEND!
README
+ Create Folder
+ Create File
/
usr /
share /
doc /
python-docs-2.7.5 /
html /
library /
[ HOME SHELL ]
Name
Size
Permission
Action
2to3.html
49.27
KB
-rw-r--r--
__builtin__.html
10.26
KB
-rw-r--r--
__future__.html
13.79
KB
-rw-r--r--
__main__.html
7.05
KB
-rw-r--r--
_winreg.html
59.21
KB
-rw-r--r--
abc.html
23.9
KB
-rw-r--r--
aepack.html
13.16
KB
-rw-r--r--
aetools.html
14.91
KB
-rw-r--r--
aetypes.html
18.88
KB
-rw-r--r--
aifc.html
22.4
KB
-rw-r--r--
al.html
17.34
KB
-rw-r--r--
allos.html
33.72
KB
-rw-r--r--
anydbm.html
16.33
KB
-rw-r--r--
archiving.html
9.26
KB
-rw-r--r--
argparse.html
237.62
KB
-rw-r--r--
array.html
29.29
KB
-rw-r--r--
ast.html
34.98
KB
-rw-r--r--
asynchat.html
31.43
KB
-rw-r--r--
asyncore.html
36.51
KB
-rw-r--r--
atexit.html
16.8
KB
-rw-r--r--
audioop.html
31.36
KB
-rw-r--r--
autogil.html
8.19
KB
-rw-r--r--
base64.html
19.67
KB
-rw-r--r--
basehttpserver.html
34.04
KB
-rw-r--r--
bastion.html
11.04
KB
-rw-r--r--
bdb.html
36.68
KB
-rw-r--r--
binascii.html
20.67
KB
-rw-r--r--
binhex.html
10.58
KB
-rw-r--r--
bisect.html
23.24
KB
-rw-r--r--
bsddb.html
26.43
KB
-rw-r--r--
bz2.html
26.08
KB
-rw-r--r--
calendar.html
37.79
KB
-rw-r--r--
carbon.html
48.94
KB
-rw-r--r--
cd.html
27.96
KB
-rw-r--r--
cgi.html
49.92
KB
-rw-r--r--
cgihttpserver.html
13.1
KB
-rw-r--r--
cgitb.html
11.41
KB
-rw-r--r--
chunk.html
14.66
KB
-rw-r--r--
cmath.html
25.63
KB
-rw-r--r--
cmd.html
26.09
KB
-rw-r--r--
code.html
24.58
KB
-rw-r--r--
codecs.html
100.64
KB
-rw-r--r--
codeop.html
14.84
KB
-rw-r--r--
collections.html
133.96
KB
-rw-r--r--
colorpicker.html
7.52
KB
-rw-r--r--
colorsys.html
11.04
KB
-rw-r--r--
commands.html
14.36
KB
-rw-r--r--
compileall.html
16.83
KB
-rw-r--r--
compiler.html
67.75
KB
-rw-r--r--
configparser.html
62.13
KB
-rw-r--r--
constants.html
12.83
KB
-rw-r--r--
contextlib.html
19.39
KB
-rw-r--r--
cookie.html
39.07
KB
-rw-r--r--
cookielib.html
83.82
KB
-rw-r--r--
copy.html
12.19
KB
-rw-r--r--
copy_reg.html
13.76
KB
-rw-r--r--
crypt.html
10.04
KB
-rw-r--r--
crypto.html
7.59
KB
-rw-r--r--
csv.html
67.37
KB
-rw-r--r--
ctypes.html
238.78
KB
-rw-r--r--
curses.ascii.html
22.29
KB
-rw-r--r--
curses.html
146.63
KB
-rw-r--r--
curses.panel.html
14.39
KB
-rw-r--r--
custominterp.html
7.62
KB
-rw-r--r--
datatypes.html
16.84
KB
-rw-r--r--
datetime.html
226.59
KB
-rw-r--r--
dbhash.html
15.48
KB
-rw-r--r--
dbm.html
12.07
KB
-rw-r--r--
debug.html
10.15
KB
-rw-r--r--
decimal.html
194.44
KB
-rw-r--r--
development.html
14.17
KB
-rw-r--r--
difflib.html
84.83
KB
-rw-r--r--
dircache.html
11.41
KB
-rw-r--r--
dis.html
69.95
KB
-rw-r--r--
distutils.html
8.05
KB
-rw-r--r--
dl.html
16.33
KB
-rw-r--r--
doctest.html
165.54
KB
-rw-r--r--
docxmlrpcserver.html
16.43
KB
-rw-r--r--
dumbdbm.html
14.02
KB
-rw-r--r--
dummy_thread.html
9.43
KB
-rw-r--r--
dummy_threading.html
8.37
KB
-rw-r--r--
easydialogs.html
30.55
KB
-rw-r--r--
email-examples.html
45.65
KB
-rw-r--r--
email.charset.html
26.8
KB
-rw-r--r--
email.encoders.html
11.86
KB
-rw-r--r--
email.errors.html
15.77
KB
-rw-r--r--
email.generator.html
20.77
KB
-rw-r--r--
email.header.html
26.92
KB
-rw-r--r--
email.html
44.24
KB
-rw-r--r--
email.iterators.html
11.52
KB
-rw-r--r--
email.message.html
63.16
KB
-rw-r--r--
email.mime.html
27.93
KB
-rw-r--r--
email.parser.html
30.45
KB
-rw-r--r--
email.util.html
24.46
KB
-rw-r--r--
errno.html
37.99
KB
-rw-r--r--
exceptions.html
56.13
KB
-rw-r--r--
fcntl.html
22.67
KB
-rw-r--r--
filecmp.html
22.3
KB
-rw-r--r--
fileformats.html
9.14
KB
-rw-r--r--
fileinput.html
24.28
KB
-rw-r--r--
filesys.html
10.2
KB
-rw-r--r--
fl.html
49.92
KB
-rw-r--r--
fm.html
11.91
KB
-rw-r--r--
fnmatch.html
14.58
KB
-rw-r--r--
formatter.html
34.06
KB
-rw-r--r--
fpectl.html
16.01
KB
-rw-r--r--
fpformat.html
10.59
KB
-rw-r--r--
fractions.html
22.61
KB
-rw-r--r--
framework.html
33.34
KB
-rw-r--r--
frameworks.html
7.14
KB
-rw-r--r--
ftplib.html
43.99
KB
-rw-r--r--
functions.html
183.14
KB
-rw-r--r--
functools.html
27.17
KB
-rw-r--r--
future_builtins.html
13.04
KB
-rw-r--r--
gc.html
25.75
KB
-rw-r--r--
gdbm.html
15.96
KB
-rw-r--r--
gensuitemodule.html
11.51
KB
-rw-r--r--
getopt.html
23.66
KB
-rw-r--r--
getpass.html
10.65
KB
-rw-r--r--
gettext.html
78.76
KB
-rw-r--r--
gl.html
22.09
KB
-rw-r--r--
glob.html
13.26
KB
-rw-r--r--
grp.html
10.49
KB
-rw-r--r--
gzip.html
18.99
KB
-rw-r--r--
hashlib.html
18.2
KB
-rw-r--r--
heapq.html
31.61
KB
-rw-r--r--
hmac.html
10.46
KB
-rw-r--r--
hotshot.html
18.65
KB
-rw-r--r--
htmllib.html
25.32
KB
-rw-r--r--
htmlparser.html
39.11
KB
-rw-r--r--
httplib.html
62.95
KB
-rw-r--r--
i18n.html
9.52
KB
-rw-r--r--
ic.html
17.17
KB
-rw-r--r--
idle.html
20.9
KB
-rw-r--r--
imageop.html
14.76
KB
-rw-r--r--
imaplib.html
51.99
KB
-rw-r--r--
imgfile.html
11.71
KB
-rw-r--r--
imghdr.html
11.3
KB
-rw-r--r--
imp.html
34.34
KB
-rw-r--r--
importlib.html
8.26
KB
-rw-r--r--
imputil.html
31.81
KB
-rw-r--r--
index.html
72.78
KB
-rw-r--r--
inspect.html
50.71
KB
-rw-r--r--
internet.html
24.87
KB
-rw-r--r--
intro.html
8.93
KB
-rw-r--r--
io.html
98.13
KB
-rw-r--r--
ipc.html
13.41
KB
-rw-r--r--
itertools.html
115.91
KB
-rw-r--r--
jpeg.html
12.74
KB
-rw-r--r--
json.html
67.04
KB
-rw-r--r--
keyword.html
7.68
KB
-rw-r--r--
language.html
11.03
KB
-rw-r--r--
linecache.html
10.59
KB
-rw-r--r--
locale.html
55.14
KB
-rw-r--r--
logging.config.html
63.36
KB
-rw-r--r--
logging.handlers.html
69.64
KB
-rw-r--r--
logging.html
95.64
KB
-rw-r--r--
mac.html
21.79
KB
-rw-r--r--
macos.html
14.76
KB
-rw-r--r--
macosa.html
12.96
KB
-rw-r--r--
macostools.html
15.52
KB
-rw-r--r--
macpath.html
7.76
KB
-rw-r--r--
mailbox.html
156.75
KB
-rw-r--r--
mailcap.html
13.21
KB
-rw-r--r--
markup.html
18.77
KB
-rw-r--r--
marshal.html
17.98
KB
-rw-r--r--
math.html
39.24
KB
-rw-r--r--
md5.html
13.97
KB
-rw-r--r--
mhlib.html
21.54
KB
-rw-r--r--
mimetools.html
19.25
KB
-rw-r--r--
mimetypes.html
28.39
KB
-rw-r--r--
mimewriter.html
15.02
KB
-rw-r--r--
mimify.html
13.36
KB
-rw-r--r--
miniaeframe.html
12.2
KB
-rw-r--r--
misc.html
6.87
KB
-rw-r--r--
mm.html
9.03
KB
-rw-r--r--
mmap.html
28.36
KB
-rw-r--r--
modulefinder.html
15.31
KB
-rw-r--r--
modules.html
8.46
KB
-rw-r--r--
msilib.html
52.43
KB
-rw-r--r--
msvcrt.html
19.37
KB
-rw-r--r--
multifile.html
24.3
KB
-rw-r--r--
multiprocessing.html
365.71
KB
-rw-r--r--
mutex.html
11.23
KB
-rw-r--r--
netdata.html
16.98
KB
-rw-r--r--
netrc.html
12.3
KB
-rw-r--r--
new.html
12.12
KB
-rw-r--r--
nis.html
10.64
KB
-rw-r--r--
nntplib.html
41.92
KB
-rw-r--r--
numbers.html
37.75
KB
-rw-r--r--
numeric.html
13.55
KB
-rw-r--r--
operator.html
82
KB
-rw-r--r--
optparse.html
222.56
KB
-rw-r--r--
os.html
214.25
KB
-rw-r--r--
os.path.html
38.34
KB
-rw-r--r--
ossaudiodev.html
41.5
KB
-rw-r--r--
othergui.html
9.08
KB
-rw-r--r--
parser.html
39.36
KB
-rw-r--r--
pdb.html
33.96
KB
-rw-r--r--
persistence.html
14.87
KB
-rw-r--r--
pickle.html
102.27
KB
-rw-r--r--
pickletools.html
10.63
KB
-rw-r--r--
pipes.html
18.01
KB
-rw-r--r--
pkgutil.html
25.11
KB
-rw-r--r--
platform.html
28.37
KB
-rw-r--r--
plistlib.html
17.03
KB
-rw-r--r--
popen2.html
25.43
KB
-rw-r--r--
poplib.html
22.32
KB
-rw-r--r--
posix.html
14.41
KB
-rw-r--r--
posixfile.html
19.76
KB
-rw-r--r--
pprint.html
29.92
KB
-rw-r--r--
profile.html
63.56
KB
-rw-r--r--
pty.html
9.48
KB
-rw-r--r--
pwd.html
11.43
KB
-rw-r--r--
py_compile.html
11.12
KB
-rw-r--r--
pyclbr.html
14.71
KB
-rw-r--r--
pydoc.html
11.48
KB
-rw-r--r--
pyexpat.html
71.53
KB
-rw-r--r--
python.html
12.27
KB
-rw-r--r--
queue.html
24.22
KB
-rw-r--r--
quopri.html
11.9
KB
-rw-r--r--
random.html
37.83
KB
-rw-r--r--
re.html
134.74
KB
-rw-r--r--
readline.html
28.24
KB
-rw-r--r--
repr.html
20.43
KB
-rw-r--r--
resource.html
26.48
KB
-rw-r--r--
restricted.html
11.65
KB
-rw-r--r--
rexec.html
37.41
KB
-rw-r--r--
rfc822.html
42.22
KB
-rw-r--r--
rlcompleter.html
13.51
KB
-rw-r--r--
robotparser.html
12.27
KB
-rw-r--r--
runpy.html
19.34
KB
-rw-r--r--
sched.html
18.54
KB
-rw-r--r--
scrolledtext.html
9.32
KB
-rw-r--r--
select.html
39.67
KB
-rw-r--r--
sets.html
36.92
KB
-rw-r--r--
sgi.html
9.71
KB
-rw-r--r--
sgmllib.html
30.77
KB
-rw-r--r--
sha.html
12.09
KB
-rw-r--r--
shelve.html
27.02
KB
-rw-r--r--
shlex.html
32.1
KB
-rw-r--r--
shutil.html
40.22
KB
-rw-r--r--
signal.html
31.14
KB
-rw-r--r--
simplehttpserver.html
18.41
KB
-rw-r--r--
simplexmlrpcserver.html
31.39
KB
-rw-r--r--
site.html
23.64
KB
-rw-r--r--
smtpd.html
12.46
KB
-rw-r--r--
smtplib.html
42.13
KB
-rw-r--r--
sndhdr.html
10.02
KB
-rw-r--r--
socket.html
106.34
KB
-rw-r--r--
socketserver.html
59.83
KB
-rw-r--r--
someos.html
15.11
KB
-rw-r--r--
spwd.html
10.33
KB
-rw-r--r--
sqlite3.html
139.5
KB
-rw-r--r--
ssl.html
65.62
KB
-rw-r--r--
stat.html
32.31
KB
-rw-r--r--
statvfs.html
10.6
KB
-rw-r--r--
stdtypes.html
260.4
KB
-rw-r--r--
string.html
106.65
KB
-rw-r--r--
stringio.html
18.81
KB
-rw-r--r--
stringprep.html
16.13
KB
-rw-r--r--
strings.html
14.93
KB
-rw-r--r--
struct.html
40.88
KB
-rw-r--r--
subprocess.html
84.91
KB
-rw-r--r--
sun.html
6.84
KB
-rw-r--r--
sunau.html
27.1
KB
-rw-r--r--
sunaudio.html
17.79
KB
-rw-r--r--
symbol.html
7.66
KB
-rw-r--r--
symtable.html
22.94
KB
-rw-r--r--
sys.html
98.7
KB
-rw-r--r--
sysconfig.html
23.84
KB
-rw-r--r--
syslog.html
17.92
KB
-rw-r--r--
tabnanny.html
10.63
KB
-rw-r--r--
tarfile.html
78.68
KB
-rw-r--r--
telnetlib.html
25.48
KB
-rw-r--r--
tempfile.html
29.42
KB
-rw-r--r--
termios.html
16.01
KB
-rw-r--r--
test.html
52.62
KB
-rw-r--r--
textwrap.html
27.25
KB
-rw-r--r--
thread.html
20.47
KB
-rw-r--r--
threading.html
76.69
KB
-rw-r--r--
time.html
56.93
KB
-rw-r--r--
timeit.html
36.27
KB
-rw-r--r--
tix.html
46.96
KB
-rw-r--r--
tk.html
23.64
KB
-rw-r--r--
tkinter.html
67.67
KB
-rw-r--r--
token.html
19.62
KB
-rw-r--r--
tokenize.html
18.45
KB
-rw-r--r--
trace.html
25.54
KB
-rw-r--r--
traceback.html
33.44
KB
-rw-r--r--
ttk.html
101.75
KB
-rw-r--r--
tty.html
9.06
KB
-rw-r--r--
turtle.html
211.74
KB
-rw-r--r--
types.html
27.59
KB
-rw-r--r--
undoc.html
23.16
KB
-rw-r--r--
unicodedata.html
18.55
KB
-rw-r--r--
unittest.html
202.85
KB
-rw-r--r--
unix.html
10.55
KB
-rw-r--r--
urllib.html
58.68
KB
-rw-r--r--
urllib2.html
100.58
KB
-rw-r--r--
urlparse.html
40.41
KB
-rw-r--r--
user.html
11.83
KB
-rw-r--r--
userdict.html
29.73
KB
-rw-r--r--
uu.html
11.03
KB
-rw-r--r--
uuid.html
28.19
KB
-rw-r--r--
warnings.html
46.6
KB
-rw-r--r--
wave.html
22.22
KB
-rw-r--r--
weakref.html
36.52
KB
-rw-r--r--
webbrowser.html
23.07
KB
-rw-r--r--
whichdb.html
8.85
KB
-rw-r--r--
windows.html
9.33
KB
-rw-r--r--
winsound.html
18.75
KB
-rw-r--r--
wsgiref.html
81.04
KB
-rw-r--r--
xdrlib.html
29.94
KB
-rw-r--r--
xml.dom.html
89.04
KB
-rw-r--r--
xml.dom.minidom.html
40.42
KB
-rw-r--r--
xml.dom.pulldom.html
12.71
KB
-rw-r--r--
xml.etree.elementtree.html
93.22
KB
-rw-r--r--
xml.html
16.49
KB
-rw-r--r--
xml.sax.handler.html
38.63
KB
-rw-r--r--
xml.sax.html
20.22
KB
-rw-r--r--
xml.sax.reader.html
39.09
KB
-rw-r--r--
xml.sax.utils.html
14.26
KB
-rw-r--r--
xmlrpclib.html
60.79
KB
-rw-r--r--
zipfile.html
53.14
KB
-rw-r--r--
zipimport.html
20.42
KB
-rw-r--r--
zlib.html
25.46
KB
-rw-r--r--
Delete
Unzip
Zip
${this.title}
Close
Code Editor : 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>20.6. urllib2 — extensible library for opening URLs — Python 2.7.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.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.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 2.7.5 documentation" href="../index.html" /> <link rel="up" title="20. Internet Protocols and Support" href="internet.html" /> <link rel="next" title="20.7. httplib — HTTP protocol client" href="httplib.html" /> <link rel="prev" title="20.5. urllib — Open arbitrary resources by URL" href="urllib.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="httplib.html" title="20.7. httplib — HTTP protocol client" accesskey="N">next</a> |</li> <li class="right" > <a href="urllib.html" title="20.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="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="internet.html" accesskey="U">20. 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"> <span id="urllib2-extensible-library-for-opening-urls"></span><h1>20.6. <a class="reference internal" href="#module-urllib2" title="urllib2: Next generation URL opening library."><tt class="xref py py-mod docutils literal"><span class="pre">urllib2</span></tt></a> — 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 <a class="reference internal" href="#module-urllib2" title="urllib2: Next generation URL opening library."><tt class="xref py py-mod docutils literal"><span class="pre">urllib2</span></tt></a> module has been split across several modules in Python 3 named <tt class="xref py py-mod docutils literal"><span class="pre">urllib.request</span></tt> and <tt class="xref py py-mod docutils literal"><span class="pre">urllib.error</span></tt>. The <a class="reference internal" href="../glossary.html#term-to3"><em class="xref std std-term">2to3</em></a> tool will automatically adapt imports when converting your sources to Python 3.</p> </div> <p>The <a class="reference internal" href="#module-urllib2" title="urllib2: Next generation URL opening library."><tt class="xref py py-mod docutils literal"><span class="pre">urllib2</span></tt></a> module defines functions and classes which help in opening URLs (mostly HTTP) in a complex world — basic and digest authentication, redirections, cookies and more.</p> <p>The <a class="reference internal" href="#module-urllib2" title="urllib2: Next generation URL opening library."><tt class="xref py py-mod docutils literal"><span class="pre">urllib2</span></tt></a> 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[, data][, timeout]</em><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 class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object.</p> <div class="admonition warning"> <p class="first admonition-title">Warning</p> <p class="last">HTTPS requests do not do any verification of the server’s certificate.</p> </div> <p><em>data</em> may be a string specifying additional data to send to the server, or <tt class="docutils literal"><span class="pre">None</span></tt> if no such data is needed. Currently HTTP requests are the only ones that use <em>data</em>; the HTTP request will be a POST instead of a GET when the <em>data</em> parameter is provided. <em>data</em> should be a buffer in the standard <em class="mimetype">application/x-www-form-urlencoded</em> format. The <a class="reference internal" href="urllib.html#urllib.urlencode" title="urllib.urlencode"><tt class="xref py py-func 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. urllib2 module sends HTTP/1.1 requests with <tt class="docutils literal"><span class="pre">Connection:close</span></tt> header included.</p> <p>The optional <em>timeout</em> parameter specifies a timeout in seconds for blocking operations like the connection attempt (if not specified, the global default timeout setting will be used). This actually only works for HTTP, HTTPS and FTP connections.</p> <p>This function returns a file-like object with two additional methods:</p> <ul class="simple"> <li><tt class="xref py py-meth docutils literal"><span class="pre">geturl()</span></tt> — return the URL of the resource retrieved, commonly used to determine if a redirect was followed</li> <li><tt class="xref py py-meth docutils literal"><span class="pre">info()</span></tt> — return the meta-information of the page, such as headers, in the form of an <a class="reference internal" href="mimetools.html#mimetools.Message" title="mimetools.Message"><tt class="xref py py-class docutils literal"><span class="pre">mimetools.Message</span></tt></a> instance (see <a class="reference external" href="http://www.cs.tut.fi/~jkorpela/http.html">Quick Reference to HTTP Headers</a>)</li> <li><tt class="xref py py-meth docutils literal"><span class="pre">getcode()</span></tt> — return the HTTP status code of the response.</li> </ul> <p>Raises <a class="reference internal" href="#urllib2.URLError" title="urllib2.URLError"><tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt></a> on errors.</p> <p>Note that <tt class="docutils literal"><span class="pre">None</span></tt> may be returned if no handler handles the request (though the default installed global <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> uses <a class="reference internal" href="#urllib2.UnknownHandler" title="urllib2.UnknownHandler"><tt class="xref py py-class docutils literal"><span class="pre">UnknownHandler</span></tt></a> to ensure this never happens).</p> <p>In addition, if proxy settings are detected (for example, when a <tt class="docutils literal"><span class="pre">*_proxy</span></tt> environment variable like <span class="target" id="index-0"></span><tt class="xref std std-envvar docutils literal"><span class="pre">http_proxy</span></tt> is set), <a class="reference internal" href="#urllib2.ProxyHandler" title="urllib2.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> is default installed and makes sure the requests are handled through the proxy.</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><p>Install an <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> instance as the default global opener. Installing an opener is only necessary if you want urlopen to use that opener; otherwise, simply call <a class="reference internal" href="#urllib2.OpenerDirector.open" title="urllib2.OpenerDirector.open"><tt class="xref py py-meth docutils literal"><span class="pre">OpenerDirector.open()</span></tt></a> instead of <a class="reference internal" href="#urllib2.urlopen" title="urllib2.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>. The code does not check for a real <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>, and any class with the appropriate interface will work.</p> </dd></dl> <dl class="function"> <dt id="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 class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> instance, which chains the handlers in the order given. <em>handler</em>s can be either instances of <a class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, or subclasses of <a class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a> (in which case it must be possible to call the constructor without any parameters). Instances of the following classes will be in front of the <em>handler</em>s, unless the <em>handler</em>s contain them, instances of them or subclasses of them: <a class="reference internal" href="#urllib2.ProxyHandler" title="urllib2.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> (if proxy settings are detected), <a class="reference internal" href="#urllib2.UnknownHandler" title="urllib2.UnknownHandler"><tt class="xref py py-class docutils literal"><span class="pre">UnknownHandler</span></tt></a>, <a class="reference internal" href="#urllib2.HTTPHandler" title="urllib2.HTTPHandler"><tt class="xref py py-class docutils literal"><span class="pre">HTTPHandler</span></tt></a>, <a class="reference internal" href="#urllib2.HTTPDefaultErrorHandler" title="urllib2.HTTPDefaultErrorHandler"><tt class="xref py py-class docutils literal"><span class="pre">HTTPDefaultErrorHandler</span></tt></a>, <a class="reference internal" href="#urllib2.HTTPRedirectHandler" title="urllib2.HTTPRedirectHandler"><tt class="xref py py-class docutils literal"><span class="pre">HTTPRedirectHandler</span></tt></a>, <a class="reference internal" href="#urllib2.FTPHandler" title="urllib2.FTPHandler"><tt class="xref py py-class docutils literal"><span class="pre">FTPHandler</span></tt></a>, <a class="reference internal" href="#urllib2.FileHandler" title="urllib2.FileHandler"><tt class="xref py py-class docutils literal"><span class="pre">FileHandler</span></tt></a>, <a class="reference internal" href="#urllib2.HTTPErrorProcessor" title="urllib2.HTTPErrorProcessor"><tt class="xref py py-class docutils literal"><span class="pre">HTTPErrorProcessor</span></tt></a>.</p> <p>If the Python installation has SSL support (i.e., if the <a class="reference internal" href="ssl.html#module-ssl" title="ssl: TLS/SSL wrapper for socket objects"><tt class="xref py py-mod docutils literal"><span class="pre">ssl</span></tt></a> module can be imported), <a class="reference internal" href="#urllib2.HTTPSHandler" title="urllib2.HTTPSHandler"><tt class="xref py py-class docutils literal"><span class="pre">HTTPSHandler</span></tt></a> will also be added.</p> <p>Beginning in Python 2.3, a <a class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a> subclass may also change its <tt class="xref py py-attr docutils literal"><span class="pre">handler_order</span></tt> attribute to modify its position in the handlers list.</p> </dd></dl> <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 class="reference internal" href="exceptions.html#exceptions.IOError" title="exceptions.IOError"><tt class="xref py py-exc 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><p>The reason for this error. It can be a message string or another exception instance (<a class="reference internal" href="socket.html#socket.error" title="socket.error"><tt class="xref py py-exc docutils literal"><span class="pre">socket.error</span></tt></a> for remote URLs, <a class="reference internal" href="exceptions.html#exceptions.OSError" title="exceptions.OSError"><tt class="xref py py-exc docutils literal"><span class="pre">OSError</span></tt></a> for local URLs).</p> </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 class="reference internal" href="#urllib2.URLError" title="urllib2.URLError"><tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt></a>), an <a class="reference internal" href="#urllib2.HTTPError" title="urllib2.HTTPError"><tt class="xref py py-exc 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 class="reference internal" href="#urllib2.urlopen" title="urllib2.urlopen"><tt class="xref py py-func 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><p>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 class="reference internal" href="basehttpserver.html#BaseHTTPServer.BaseHTTPRequestHandler.responses" title="BaseHTTPServer.BaseHTTPRequestHandler.responses"><tt class="xref py py-attr docutils literal"><span class="pre">BaseHTTPServer.BaseHTTPRequestHandler.responses</span></tt></a>.</p> </dd></dl> <dl class="attribute"> <dt id="urllib2.HTTPError.reason"> <tt class="descname">reason</tt><a class="headerlink" href="#urllib2.HTTPError.reason" title="Permalink to this definition">¶</a></dt> <dd><p>The reason for this error. It can be a message string or another exception instance.</p> </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[, data][, headers][, origin_req_host][, unverifiable]</em><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="docutils literal"><span class="pre">None</span></tt> if no such data is needed. Currently HTTP requests are the only ones that use <em>data</em>; the HTTP request will be a POST instead of a GET when the <em>data</em> parameter is provided. <em>data</em> should be a buffer in the standard <em class="mimetype">application/x-www-form-urlencoded</em> format. The <a class="reference internal" href="urllib.html#urllib.urlencode" title="urllib.urlencode"><tt class="xref py py-func 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 class="reference internal" href="#urllib2.Request.add_header" title="urllib2.Request.add_header"><tt class="xref py py-meth docutils literal"><span class="pre">add_header()</span></tt></a> was called with each key and value as arguments. This is often used to “spoof” the <tt class="docutils literal"><span class="pre">User-Agent</span></tt> header, which is used by a browser to identify itself – some HTTP servers only allow requests coming from common browsers as opposed to scripts. For example, Mozilla Firefox may identify itself as <tt class="docutils literal"><span class="pre">"Mozilla/5.0</span> <span class="pre">(X11;</span> <span class="pre">U;</span> <span class="pre">Linux</span> <span class="pre">i686)</span> <span class="pre">Gecko/20071127</span> <span class="pre">Firefox/2.0.0.11"</span></tt>, while <a class="reference internal" href="#module-urllib2" title="urllib2: Next generation URL opening library."><tt class="xref py py-mod docutils literal"><span class="pre">urllib2</span></tt></a>‘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-1"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2965.html"><strong>RFC 2965</strong></a>. It defaults to <tt class="docutils literal"><span class="pre">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><p>The <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> class opens URLs via <a class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>s chained together. It manages the chaining of handlers, and recovery from errors.</p> </dd></dl> <dl class="class"> <dt id="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><p>This is the base class for all registered handlers — and handles only the simple mechanics of registration.</p> </dd></dl> <dl class="class"> <dt id="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><p>A class which defines a default handler for HTTP error responses; all responses are turned into <a class="reference internal" href="#urllib2.HTTPError" title="urllib2.HTTPError"><tt class="xref py py-exc docutils literal"><span class="pre">HTTPError</span></tt></a> exceptions.</p> </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><p>A class to handle redirections.</p> </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><p>A class to handle HTTP Cookies.</p> </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-2"></span><tt class="xref std std-envvar docutils literal"><span class="pre"><protocol>_proxy</span></tt>. If no proxy environment variables are set, then 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><p>Keep a database of <tt class="docutils literal"><span class="pre">(realm,</span> <span class="pre">uri)</span> <span class="pre">-></span> <span class="pre">(user,</span> <span class="pre">password)</span></tt> mappings.</p> </dd></dl> <dl class="class"> <dt id="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><p>Keep a database of <tt class="docutils literal"><span class="pre">(realm,</span> <span class="pre">uri)</span> <span class="pre">-></span> <span class="pre">(user,</span> <span class="pre">password)</span></tt> mappings. A realm of <tt class="docutils literal"><span class="pre">None</span></tt> is considered a catch-all realm, which is searched if no other realm fits.</p> </dd></dl> <dl class="class"> <dt id="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><p>This is a mixin class that helps with HTTP authentication, both to the remote host and to a proxy. <em>password_mgr</em>, if given, should be something that is compatible with <a class="reference internal" href="#urllib2.HTTPPasswordMgr" title="urllib2.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section <a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be supported.</p> </dd></dl> <dl class="class"> <dt id="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><p>Handle authentication with the remote host. <em>password_mgr</em>, if given, should be something that is compatible with <a class="reference internal" href="#urllib2.HTTPPasswordMgr" title="urllib2.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section <a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be supported.</p> </dd></dl> <dl class="class"> <dt id="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><p>Handle authentication with the proxy. <em>password_mgr</em>, if given, should be something that is compatible with <a class="reference internal" href="#urllib2.HTTPPasswordMgr" title="urllib2.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section <a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be supported.</p> </dd></dl> <dl class="class"> <dt id="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><p>This is a mixin class that helps with HTTP authentication, both to the remote host and to a proxy. <em>password_mgr</em>, if given, should be something that is compatible with <a class="reference internal" href="#urllib2.HTTPPasswordMgr" title="urllib2.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section <a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be supported.</p> </dd></dl> <dl class="class"> <dt id="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><p>Handle authentication with the remote host. <em>password_mgr</em>, if given, should be something that is compatible with <a class="reference internal" href="#urllib2.HTTPPasswordMgr" title="urllib2.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section <a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be supported.</p> </dd></dl> <dl class="class"> <dt id="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><p>Handle authentication with the proxy. <em>password_mgr</em>, if given, should be something that is compatible with <a class="reference internal" href="#urllib2.HTTPPasswordMgr" title="urllib2.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a>; refer to section <a class="reference internal" href="#http-password-mgr"><em>HTTPPasswordMgr Objects</em></a> for information on the interface that must be supported.</p> </dd></dl> <dl class="class"> <dt id="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><p>A class to handle opening of HTTP URLs.</p> </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><p>A class to handle opening of HTTPS URLs.</p> </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><p>Open local files.</p> </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><p>Open FTP URLs.</p> </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><p>Open FTP URLs, keeping a cache of open FTP connections to minimize delays.</p> </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><p>A catch-all class to handle unknown URLs.</p> </dd></dl> <dl class="class"> <dt id="urllib2.HTTPErrorProcessor"> <em class="property">class </em><tt class="descclassname">urllib2.</tt><tt class="descname">HTTPErrorProcessor</tt><a class="headerlink" href="#urllib2.HTTPErrorProcessor" title="Permalink to this definition">¶</a></dt> <dd><p>Process HTTP error responses.</p> </dd></dl> <div class="section" id="request-objects"> <span id="id1"></span><h2>20.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 class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class 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><p>Set the <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> data to <em>data</em>. This is ignored by all handlers except HTTP handlers — and there it should be a byte string, and will change the request to be <tt class="docutils literal"><span class="pre">POST</span></tt> rather than <tt class="docutils literal"><span class="pre">GET</span></tt>.</p> </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><p>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>.</p> </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><p>Return whether the instance has a non-<tt class="docutils literal"><span class="pre">None</span></tt> data.</p> </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><p>Return the instance’s data.</p> </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><p>Add another header to the request. Headers are currently ignored by all handlers except HTTP handlers, where they are added to the list of headers sent to the server. Note that there cannot be more than one header with the same name, and later calls will overwrite previous calls in case the <em>key</em> collides. Currently, this is no loss of HTTP functionality, since all headers which have meaning when used more than once have a (header-specific) way of gaining the same functionality using only one header.</p> </dd></dl> <dl class="method"> <dt id="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><p>Return the URL given in the constructor.</p> </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><p>Return the type of the URL — also known as the scheme.</p> </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><p>Return the host to which a connection will be made.</p> </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><p>Return the selector — the part of the URL that is sent to the server.</p> </dd></dl> <dl class="method"> <dt id="urllib2.Request.get_header"> <tt class="descclassname">Request.</tt><tt class="descname">get_header</tt><big>(</big><em>header_name</em>, <em>default=None</em><big>)</big><a class="headerlink" href="#urllib2.Request.get_header" title="Permalink to this definition">¶</a></dt> <dd><p>Return the value of the given header. If the header is not present, return the default value.</p> </dd></dl> <dl class="method"> <dt id="urllib2.Request.header_items"> <tt class="descclassname">Request.</tt><tt class="descname">header_items</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.Request.header_items" title="Permalink to this definition">¶</a></dt> <dd><p>Return a list of tuples (header_name, header_value) of the Request headers.</p> </dd></dl> <dl class="method"> <dt 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><p>Prepare the request by connecting to a proxy server. The <em>host</em> and <em>type</em> will replace those of the instance, and the instance’s selector will be the original URL given in the constructor.</p> </dd></dl> <dl class="method"> <dt id="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><p>Return the request-host of the origin transaction, as defined by <span class="target" id="index-3"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2965.html"><strong>RFC 2965</strong></a>. See the documentation for the <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> constructor.</p> </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><p>Return whether the request is unverifiable, as defined by RFC 2965. See the documentation for the <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> constructor.</p> </dd></dl> </div> <div class="section" id="openerdirector-objects"> <span id="opener-director-objects"></span><h2>20.6.2. OpenerDirector Objects<a class="headerlink" href="#openerdirector-objects" title="Permalink to this headline">¶</a></h2> <p><a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> instances have the following methods:</p> <dl class="method"> <dt id="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 class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>. The following methods are searched, and added to the possible chains (note that HTTP errors are a special case).</p> <ul class="simple"> <li><tt class="samp 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="samp 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="samp 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="samp 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="samp 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[, data][, timeout]</em><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 class="reference internal" href="#urllib2.urlopen" title="urllib2.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a> (which simply calls the <a class="reference internal" href="functions.html#open" title="open"><tt class="xref py py-meth docutils literal"><span class="pre">open()</span></tt></a> method on the currently installed global <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>). The optional <em>timeout</em> parameter specifies a timeout in seconds for blocking operations like the connection attempt (if not specified, the global default timeout setting will be used). The timeout feature actually works only for HTTP, HTTPS and FTP connections).</p> <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 py py-meth docutils literal"><span class="pre">http_error_*()</span></tt> methods of the handler classes.</p> <p>Return values and exceptions raised are the same as those of <a class="reference internal" href="#urllib2.urlopen" title="urllib2.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>.</p> </dd></dl> <p>OpenerDirector objects open URLs in three stages:</p> <p>The order in which these methods are called within each stage is determined by sorting the handler instances.</p> <ol class="arabic"> <li><p class="first">Every handler with a method named like <tt class="samp 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="samp 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 class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a> value (ie. a response), or raises an exception (usually <a class="reference internal" href="#urllib2.URLError" title="urllib2.URLError"><tt class="xref py py-exc 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 py py-meth docutils literal"><span class="pre">default_open()</span></tt>. If all such methods return <a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a>, the algorithm is repeated for methods named like <tt class="samp docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_open</span></tt>. If all such methods return <a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a>, the algorithm is repeated for methods named <tt class="xref py py-meth docutils literal"><span class="pre">unknown_open()</span></tt>.</p> <p>Note that the implementation of these methods may involve calls of the parent <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> instance’s <a class="reference internal" href="#urllib2.OpenerDirector.open" title="urllib2.OpenerDirector.open"><tt class="xref py py-meth docutils literal"><span class="pre">open()</span></tt></a> and <a class="reference internal" href="#urllib2.OpenerDirector.error" title="urllib2.OpenerDirector.error"><tt class="xref py py-meth docutils literal"><span class="pre">error()</span></tt></a> methods.</p> </li> <li><p class="first">Every handler with a method named like <tt class="samp 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>20.6.3. BaseHandler Objects<a class="headerlink" href="#basehandler-objects" title="Permalink to this headline">¶</a></h2> <p><a class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a> objects provide a couple of methods that are directly useful, and others that are meant to be used by derived classes. These are intended for direct use:</p> <dl class="method"> <dt id="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><p>Add a director as parent.</p> </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><p>Remove any parents.</p> </dd></dl> <p>The following attributes and methods should only be used by classes derived from <a class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">The convention has been adopted that subclasses defining <tt class="xref py py-meth docutils literal"><span class="pre">protocol_request()</span></tt> or <tt class="xref py py-meth docutils literal"><span class="pre">protocol_response()</span></tt> methods are named <tt class="xref py py-class docutils literal"><span class="pre">*Processor</span></tt>; all others are named <tt class="xref py py-class docutils literal"><span class="pre">*Handler</span></tt>.</p> </div> <dl class="attribute"> <dt id="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><p>A valid <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>, which can be used to open using a different protocol, or handle errors.</p> </dd></dl> <dl class="method"> <dt id="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 class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should define it if they want to catch all URLs.</p> <p>This method, if implemented, will be called by the parent <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>. It should return a file-like object as described in the return value of the <a class="reference internal" href="functions.html#open" title="open"><tt class="xref py py-meth docutils literal"><span class="pre">open()</span></tt></a> of <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>, or <tt class="docutils literal"><span class="pre">None</span></tt>. It should raise <a class="reference internal" href="#urllib2.URLError" title="urllib2.URLError"><tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt></a>, unless a truly exceptional thing happens (for example, <a class="reference internal" href="exceptions.html#exceptions.MemoryError" title="exceptions.MemoryError"><tt class="xref py py-exc docutils literal"><span class="pre">MemoryError</span></tt></a> should not be mapped to <a class="reference internal" href="#urllib2.URLError" title="urllib2.URLError"><tt class="xref py py-exc 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 class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should define it if they want to handle URLs with the given <em>protocol</em>.</p> <p>This method, if defined, will be called by the parent <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>. Return values should be the same as for <tt class="xref py py-meth docutils literal"><span class="pre">default_open()</span></tt>.</p> </dd></dl> <dl class="method"> <dt id="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 class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should define it if they want to catch all URLs with no specific registered handler to open it.</p> <p>This method, if implemented, will be called by the <a class="reference internal" href="#urllib2.BaseHandler.parent" title="urllib2.BaseHandler.parent"><tt class="xref py py-attr docutils literal"><span class="pre">parent</span></tt></a> <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>. Return values should be the same as for <a class="reference internal" href="#urllib2.BaseHandler.default_open" title="urllib2.BaseHandler.default_open"><tt class="xref py py-meth docutils literal"><span class="pre">default_open()</span></tt></a>.</p> </dd></dl> <dl class="method"> <dt id="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 class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should override it if they intend to provide a catch-all for otherwise unhandled HTTP errors. It will be called automatically by the <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> getting the error, and should not normally be called in other circumstances.</p> <p><em>req</em> will be a <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object, <em>fp</em> will be a file-like object with the HTTP error body, <em>code</em> will be the three-digit code of the error, <em>msg</em> will be the user-visible explanation of the code and <em>hdrs</em> will be a mapping object with the headers of the error.</p> <p>Return values and exceptions raised should be the same as those of <a class="reference internal" href="#urllib2.urlopen" title="urllib2.urlopen"><tt class="xref py py-func 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 class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but will be called, if it exists, on an instance of a subclass, when an HTTP error with code <em>nnn</em> occurs.</p> <p>Subclasses should override this method to handle specific HTTP errors.</p> <p>Arguments, return values and exceptions raised should be the same as for <a class="reference internal" href="#urllib2.BaseHandler.http_error_default" title="urllib2.BaseHandler.http_error_default"><tt class="xref py py-meth docutils literal"><span class="pre">http_error_default()</span></tt></a>.</p> </dd></dl> <dl class="method"> <dt> <tt class="descclassname">BaseHandler.</tt><tt class="descname">protocol_request</tt><big>(</big><em>req</em><big>)</big></dt> <dd><p>(“protocol” is to be replaced by the protocol name.)</p> <p>This method is <em>not</em> defined in <a class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should define it if they want to pre-process requests of the given <em>protocol</em>.</p> <p>This method, if defined, will be called by the parent <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>. <em>req</em> will be a <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object. The return value should be a <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object.</p> </dd></dl> <dl class="method"> <dt> <tt class="descclassname">BaseHandler.</tt><tt class="descname">protocol_response</tt><big>(</big><em>req</em>, <em>response</em><big>)</big></dt> <dd><p>(“protocol” is to be replaced by the protocol name.)</p> <p>This method is <em>not</em> defined in <a class="reference internal" href="#urllib2.BaseHandler" title="urllib2.BaseHandler"><tt class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></tt></a>, but subclasses should define it if they want to post-process responses of the given <em>protocol</em>.</p> <p>This method, if defined, will be called by the parent <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a>. <em>req</em> will be a <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object. <em>response</em> will be an object implementing the same interface as the return value of <a class="reference internal" href="#urllib2.urlopen" title="urllib2.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>. The return value should implement the same interface as the return value of <a class="reference internal" href="#urllib2.urlopen" title="urllib2.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a>.</p> </dd></dl> </div> <div class="section" id="httpredirecthandler-objects"> <span id="http-redirect-handler"></span><h2>20.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 class="reference internal" href="#urllib2.HTTPError" title="urllib2.HTTPError"><tt class="xref py py-exc docutils literal"><span class="pre">HTTPError</span></tt></a> is raised. See <span class="target" id="index-4"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2616.html"><strong>RFC 2616</strong></a> 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 class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt> in response to a redirect. This is called by the default implementations of the <tt class="xref py py-meth docutils literal"><span class="pre">http_error_30*()</span></tt> methods when a redirection is received from the server. If a redirection should take place, return a new <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> to allow <tt class="xref py py-meth docutils literal"><span class="pre">http_error_30*()</span></tt> to perform the redirect to <em>newurl</em>. Otherwise, raise <a class="reference internal" href="#urllib2.HTTPError" title="urllib2.HTTPError"><tt class="xref py py-exc docutils literal"><span class="pre">HTTPError</span></tt></a> if no other handler should try to handle this URL, or return <tt class="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-5"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2616.html"><strong>RFC 2616</strong></a>, which says that 301 and 302 responses to <tt class="docutils literal"><span class="pre">POST</span></tt> requests must not be automatically redirected without confirmation by the user. In reality, browsers do allow automatic redirection of these responses, changing the POST to a <tt class="docutils literal"><span class="pre">GET</span></tt>, and the default implementation reproduces this behavior.</p> </div> </dd></dl> <dl class="method"> <dt id="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><p>Redirect to the <tt class="docutils literal"><span class="pre">Location:</span></tt> or <tt class="docutils literal"><span class="pre">URI:</span></tt> URL. This method is called by the parent <a class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> when getting an HTTP ‘moved permanently’ response.</p> </dd></dl> <dl class="method"> <dt id="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><p>The same as <a class="reference internal" href="#urllib2.HTTPRedirectHandler.http_error_301" title="urllib2.HTTPRedirectHandler.http_error_301"><tt class="xref py py-meth docutils literal"><span class="pre">http_error_301()</span></tt></a>, but called for the ‘found’ response.</p> </dd></dl> <dl class="method"> <dt id="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><p>The same as <a class="reference internal" href="#urllib2.HTTPRedirectHandler.http_error_301" title="urllib2.HTTPRedirectHandler.http_error_301"><tt class="xref py py-meth docutils literal"><span class="pre">http_error_301()</span></tt></a>, but called for the ‘see other’ response.</p> </dd></dl> <dl class="method"> <dt id="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><p>The same as <a class="reference internal" href="#urllib2.HTTPRedirectHandler.http_error_301" title="urllib2.HTTPRedirectHandler.http_error_301"><tt class="xref py py-meth docutils literal"><span class="pre">http_error_301()</span></tt></a>, but called for the ‘temporary redirect’ response.</p> </dd></dl> </div> <div class="section" id="httpcookieprocessor-objects"> <span id="http-cookie-processor"></span><h2>20.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 class="reference internal" href="#urllib2.HTTPCookieProcessor" title="urllib2.HTTPCookieProcessor"><tt class="xref py py-class docutils literal"><span class="pre">HTTPCookieProcessor</span></tt></a> instances have one attribute:</p> <dl class="attribute"> <dt id="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><p>The <a class="reference internal" href="cookielib.html#cookielib.CookieJar" title="cookielib.CookieJar"><tt class="xref py py-class docutils literal"><span class="pre">cookielib.CookieJar</span></tt></a> in which cookies are stored.</p> </dd></dl> </div> <div class="section" id="proxyhandler-objects"> <span id="proxy-handler"></span><h2>20.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 class="reference internal" href="#urllib2.ProxyHandler" title="urllib2.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> will have a method <tt class="samp 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>20.6.7. HTTPPasswordMgr Objects<a class="headerlink" href="#httppasswordmgr-objects" title="Permalink to this headline">¶</a></h2> <p>These methods are available on <a class="reference internal" href="#urllib2.HTTPPasswordMgr" title="urllib2.HTTPPasswordMgr"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgr</span></tt></a> and <a class="reference internal" href="#urllib2.HTTPPasswordMgrWithDefaultRealm" title="urllib2.HTTPPasswordMgrWithDefaultRealm"><tt class="xref py py-class 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><p><em>uri</em> can be either a single URI, or a sequence of URIs. <em>realm</em>, <em>user</em> and <em>passwd</em> must be strings. This causes <tt class="docutils literal"><span class="pre">(user,</span> <span class="pre">passwd)</span></tt> to be used as authentication tokens when authentication for <em>realm</em> and a super-URI of any of the given URIs is given.</p> </dd></dl> <dl class="method"> <dt id="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 class="reference internal" href="#urllib2.HTTPPasswordMgrWithDefaultRealm" title="urllib2.HTTPPasswordMgrWithDefaultRealm"><tt class="xref py py-class docutils literal"><span class="pre">HTTPPasswordMgrWithDefaultRealm</span></tt></a> objects, the realm <tt class="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>20.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 class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object, and <em>headers</em> should be the error headers.</p> <p><em>host</em> is either an authority (e.g. <tt class="docutils literal"><span class="pre">"python.org"</span></tt>) or a URL containing an authority component (e.g. <tt class="docutils literal"><span class="pre">"http://python.org/"</span></tt>). In either case, the authority must not contain a userinfo component (so, <tt class="docutils literal"><span class="pre">"python.org"</span></tt> and <tt class="docutils literal"><span class="pre">"python.org:80"</span></tt> are fine, <tt class="docutils literal"><span class="pre">"joe:password@python.org"</span></tt> is not).</p> </dd></dl> </div> <div class="section" id="httpbasicauthhandler-objects"> <span id="http-basic-auth-handler"></span><h2>20.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><p>Retry the request with authentication information, if available.</p> </dd></dl> </div> <div class="section" id="proxybasicauthhandler-objects"> <span id="proxy-basic-auth-handler"></span><h2>20.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><p>Retry the request with authentication information, if available.</p> </dd></dl> </div> <div class="section" id="abstractdigestauthhandler-objects"> <span id="abstract-digest-auth-handler"></span><h2>20.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><p><em>authreq</em> should be the name of the header where the information about the realm is included in the request, <em>host</em> should be the host to authenticate to, <em>req</em> should be the (failed) <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> object, and <em>headers</em> should be the error headers.</p> </dd></dl> </div> <div class="section" id="httpdigestauthhandler-objects"> <span id="http-digest-auth-handler"></span><h2>20.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><p>Retry the request with authentication information, if available.</p> </dd></dl> </div> <div class="section" id="proxydigestauthhandler-objects"> <span id="proxy-digest-auth-handler"></span><h2>20.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><p>Retry the request with authentication information, if available.</p> </dd></dl> </div> <div class="section" id="httphandler-objects"> <span id="http-handler-objects"></span><h2>20.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><p>Send an HTTP request, which can be either GET or POST, depending on <tt class="docutils literal"><span class="pre">req.has_data()</span></tt>.</p> </dd></dl> </div> <div class="section" id="httpshandler-objects"> <span id="https-handler-objects"></span><h2>20.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><p>Send an HTTPS request, which can be either GET or POST, depending on <tt class="docutils literal"><span class="pre">req.has_data()</span></tt>.</p> </dd></dl> </div> <div class="section" id="filehandler-objects"> <span id="file-handler-objects"></span><h2>20.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><p>Open the file locally, if there is no host name, or the host name is <tt class="docutils literal"><span class="pre">'localhost'</span></tt>. Change the protocol to <tt class="docutils literal"><span class="pre">ftp</span></tt> otherwise, and retry opening it using <tt class="xref py py-attr docutils literal"><span class="pre">parent</span></tt>.</p> </dd></dl> </div> <div class="section" id="ftphandler-objects"> <span id="ftp-handler-objects"></span><h2>20.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><p>Open the FTP file indicated by <em>req</em>. The login is always done with empty username and password.</p> </dd></dl> </div> <div class="section" id="cacheftphandler-objects"> <span id="cacheftp-handler-objects"></span><h2>20.6.18. CacheFTPHandler Objects<a class="headerlink" href="#cacheftphandler-objects" title="Permalink to this headline">¶</a></h2> <p><a class="reference internal" href="#urllib2.CacheFTPHandler" title="urllib2.CacheFTPHandler"><tt class="xref py py-class docutils literal"><span class="pre">CacheFTPHandler</span></tt></a> objects are <a class="reference internal" href="#urllib2.FTPHandler" title="urllib2.FTPHandler"><tt class="xref py py-class docutils literal"><span class="pre">FTPHandler</span></tt></a> objects with the following additional methods:</p> <dl class="method"> <dt id="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><p>Set timeout of connections to <em>t</em> seconds.</p> </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><p>Set maximum number of cached connections to <em>m</em>.</p> </dd></dl> </div> <div class="section" id="unknownhandler-objects"> <span id="unknown-handler-objects"></span><h2>20.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><p>Raise a <a class="reference internal" href="#urllib2.URLError" title="urllib2.URLError"><tt class="xref py py-exc docutils literal"><span class="pre">URLError</span></tt></a> exception.</p> </dd></dl> </div> <div class="section" id="httperrorprocessor-objects"> <span id="http-error-processor-objects"></span><h2>20.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.http_response"> <tt class="descclassname">HTTPErrorProcessor.</tt><tt class="descname">http_response</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.HTTPErrorProcessor.http_response" title="Permalink to this definition">¶</a></dt> <dd><p>Process HTTP error responses.</p> <p>For 200 error codes, the response object is returned immediately.</p> <p>For non-200 error codes, this simply passes the job on to the <tt class="samp docutils literal"><em><span class="pre">protocol</span></em><span class="pre">_error_code</span></tt> handler methods, via <a class="reference internal" href="#urllib2.OpenerDirector.error" title="urllib2.OpenerDirector.error"><tt class="xref py py-meth docutils literal"><span class="pre">OpenerDirector.error()</span></tt></a>. Eventually, <a class="reference internal" href="#urllib2.HTTPDefaultErrorHandler" title="urllib2.HTTPDefaultErrorHandler"><tt class="xref py py-class docutils literal"><span class="pre">urllib2.HTTPDefaultErrorHandler</span></tt></a> will raise an <a class="reference internal" href="#urllib2.HTTPError" title="urllib2.HTTPError"><tt class="xref py py-exc docutils literal"><span class="pre">HTTPError</span></tt></a> if no other handler handles the error.</p> </dd></dl> <dl class="method"> <dt id="urllib2.HTTPErrorProcessor.https_response"> <tt class="descclassname">HTTPErrorProcessor.</tt><tt class="descname">https_response</tt><big>(</big><big>)</big><a class="headerlink" href="#urllib2.HTTPErrorProcessor.https_response" title="Permalink to this definition">¶</a></dt> <dd><p>Process HTTPS error responses.</p> <p>The behavior is same as <a class="reference internal" href="#urllib2.HTTPErrorProcessor.http_response" title="urllib2.HTTPErrorProcessor.http_response"><tt class="xref py py-meth docutils literal"><span class="pre">http_response()</span></tt></a>.</p> </dd></dl> </div> <div class="section" id="examples"> <span id="urllib2-examples"></span><h2>20.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 class="reference internal" href="#urllib2.build_opener" title="urllib2.build_opener"><tt class="xref py py-func docutils literal"><span class="pre">build_opener()</span></tt></a> provides many handlers by default, including a <a class="reference internal" href="#urllib2.ProxyHandler" title="urllib2.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a>. By default, <a class="reference internal" href="#urllib2.ProxyHandler" title="urllib2.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> uses the environment variables named <tt class="docutils literal"><span class="pre"><scheme>_proxy</span></tt>, where <tt class="docutils literal"><span class="pre"><scheme></span></tt> is the URL scheme involved. For example, the <span class="target" id="index-6"></span><tt class="xref std std-envvar docutils literal"><span class="pre">http_proxy</span></tt> environment variable is read to obtain the HTTP proxy’s URL.</p> <p>This example replaces the default <a class="reference internal" href="#urllib2.ProxyHandler" title="urllib2.ProxyHandler"><tt class="xref py py-class docutils literal"><span class="pre">ProxyHandler</span></tt></a> with one that uses programmatically-supplied proxy URLs, and adds proxy authorization support with <a class="reference internal" href="#urllib2.ProxyBasicAuthHandler" title="urllib2.ProxyBasicAuthHandler"><tt class="xref py py-class 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 class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class 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 class="reference internal" href="#urllib2.OpenerDirector" title="urllib2.OpenerDirector"><tt class="xref py py-class docutils literal"><span class="pre">OpenerDirector</span></tt></a> automatically adds a <em class="mailheader">User-Agent</em> header to every <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class 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 class="mailheader">Content-Length</em>, <em class="mailheader">Content-Type</em> and <em class="mailheader">Host</em>) are added when the <a class="reference internal" href="#urllib2.Request" title="urllib2.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> is passed to <a class="reference internal" href="#urllib2.urlopen" title="urllib2.urlopen"><tt class="xref py py-func docutils literal"><span class="pre">urlopen()</span></tt></a> (or <a class="reference internal" href="#urllib2.OpenerDirector.open" title="urllib2.OpenerDirector.open"><tt class="xref py py-meth 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 internal" href="#">20.6. <tt class="docutils literal"><span class="pre">urllib2</span></tt> — extensible library for opening URLs</a><ul> <li><a class="reference internal" href="#request-objects">20.6.1. Request Objects</a></li> <li><a class="reference internal" href="#openerdirector-objects">20.6.2. OpenerDirector Objects</a></li> <li><a class="reference internal" href="#basehandler-objects">20.6.3. BaseHandler Objects</a></li> <li><a class="reference internal" href="#httpredirecthandler-objects">20.6.4. HTTPRedirectHandler Objects</a></li> <li><a class="reference internal" href="#httpcookieprocessor-objects">20.6.5. HTTPCookieProcessor Objects</a></li> <li><a class="reference internal" href="#proxyhandler-objects">20.6.6. ProxyHandler Objects</a></li> <li><a class="reference internal" href="#httppasswordmgr-objects">20.6.7. HTTPPasswordMgr Objects</a></li> <li><a class="reference internal" href="#abstractbasicauthhandler-objects">20.6.8. AbstractBasicAuthHandler Objects</a></li> <li><a class="reference internal" href="#httpbasicauthhandler-objects">20.6.9. HTTPBasicAuthHandler Objects</a></li> <li><a class="reference internal" href="#proxybasicauthhandler-objects">20.6.10. ProxyBasicAuthHandler Objects</a></li> <li><a class="reference internal" href="#abstractdigestauthhandler-objects">20.6.11. AbstractDigestAuthHandler Objects</a></li> <li><a class="reference internal" href="#httpdigestauthhandler-objects">20.6.12. HTTPDigestAuthHandler Objects</a></li> <li><a class="reference internal" href="#proxydigestauthhandler-objects">20.6.13. ProxyDigestAuthHandler Objects</a></li> <li><a class="reference internal" href="#httphandler-objects">20.6.14. HTTPHandler Objects</a></li> <li><a class="reference internal" href="#httpshandler-objects">20.6.15. HTTPSHandler Objects</a></li> <li><a class="reference internal" href="#filehandler-objects">20.6.16. FileHandler Objects</a></li> <li><a class="reference internal" href="#ftphandler-objects">20.6.17. FTPHandler Objects</a></li> <li><a class="reference internal" href="#cacheftphandler-objects">20.6.18. CacheFTPHandler Objects</a></li> <li><a class="reference internal" href="#unknownhandler-objects">20.6.19. UnknownHandler Objects</a></li> <li><a class="reference internal" href="#httperrorprocessor-objects">20.6.20. HTTPErrorProcessor Objects</a></li> <li><a class="reference internal" href="#examples">20.6.21. Examples</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="urllib.html" title="previous chapter">20.5. <tt class="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">20.7. <tt class="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="../bugs.html">Report a Bug</a></li> <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" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="httplib.html" title="20.7. httplib — HTTP protocol client" >next</a> |</li> <li class="right" > <a href="urllib.html" title="20.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="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="internet.html" >20. Internet Protocols and Support</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2019, 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 Jul 03, 2019. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>
Close
