Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
2to3.html	70.96 KB	-rw-r--r--
__future__.html	20.75 KB	-rw-r--r--
__main__.html	44.87 KB	-rw-r--r--
_thread.html	30.39 KB	-rw-r--r--
abc.html	46.87 KB	-rw-r--r--
aifc.html	35.56 KB	-rw-r--r--
allos.html	34.33 KB	-rw-r--r--
archiving.html	17 KB	-rw-r--r--
argparse.html	300.89 KB	-rw-r--r--
array.html	37.28 KB	-rw-r--r--
ast.html	293.08 KB	-rw-r--r--
asynchat.html	37.41 KB	-rw-r--r--
asyncio-api-index.html	27.68 KB	-rw-r--r--
asyncio-dev.html	36.1 KB	-rw-r--r--
asyncio-eventloop.html	204.43 KB	-rw-r--r--
asyncio-exceptions.html	17.11 KB	-rw-r--r--
asyncio-future.html	38.23 KB	-rw-r--r--
asyncio-llapi-index.html	61.97 KB	-rw-r--r--
asyncio-platforms.html	21.77 KB	-rw-r--r--
asyncio-policy.html	39.56 KB	-rw-r--r--
asyncio-protocol.html	118.33 KB	-rw-r--r--
asyncio-queue.html	31.86 KB	-rw-r--r--
asyncio-stream.html	69.98 KB	-rw-r--r--
asyncio-subprocess.html	49.25 KB	-rw-r--r--
asyncio-sync.html	42.79 KB	-rw-r--r--
asyncio-task.html	109.14 KB	-rw-r--r--
asyncio.html	17.31 KB	-rw-r--r--
asyncore.html	49.36 KB	-rw-r--r--
atexit.html	22.87 KB	-rw-r--r--
audioop.html	46 KB	-rw-r--r--
audit_events.html	72.85 KB	-rw-r--r--
base64.html	48.09 KB	-rw-r--r--
bdb.html	66 KB	-rw-r--r--
binary.html	15.97 KB	-rw-r--r--
binascii.html	36.3 KB	-rw-r--r--
binhex.html	15.97 KB	-rw-r--r--
bisect.html	43.38 KB	-rw-r--r--
builtins.html	14.87 KB	-rw-r--r--
bz2.html	50.68 KB	-rw-r--r--
calendar.html	69.35 KB	-rw-r--r--
cgi.html	59.95 KB	-rw-r--r--
cgitb.html	19.96 KB	-rw-r--r--
chunk.html	22.21 KB	-rw-r--r--
cmath.html	43.89 KB	-rw-r--r--
cmd.html	50.42 KB	-rw-r--r--
code.html	35.38 KB	-rw-r--r--
codecs.html	157.96 KB	-rw-r--r--
codeop.html	18.26 KB	-rw-r--r--
collections.abc.html	79.17 KB	-rw-r--r--
collections.html	189.43 KB	-rw-r--r--
colorsys.html	17.31 KB	-rw-r--r--
compileall.html	50.68 KB	-rw-r--r--
concurrency.html	24.15 KB	-rw-r--r--
concurrent.futures.html	79.03 KB	-rw-r--r--
concurrent.html	11.56 KB	-rw-r--r--
configparser.html	159.4 KB	-rw-r--r--
constants.html	22.41 KB	-rw-r--r--
contextlib.html	117.2 KB	-rw-r--r--
contextvars.html	38.38 KB	-rw-r--r--
copy.html	17.92 KB	-rw-r--r--
copyreg.html	18.63 KB	-rw-r--r--
crypt.html	28.29 KB	-rw-r--r--
crypto.html	13.93 KB	-rw-r--r--
csv.html	82.89 KB	-rw-r--r--
ctypes.html	295.49 KB	-rw-r--r--
curses.ascii.html	32.04 KB	-rw-r--r--
curses.html	221.24 KB	-rw-r--r--
curses.panel.html	22.16 KB	-rw-r--r--
custominterp.html	11.85 KB	-rw-r--r--
dataclasses.html	113.16 KB	-rw-r--r--
datatypes.html	31.82 KB	-rw-r--r--
datetime.html	374.92 KB	-rw-r--r--
dbm.html	51.16 KB	-rw-r--r--
debug.html	17 KB	-rw-r--r--
decimal.html	270.12 KB	-rw-r--r--
development.html	32.34 KB	-rw-r--r--
devmode.html	31.72 KB	-rw-r--r--
dialog.html	43.03 KB	-rw-r--r--
difflib.html	111.99 KB	-rw-r--r--
dis.html	136.07 KB	-rw-r--r--
distribution.html	13.67 KB	-rw-r--r--
distutils.html	14.73 KB	-rw-r--r--
doctest.html	199.32 KB	-rw-r--r--
email.charset.html	31.92 KB	-rw-r--r--
email.compat32-message.html	97.74 KB	-rw-r--r--
email.contentmanager.html	37.02 KB	-rw-r--r--
email.encoders.html	18.47 KB	-rw-r--r--
email.errors.html	24.45 KB	-rw-r--r--
email.examples.html	60.49 KB	-rw-r--r--
email.generator.html	48.79 KB	-rw-r--r--
email.header.html	37.61 KB	-rw-r--r--
email.headerregistry.html	66.26 KB	-rw-r--r--
email.html	30.75 KB	-rw-r--r--
email.iterators.html	18.23 KB	-rw-r--r--
email.message.html	99.75 KB	-rw-r--r--
email.mime.html	44.89 KB	-rw-r--r--
email.parser.html	57.39 KB	-rw-r--r--
email.policy.html	84.24 KB	-rw-r--r--
email.utils.html	42.57 KB	-rw-r--r--
ensurepip.html	23.9 KB	-rw-r--r--
enum.html	151 KB	-rw-r--r--
errno.html	60.17 KB	-rw-r--r--
exceptions.html	108.44 KB	-rw-r--r--
faulthandler.html	31.5 KB	-rw-r--r--
fcntl.html	36.67 KB	-rw-r--r--
filecmp.html	32.08 KB	-rw-r--r--
fileformats.html	13.52 KB	-rw-r--r--
fileinput.html	40.37 KB	-rw-r--r--
filesys.html	16.78 KB	-rw-r--r--
fnmatch.html	21.02 KB	-rw-r--r--
fractions.html	35.29 KB	-rw-r--r--
frameworks.html	16.15 KB	-rw-r--r--
ftplib.html	71.97 KB	-rw-r--r--
functional.html	12.19 KB	-rw-r--r--
functions.html	260.33 KB	-rw-r--r--
functools.html	92.96 KB	-rw-r--r--
gc.html	40.97 KB	-rw-r--r--
getopt.html	29.4 KB	-rw-r--r--
getpass.html	16.01 KB	-rw-r--r--
gettext.html	98.02 KB	-rw-r--r--
glob.html	27.2 KB	-rw-r--r--
graphlib.html	34.82 KB	-rw-r--r--
grp.html	16.03 KB	-rw-r--r--
gzip.html	45.65 KB	-rw-r--r--
hashlib.html	93.19 KB	-rw-r--r--
heapq.html	42.43 KB	-rw-r--r--
hmac.html	24.74 KB	-rw-r--r--
html.entities.html	14.91 KB	-rw-r--r--
html.html	14.81 KB	-rw-r--r--
html.parser.html	47.7 KB	-rw-r--r--
http.client.html	85.63 KB	-rw-r--r--
http.cookiejar.html	113.94 KB	-rw-r--r--
http.cookies.html	47.64 KB	-rw-r--r--
http.html	45.52 KB	-rw-r--r--
http.server.html	73.05 KB	-rw-r--r--
i18n.html	13.44 KB	-rw-r--r--
idle.html	77.18 KB	-rw-r--r--
imaplib.html	87.08 KB	-rw-r--r--
imghdr.html	17.94 KB	-rw-r--r--
imp.html	54.32 KB	-rw-r--r--
importlib.html	239.96 KB	-rw-r--r--
importlib.metadata.html	43.14 KB	-rw-r--r--
index.html	75.06 KB	-rw-r--r--
inspect.html	168.74 KB	-rw-r--r--
internet.html	29.89 KB	-rw-r--r--
intro.html	13.81 KB	-rw-r--r--
io.html	154.15 KB	-rw-r--r--
ipaddress.html	137.75 KB	-rw-r--r--
ipc.html	12.6 KB	-rw-r--r--
itertools.html	153.27 KB	-rw-r--r--
json.html	98.9 KB	-rw-r--r--
keyword.html	14.88 KB	-rw-r--r--
language.html	16.71 KB	-rw-r--r--
linecache.html	18.09 KB	-rw-r--r--
locale.html	77.35 KB	-rw-r--r--
logging.config.html	100.3 KB	-rw-r--r--
logging.handlers.html	146.28 KB	-rw-r--r--
logging.html	169.67 KB	-rw-r--r--
lzma.html	66.89 KB	-rw-r--r--
mailbox.html	176.34 KB	-rw-r--r--
mailcap.html	20.86 KB	-rw-r--r--
markup.html	22.31 KB	-rw-r--r--
marshal.html	24.43 KB	-rw-r--r--
math.html	85.82 KB	-rw-r--r--
mimetypes.html	40.27 KB	-rw-r--r--
mm.html	11.16 KB	-rw-r--r--
mmap.html	55.53 KB	-rw-r--r--
modulefinder.html	23.67 KB	-rw-r--r--
modules.html	15.88 KB	-rw-r--r--
msilib.html	78.38 KB	-rw-r--r--
msvcrt.html	29.22 KB	-rw-r--r--
multiprocessing.html	405.24 KB	-rw-r--r--
multiprocessing.shared_memory....	60 KB	-rw-r--r--
netdata.html	20.24 KB	-rw-r--r--
netrc.html	20.39 KB	-rw-r--r--
nis.html	16.76 KB	-rw-r--r--
nntplib.html	84.93 KB	-rw-r--r--
numbers.html	45.67 KB	-rw-r--r--
numeric.html	19.29 KB	-rw-r--r--
operator.html	107.32 KB	-rw-r--r--
optparse.html	256.96 KB	-rw-r--r--
os.html	594.39 KB	-rw-r--r--
os.path.html	65.54 KB	-rw-r--r--
ossaudiodev.html	56.35 KB	-rw-r--r--
pathlib.html	170.01 KB	-rw-r--r--
pdb.html	68.67 KB	-rw-r--r--
persistence.html	19.13 KB	-rw-r--r--
pickle.html	154.45 KB	-rw-r--r--
pickletools.html	22.92 KB	-rw-r--r--
pipes.html	21.7 KB	-rw-r--r--
pkgutil.html	42.76 KB	-rw-r--r--
platform.html	45.08 KB	-rw-r--r--
plistlib.html	30.06 KB	-rw-r--r--
poplib.html	41.42 KB	-rw-r--r--
posix.html	20.96 KB	-rw-r--r--
pprint.html	55.35 KB	-rw-r--r--
profile.html	84.63 KB	-rw-r--r--
pty.html	23.7 KB	-rw-r--r--
pwd.html	16.84 KB	-rw-r--r--
py_compile.html	29 KB	-rw-r--r--
pyclbr.html	24.06 KB	-rw-r--r--
pydoc.html	19.59 KB	-rw-r--r--
pyexpat.html	104.38 KB	-rw-r--r--
python.html	22.46 KB	-rw-r--r--
queue.html	43.39 KB	-rw-r--r--
quopri.html	18.64 KB	-rw-r--r--
random.html	86.31 KB	-rw-r--r--
re.html	214.24 KB	-rw-r--r--
readline.html	50.19 KB	-rw-r--r--
reprlib.html	30.85 KB	-rw-r--r--
resource.html	48.26 KB	-rw-r--r--
rlcompleter.html	18.06 KB	-rw-r--r--
runpy.html	30.99 KB	-rw-r--r--
sched.html	27.04 KB	-rw-r--r--
secrets.html	30.2 KB	-rw-r--r--
security_warnings.html	16.21 KB	-rw-r--r--
select.html	74.58 KB	-rw-r--r--
selectors.html	41.91 KB	-rw-r--r--
shelve.html	36.54 KB	-rw-r--r--
shlex.html	61.03 KB	-rw-r--r--
shutil.html	100.13 KB	-rw-r--r--
signal.html	95.39 KB	-rw-r--r--
site.html	38.16 KB	-rw-r--r--
smtpd.html	44.09 KB	-rw-r--r--
smtplib.html	81.4 KB	-rw-r--r--
sndhdr.html	16.4 KB	-rw-r--r--
socket.html	256.95 KB	-rw-r--r--
socketserver.html	91.95 KB	-rw-r--r--
spwd.html	16.71 KB	-rw-r--r--
sqlite3.html	225.51 KB	-rw-r--r--
ssl.html	328.83 KB	-rw-r--r--
stat.html	57.79 KB	-rw-r--r--
statistics.html	123.22 KB	-rw-r--r--
stdtypes.html	615.43 KB	-rw-r--r--
string.html	108.03 KB	-rw-r--r--
stringprep.html	24.94 KB	-rw-r--r--
struct.html	70.58 KB	-rw-r--r--
subprocess.html	199.03 KB	-rw-r--r--
sunau.html	39.84 KB	-rw-r--r--
superseded.html	26.21 KB	-rw-r--r--
symtable.html	33.26 KB	-rw-r--r--
sys.html	198.83 KB	-rw-r--r--
sysconfig.html	39.81 KB	-rw-r--r--
syslog.html	27.36 KB	-rw-r--r--
tabnanny.html	16.18 KB	-rw-r--r--
tarfile.html	161.92 KB	-rw-r--r--
telnetlib.html	38.21 KB	-rw-r--r--
tempfile.html	58.39 KB	-rw-r--r--
termios.html	22.86 KB	-rw-r--r--
test.html	222.85 KB	-rw-r--r--
text.html	16.8 KB	-rw-r--r--
textwrap.html	48.83 KB	-rw-r--r--
threading.html	128.33 KB	-rw-r--r--
time.html	107.46 KB	-rw-r--r--
timeit.html	52.63 KB	-rw-r--r--
tk.html	28.08 KB	-rw-r--r--
tkinter.colorchooser.html	14.49 KB	-rw-r--r--
tkinter.dnd.html	17.09 KB	-rw-r--r--
tkinter.font.html	22.21 KB	-rw-r--r--
tkinter.html	106.85 KB	-rw-r--r--
tkinter.messagebox.html	20.09 KB	-rw-r--r--
tkinter.scrolledtext.html	14.52 KB	-rw-r--r--
tkinter.tix.html	59.69 KB	-rw-r--r--
tkinter.ttk.html	138.37 KB	-rw-r--r--
token.html	45.73 KB	-rw-r--r--
tokenize.html	39.86 KB	-rw-r--r--
trace.html	38.85 KB	-rw-r--r--
traceback.html	75.61 KB	-rw-r--r--
tracemalloc.html	122.33 KB	-rw-r--r--
tty.html	14.46 KB	-rw-r--r--
turtle.html	271.71 KB	-rw-r--r--
types.html	64.85 KB	-rw-r--r--
typing.html	315.69 KB	-rw-r--r--
unicodedata.html	27.3 KB	-rw-r--r--
unittest.html	310.01 KB	-rw-r--r--
unittest.mock-examples.html	177.75 KB	-rw-r--r--
unittest.mock.html	363.51 KB	-rw-r--r--
unix.html	13.46 KB	-rw-r--r--
urllib.error.html	18.56 KB	-rw-r--r--
urllib.html	12.92 KB	-rw-r--r--
urllib.parse.html	104.65 KB	-rw-r--r--
urllib.request.html	208.87 KB	-rw-r--r--
urllib.robotparser.html	22.63 KB	-rw-r--r--
uu.html	18.2 KB	-rw-r--r--
uuid.html	42.88 KB	-rw-r--r--
venv.html	90.43 KB	-rw-r--r--
warnings.html	69.13 KB	-rw-r--r--
wave.html	36.12 KB	-rw-r--r--
weakref.html	73.36 KB	-rw-r--r--
webbrowser.html	33.98 KB	-rw-r--r--
windows.html	12.32 KB	-rw-r--r--
winreg.html	89.48 KB	-rw-r--r--
winsound.html	26.3 KB	-rw-r--r--
wsgiref.html	111.52 KB	-rw-r--r--
xdrlib.html	42.07 KB	-rw-r--r--
xml.dom.html	114.66 KB	-rw-r--r--
xml.dom.minidom.html	49.6 KB	-rw-r--r--
xml.dom.pulldom.html	30.06 KB	-rw-r--r--
xml.etree.elementtree.html	186.49 KB	-rw-r--r--
xml.html	22.34 KB	-rw-r--r--
xml.sax.handler.html	55.78 KB	-rw-r--r--
xml.sax.html	31.74 KB	-rw-r--r--
xml.sax.reader.html	56.23 KB	-rw-r--r--
xml.sax.utils.html	22.28 KB	-rw-r--r--
xmlrpc.client.html	79.73 KB	-rw-r--r--
xmlrpc.html	11.9 KB	-rw-r--r--
xmlrpc.server.html	63.56 KB	-rw-r--r--
zipapp.html	52.45 KB	-rw-r--r--
zipfile.html	116.59 KB	-rw-r--r--
zipimport.html	33.76 KB	-rw-r--r--
zlib.html	42.29 KB	-rw-r--r--
zoneinfo.html	57.25 KB	-rw-r--r--

Code Editor : urllib.request.html

<!DOCTYPE html>

<title>urllib.request — Extensible library for opening URLs &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="urllib.parse — Parse URLs into components" href="urllib.parse.html" />
 <link rel="prev" title="urllib — URL handling modules" href="urllib.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/urllib.request.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">urllib.request</code> — Extensible library for opening URLs</a><ul>
<li><a class="reference internal" href="#request-objects">Request Objects</a></li>
<li><a class="reference internal" href="#openerdirector-objects">OpenerDirector Objects</a></li>
<li><a class="reference internal" href="#basehandler-objects">BaseHandler Objects</a></li>
<li><a class="reference internal" href="#httpredirecthandler-objects">HTTPRedirectHandler Objects</a></li>
<li><a class="reference internal" href="#httpcookieprocessor-objects">HTTPCookieProcessor Objects</a></li>
<li><a class="reference internal" href="#proxyhandler-objects">ProxyHandler Objects</a></li>
<li><a class="reference internal" href="#httppasswordmgr-objects">HTTPPasswordMgr Objects</a></li>
<li><a class="reference internal" href="#httppasswordmgrwithpriorauth-objects">HTTPPasswordMgrWithPriorAuth Objects</a></li>
<li><a class="reference internal" href="#abstractbasicauthhandler-objects">AbstractBasicAuthHandler Objects</a></li>
<li><a class="reference internal" href="#httpbasicauthhandler-objects">HTTPBasicAuthHandler Objects</a></li>
<li><a class="reference internal" href="#proxybasicauthhandler-objects">ProxyBasicAuthHandler Objects</a></li>
<li><a class="reference internal" href="#abstractdigestauthhandler-objects">AbstractDigestAuthHandler Objects</a></li>
<li><a class="reference internal" href="#httpdigestauthhandler-objects">HTTPDigestAuthHandler Objects</a></li>
<li><a class="reference internal" href="#proxydigestauthhandler-objects">ProxyDigestAuthHandler Objects</a></li>
<li><a class="reference internal" href="#httphandler-objects">HTTPHandler Objects</a></li>
<li><a class="reference internal" href="#httpshandler-objects">HTTPSHandler Objects</a></li>
<li><a class="reference internal" href="#filehandler-objects">FileHandler Objects</a></li>
<li><a class="reference internal" href="#datahandler-objects">DataHandler Objects</a></li>
<li><a class="reference internal" href="#ftphandler-objects">FTPHandler Objects</a></li>
<li><a class="reference internal" href="#cacheftphandler-objects">CacheFTPHandler Objects</a></li>
<li><a class="reference internal" href="#unknownhandler-objects">UnknownHandler Objects</a></li>
<li><a class="reference internal" href="#httperrorprocessor-objects">HTTPErrorProcessor Objects</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#legacy-interface">Legacy interface</a></li>
<li><a class="reference internal" href="#urllib-request-restrictions"><code class="xref py py-mod docutils literal notranslate">urllib.request</code> Restrictions</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-urllib.response"><code class="xref py py-mod docutils literal notranslate">urllib.response</code> — Response classes used by urllib</a></li>
</ul>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="urllib.parse.html" title="urllib.parse — Parse URLs into components"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="urllib.html" title="urllib — URL handling modules"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">urllib.request</code> — Extensible library for opening URLs</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-urllib.request">
<h1><a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate">urllib.request</code></a> — Extensible library for opening URLs<a class="headerlink" href="#module-urllib.request" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/urllib/request.py">Lib/urllib/request.py</a>
<hr class="docutils" />
The <a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate">urllib.request</code></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.
<div class="admonition seealso">
See also
The <a class="reference external" href="https://requests.readthedocs.io/en/master/">Requests package</a>
is recommended for a higher-level HTTP client interface.
</div>
The <a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate">urllib.request</code></a> module defines the following functions:
<dl class="py function">
<dt class="sig sig-object py" id="urllib.request.urlopen">
urllib.request.urlopen(url, data=None, [timeout, ]*, cafile=None, capath=None, cadefault=False, context=None)<a class="headerlink" href="#urllib.request.urlopen" title="Permalink to this definition">¶</a></dt>
<dd>Open the URL url, which can be either a string or a
<a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> object.
data must be an object specifying additional data to be sent to the
server, or <code class="docutils literal notranslate">None</code> if no such data is needed. See <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a>
for details.
urllib.request module uses HTTP/1.1 and includes <code class="docutils literal notranslate">Connection:close</code> header
in its HTTP requests.
The optional timeout 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.
If context is specified, it must be a <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate">ssl.SSLContext</code></a> instance
describing the various SSL options. See <a class="reference internal" href="http.client.html#http.client.HTTPSConnection" title="http.client.HTTPSConnection"><code class="xref py py-class docutils literal notranslate">HTTPSConnection</code></a>
for more details.
The optional cafile and capath parameters specify a set of trusted
CA certificates for HTTPS requests. cafile should point to a single
file containing a bundle of CA certificates, whereas capath should
point to a directory of hashed certificate files. More information can
be found in <a class="reference internal" href="ssl.html#ssl.SSLContext.load_verify_locations" title="ssl.SSLContext.load_verify_locations"><code class="xref py py-meth docutils literal notranslate">ssl.SSLContext.load_verify_locations()</code></a>.
The cadefault parameter is ignored.
This function always returns an object which can work as a
<a class="reference internal" href="../glossary.html#term-context-manager">context manager</a> and has the properties url, headers, and status.
See <a class="reference internal" href="#urllib.response.addinfourl" title="urllib.response.addinfourl"><code class="xref py py-class docutils literal notranslate">urllib.response.addinfourl</code></a> for more detail on these properties.
For HTTP and HTTPS URLs, this function returns a
<a class="reference internal" href="http.client.html#http.client.HTTPResponse" title="http.client.HTTPResponse"><code class="xref py py-class docutils literal notranslate">http.client.HTTPResponse</code></a> object slightly modified. In addition
to the three new methods above, the msg attribute contains the
same information as the <a class="reference internal" href="http.client.html#http.client.HTTPResponse.reason" title="http.client.HTTPResponse.reason"><code class="xref py py-attr docutils literal notranslate">reason</code></a>
attribute — the reason phrase returned by server — instead of
the response headers as it is specified in the documentation for
<a class="reference internal" href="http.client.html#http.client.HTTPResponse" title="http.client.HTTPResponse"><code class="xref py py-class docutils literal notranslate">HTTPResponse</code></a>.
For FTP, file, and data URLs and requests explicitly handled by legacy
<a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><code class="xref py py-class docutils literal notranslate">URLopener</code></a> and <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><code class="xref py py-class docutils literal notranslate">FancyURLopener</code></a> classes, this function
returns a <a class="reference internal" href="#urllib.response.addinfourl" title="urllib.response.addinfourl"><code class="xref py py-class docutils literal notranslate">urllib.response.addinfourl</code></a> object.
Raises <a class="reference internal" href="urllib.error.html#urllib.error.URLError" title="urllib.error.URLError"><code class="xref py py-exc docutils literal notranslate">URLError</code></a> on protocol errors.
Note that <code class="docutils literal notranslate">None</code> may be returned if no handler handles the request (though
the default installed global <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a> uses
<a class="reference internal" href="#urllib.request.UnknownHandler" title="urllib.request.UnknownHandler"><code class="xref py py-class docutils literal notranslate">UnknownHandler</code></a> to ensure this never happens).
In addition, if proxy settings are detected (for example, when a <code class="docutils literal notranslate">*_proxy</code>
environment variable like <code class="xref std std-envvar docutils literal notranslate">http_proxy</code> is set),
<a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><code class="xref py py-class docutils literal notranslate">ProxyHandler</code></a> is default installed and makes sure the requests are
handled through the proxy.
The legacy <code class="docutils literal notranslate">urllib.urlopen</code> function from Python 2.6 and earlier has been
discontinued; <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urllib.request.urlopen()</code></a> corresponds to the old
<code class="docutils literal notranslate">urllib2.urlopen</code>. Proxy handling, which was done by passing a dictionary
parameter to <code class="docutils literal notranslate">urllib.urlopen</code>, can be obtained by using
<a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><code class="xref py py-class docutils literal notranslate">ProxyHandler</code></a> objects.
The default opener raises an <a class="reference internal" href="sys.html#auditing">auditing event</a>
<code class="docutils literal notranslate">urllib.Request</code> with arguments <code class="docutils literal notranslate">fullurl</code>, <code class="docutils literal notranslate">data</code>, <code class="docutils literal notranslate">headers</code>,
<code class="docutils literal notranslate">method</code> taken from the request object.

<div class="versionchanged">
Changed in version 3.2: cafile and capath were added.
</div>
<div class="versionchanged">
Changed in version 3.2: HTTPS virtual hosts are now supported if possible (that is, if
<a class="reference internal" href="ssl.html#ssl.HAS_SNI" title="ssl.HAS_SNI"><code class="xref py py-data docutils literal notranslate">ssl.HAS_SNI</code></a> is true).
</div>
<div class="versionadded">
New in version 3.2: data can be an iterable object.
</div>
<div class="versionchanged">
Changed in version 3.3: cadefault was added.
</div>
<div class="versionchanged">
Changed in version 3.4.3: context was added.
</div>
<div class="versionchanged">
Changed in version 3.10: HTTPS connection now send an ALPN extension with protocol indicator
<code class="docutils literal notranslate">http/1.1</code> when no context is given. Custom context should set
ALPN protocols with <code class="xref py py-meth docutils literal notranslate">set_alpn_protocol()</code>.
</div>
<div class="deprecated">
Deprecated since version 3.6: cafile, capath and cadefault are deprecated in favor of context.
Please use <a class="reference internal" href="ssl.html#ssl.SSLContext.load_cert_chain" title="ssl.SSLContext.load_cert_chain"><code class="xref py py-meth docutils literal notranslate">ssl.SSLContext.load_cert_chain()</code></a> instead, or let
<a class="reference internal" href="ssl.html#ssl.create_default_context" title="ssl.create_default_context"><code class="xref py py-func docutils literal notranslate">ssl.create_default_context()</code></a> select the system’s trusted CA
certificates for you.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="urllib.request.install_opener">
urllib.request.install_opener(opener)<a class="headerlink" href="#urllib.request.install_opener" title="Permalink to this definition">¶</a></dt>
<dd>Install an <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a> instance as the default global opener.
Installing an opener is only necessary if you want urlopen to use that
opener; otherwise, simply call <a class="reference internal" href="#urllib.request.OpenerDirector.open" title="urllib.request.OpenerDirector.open"><code class="xref py py-meth docutils literal notranslate">OpenerDirector.open()</code></a> instead of
<a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a>. The code does not check for a real
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a>, and any class with the appropriate interface will
work.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="urllib.request.build_opener">
urllib.request.build_opener([handler, ...])<a class="headerlink" href="#urllib.request.build_opener" title="Permalink to this definition">¶</a></dt>
<dd>Return an <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a> instance, which chains the handlers in the
order given. handlers can be either instances of <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, or
subclasses of <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></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 handlers, unless the handlers contain them,
instances of them or subclasses of them: <a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><code class="xref py py-class docutils literal notranslate">ProxyHandler</code></a> (if proxy
settings are detected), <a class="reference internal" href="#urllib.request.UnknownHandler" title="urllib.request.UnknownHandler"><code class="xref py py-class docutils literal notranslate">UnknownHandler</code></a>, <a class="reference internal" href="#urllib.request.HTTPHandler" title="urllib.request.HTTPHandler"><code class="xref py py-class docutils literal notranslate">HTTPHandler</code></a>,
<a class="reference internal" href="#urllib.request.HTTPDefaultErrorHandler" title="urllib.request.HTTPDefaultErrorHandler"><code class="xref py py-class docutils literal notranslate">HTTPDefaultErrorHandler</code></a>, <a class="reference internal" href="#urllib.request.HTTPRedirectHandler" title="urllib.request.HTTPRedirectHandler"><code class="xref py py-class docutils literal notranslate">HTTPRedirectHandler</code></a>,
<a class="reference internal" href="#urllib.request.FTPHandler" title="urllib.request.FTPHandler"><code class="xref py py-class docutils literal notranslate">FTPHandler</code></a>, <a class="reference internal" href="#urllib.request.FileHandler" title="urllib.request.FileHandler"><code class="xref py py-class docutils literal notranslate">FileHandler</code></a>, <a class="reference internal" href="#urllib.request.HTTPErrorProcessor" title="urllib.request.HTTPErrorProcessor"><code class="xref py py-class docutils literal notranslate">HTTPErrorProcessor</code></a>.
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"><code class="xref py py-mod docutils literal notranslate">ssl</code></a> module
can be imported), <a class="reference internal" href="#urllib.request.HTTPSHandler" title="urllib.request.HTTPSHandler"><code class="xref py py-class docutils literal notranslate">HTTPSHandler</code></a> will also be added.
A <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a> subclass may also change its <code class="xref py py-attr docutils literal notranslate">handler_order</code>
attribute to modify its position in the handlers list.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="urllib.request.pathname2url">
urllib.request.pathname2url(path)<a class="headerlink" href="#urllib.request.pathname2url" title="Permalink to this definition">¶</a></dt>
<dd>Convert the pathname path from the local syntax for a path to the form used in
the path component of a URL. This does not produce a complete URL. The return
value will already be quoted using the <a class="reference internal" href="urllib.parse.html#urllib.parse.quote" title="urllib.parse.quote"><code class="xref py py-func docutils literal notranslate">quote()</code></a> function.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="urllib.request.url2pathname">
urllib.request.url2pathname(path)<a class="headerlink" href="#urllib.request.url2pathname" title="Permalink to this definition">¶</a></dt>
<dd>Convert the path component path from a percent-encoded URL to the local syntax for a
path. This does not accept a complete URL. This function uses
<a class="reference internal" href="urllib.parse.html#urllib.parse.unquote" title="urllib.parse.unquote"><code class="xref py py-func docutils literal notranslate">unquote()</code></a> to decode path.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="urllib.request.getproxies">
urllib.request.getproxies()<a class="headerlink" href="#urllib.request.getproxies" title="Permalink to this definition">¶</a></dt>
<dd>This helper function returns a dictionary of scheme to proxy server URL
mappings. It scans the environment for variables named <code class="docutils literal notranslate">&lt;scheme&gt;_proxy</code>,
in a case insensitive approach, for all operating systems first, and when it
cannot find it, looks for proxy information from System
Configuration for macOS and Windows Systems Registry for Windows.
If both lowercase and uppercase environment variables exist (and disagree),
lowercase is preferred.
<div class="admonition note">
Note
If the environment variable <code class="docutils literal notranslate">REQUEST_METHOD</code> is set, which usually
indicates your script is running in a CGI environment, the environment
variable <code class="docutils literal notranslate">HTTP_PROXY</code> (uppercase <code class="docutils literal notranslate">_PROXY</code>) will be ignored. This is
because that variable can be injected by a client using the “Proxy:” HTTP
header. If you need to use an HTTP proxy in a CGI environment, either use
<code class="docutils literal notranslate">ProxyHandler</code> explicitly, or make sure the variable name is in
lowercase (or at least the <code class="docutils literal notranslate">_proxy</code> suffix).
</div>
</dd></dl>

The following classes are provided:
<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.Request">
class urllib.request.Request(url, data=None, headers={}, origin_req_host=None, unverifiable=False, method=None)<a class="headerlink" href="#urllib.request.Request" title="Permalink to this definition">¶</a></dt>
<dd>This class is an abstraction of a URL request.
url should be a string containing a valid URL.
data must be an object specifying additional data to send to the
server, or <code class="docutils literal notranslate">None</code> if no such data is needed. Currently HTTP
requests are the only ones that use data. The supported object
types include bytes, file-like objects, and iterables of bytes-like objects.
If no <code class="docutils literal notranslate">Content-Length</code> nor <code class="docutils literal notranslate">Transfer-Encoding</code> header field
has been provided, <a class="reference internal" href="#urllib.request.HTTPHandler" title="urllib.request.HTTPHandler"><code class="xref py py-class docutils literal notranslate">HTTPHandler</code></a> will set these headers according
to the type of data. <code class="docutils literal notranslate">Content-Length</code> will be used to send
bytes objects, while <code class="docutils literal notranslate">Transfer-Encoding: chunked</code> as specified in
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc7230.html">RFC 7230</a>, Section 3.3.1 will be used to send files and other iterables.
For an HTTP POST request method, data should be a buffer in the
standard application/x-www-form-urlencoded format. The
<a class="reference internal" href="urllib.parse.html#urllib.parse.urlencode" title="urllib.parse.urlencode"><code class="xref py py-func docutils literal notranslate">urllib.parse.urlencode()</code></a> function takes a mapping or sequence
of 2-tuples and returns an ASCII string in this format. It should
be encoded to bytes before being used as the data parameter.
headers should be a dictionary, and will be treated as if
<a class="reference internal" href="#urllib.request.Request.add_header" title="urllib.request.Request.add_header"><code class="xref py py-meth docutils literal notranslate">add_header()</code></a> was called with each key and value as arguments.
This is often used to “spoof” the <code class="docutils literal notranslate">User-Agent</code> header value, 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 <code class="docutils literal notranslate">&quot;Mozilla/5.0
(X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11&quot;</code>, while
<a class="reference internal" href="urllib.html#module-urllib" title="urllib"><code class="xref py py-mod docutils literal notranslate">urllib</code></a>’s default user agent string is
<code class="docutils literal notranslate">&quot;Python-urllib/2.6&quot;</code> (on Python 2.6).
All header keys are sent in camel case.
An appropriate <code class="docutils literal notranslate">Content-Type</code> header should be included if the data
argument is present. If this header has not been provided and data
is not None, <code class="docutils literal notranslate">Content-Type: application/x-www-form-urlencoded</code> will
be added as a default.
The next two arguments are only of interest for correct handling
of third-party HTTP cookies:
origin_req_host should be the request-host of the origin
transaction, as defined by <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a>. It defaults to
<code class="docutils literal notranslate">http.cookiejar.request_host(self)</code>. 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.
unverifiable should indicate whether the request is unverifiable,
as defined by <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a>. It defaults to <code class="docutils literal notranslate">False</code>. 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.
method should be a string that indicates the HTTP request method that
will be used (e.g. <code class="docutils literal notranslate">'HEAD'</code>). If provided, its value is stored in the
<a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><code class="xref py py-attr docutils literal notranslate">method</code></a> attribute and is used by <a class="reference internal" href="#urllib.request.Request.get_method" title="urllib.request.Request.get_method"><code class="xref py py-meth docutils literal notranslate">get_method()</code></a>.
The default is <code class="docutils literal notranslate">'GET'</code> if data is <code class="docutils literal notranslate">None</code> or <code class="docutils literal notranslate">'POST'</code> otherwise.
Subclasses may indicate a different default method by setting the
<a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><code class="xref py py-attr docutils literal notranslate">method</code></a> attribute in the class itself.
<div class="admonition note">
Note
The request will not work as expected if the data object is unable
to deliver its content more than once (e.g. a file or an iterable
that can produce the content only once) and the request is retried
for HTTP redirects or authentication. The data is sent to the
HTTP server right away after the headers. There is no support for
a 100-continue expectation in the library.
</div>
<div class="versionchanged">
Changed in version 3.3: <a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><code class="xref py py-attr docutils literal notranslate">Request.method</code></a> argument is added to the Request class.
</div>
<div class="versionchanged">
Changed in version 3.4: Default <a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><code class="xref py py-attr docutils literal notranslate">Request.method</code></a> may be indicated at the class level.
</div>
<div class="versionchanged">
Changed in version 3.6: Do not raise an error if the <code class="docutils literal notranslate">Content-Length</code> has not been
provided and data is neither <code class="docutils literal notranslate">None</code> nor a bytes object.
Fall back to use chunked transfer encoding instead.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.OpenerDirector">
class urllib.request.OpenerDirector<a class="headerlink" href="#urllib.request.OpenerDirector" title="Permalink to this definition">¶</a></dt>
<dd>The <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a> class opens URLs via <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>s chained
together. It manages the chaining of handlers, and recovery from errors.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.BaseHandler">
class urllib.request.BaseHandler<a class="headerlink" href="#urllib.request.BaseHandler" title="Permalink to this definition">¶</a></dt>
<dd>This is the base class for all registered handlers — and handles only the
simple mechanics of registration.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPDefaultErrorHandler">
class urllib.request.HTTPDefaultErrorHandler<a class="headerlink" href="#urllib.request.HTTPDefaultErrorHandler" title="Permalink to this definition">¶</a></dt>
<dd>A class which defines a default handler for HTTP error responses; all responses
are turned into <a class="reference internal" href="urllib.error.html#urllib.error.HTTPError" title="urllib.error.HTTPError"><code class="xref py py-exc docutils literal notranslate">HTTPError</code></a> exceptions.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPRedirectHandler">
class urllib.request.HTTPRedirectHandler<a class="headerlink" href="#urllib.request.HTTPRedirectHandler" title="Permalink to this definition">¶</a></dt>
<dd>A class to handle redirections.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPCookieProcessor">
class urllib.request.HTTPCookieProcessor(cookiejar=None)<a class="headerlink" href="#urllib.request.HTTPCookieProcessor" title="Permalink to this definition">¶</a></dt>
<dd>A class to handle HTTP Cookies.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.ProxyHandler">
class urllib.request.ProxyHandler(proxies=None)<a class="headerlink" href="#urllib.request.ProxyHandler" title="Permalink to this definition">¶</a></dt>
<dd>Cause requests to go through a proxy. If proxies 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
<code class="docutils literal notranslate">&lt;protocol&gt;_proxy</code>. 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 macOS environment proxy information
is retrieved from the System Configuration Framework.
To disable autodetected proxy pass an empty dictionary.
The <code class="xref std std-envvar docutils literal notranslate">no_proxy</code> environment variable can be used to specify hosts
which shouldn’t be reached via proxy; if set, it should be a comma-separated
list of hostname suffixes, optionally with <code class="docutils literal notranslate">:port</code> appended, for example
<code class="docutils literal notranslate">cern.ch,ncsa.uiuc.edu,some.host:8080</code>.
<blockquote>
<div><div class="admonition note">
Note
<code class="docutils literal notranslate">HTTP_PROXY</code> will be ignored if a variable <code class="docutils literal notranslate">REQUEST_METHOD</code> is set;
see the documentation on <a class="reference internal" href="#urllib.request.getproxies" title="urllib.request.getproxies"><code class="xref py py-func docutils literal notranslate">getproxies()</code></a>.
</div>
</div></blockquote>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPPasswordMgr">
class urllib.request.HTTPPasswordMgr<a class="headerlink" href="#urllib.request.HTTPPasswordMgr" title="Permalink to this definition">¶</a></dt>
<dd>Keep a database of <code class="docutils literal notranslate">(realm, uri) -&gt; (user, password)</code> mappings.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPPasswordMgrWithDefaultRealm">
class urllib.request.HTTPPasswordMgrWithDefaultRealm<a class="headerlink" href="#urllib.request.HTTPPasswordMgrWithDefaultRealm" title="Permalink to this definition">¶</a></dt>
<dd>Keep a database of <code class="docutils literal notranslate">(realm, uri) -&gt; (user, password)</code> mappings. A realm of
<code class="docutils literal notranslate">None</code> is considered a catch-all realm, which is searched if no other realm
fits.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPPasswordMgrWithPriorAuth">
class urllib.request.HTTPPasswordMgrWithPriorAuth<a class="headerlink" href="#urllib.request.HTTPPasswordMgrWithPriorAuth" title="Permalink to this definition">¶</a></dt>
<dd>A variant of <a class="reference internal" href="#urllib.request.HTTPPasswordMgrWithDefaultRealm" title="urllib.request.HTTPPasswordMgrWithDefaultRealm"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgrWithDefaultRealm</code></a> that also has a
database of <code class="docutils literal notranslate">uri -&gt; is_authenticated</code> mappings. Can be used by a
BasicAuth handler to determine when to send authentication credentials
immediately instead of waiting for a <code class="docutils literal notranslate">401</code> response first.
<div class="versionadded">
New in version 3.5.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.AbstractBasicAuthHandler">
class urllib.request.AbstractBasicAuthHandler(password_mgr=None)<a class="headerlink" href="#urllib.request.AbstractBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>This is a mixin class that helps with HTTP authentication, both to the remote
host and to a proxy. password_mgr, if given, should be something that is
compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgr</code></a>; refer to section
<a class="reference internal" href="#http-password-mgr">HTTPPasswordMgr Objects</a> for information on the interface that must be
supported. If passwd_mgr also provides <code class="docutils literal notranslate">is_authenticated</code> and
<code class="docutils literal notranslate">update_authenticated</code> methods (see
<a class="reference internal" href="#http-password-mgr-with-prior-auth">HTTPPasswordMgrWithPriorAuth Objects</a>), then the handler will use the
<code class="docutils literal notranslate">is_authenticated</code> result for a given URI to determine whether or not to
send authentication credentials with the request. If <code class="docutils literal notranslate">is_authenticated</code>
returns <code class="docutils literal notranslate">True</code> for the URI, credentials are sent. If <code class="docutils literal notranslate">is_authenticated</code>
is <code class="docutils literal notranslate">False</code>, credentials are not sent, and then if a <code class="docutils literal notranslate">401</code> response is
received the request is re-sent with the authentication credentials. If
authentication succeeds, <code class="docutils literal notranslate">update_authenticated</code> is called to set
<code class="docutils literal notranslate">is_authenticated</code> <code class="docutils literal notranslate">True</code> for the URI, so that subsequent requests to
the URI or any of its super-URIs will automatically include the
authentication credentials.
<div class="versionadded">
New in version 3.5: Added <code class="docutils literal notranslate">is_authenticated</code> support.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPBasicAuthHandler">
class urllib.request.HTTPBasicAuthHandler(password_mgr=None)<a class="headerlink" href="#urllib.request.HTTPBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>Handle authentication with the remote host. password_mgr, if given, should
be something that is compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgr</code></a>; refer to
section <a class="reference internal" href="#http-password-mgr">HTTPPasswordMgr Objects</a> for information on the interface that must
be supported. HTTPBasicAuthHandler will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> when
presented with a wrong Authentication scheme.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.ProxyBasicAuthHandler">
class urllib.request.ProxyBasicAuthHandler(password_mgr=None)<a class="headerlink" href="#urllib.request.ProxyBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>Handle authentication with the proxy. password_mgr, if given, should be
something that is compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgr</code></a>; refer to section
<a class="reference internal" href="#http-password-mgr">HTTPPasswordMgr Objects</a> for information on the interface that must be
supported.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.AbstractDigestAuthHandler">
class urllib.request.AbstractDigestAuthHandler(password_mgr=None)<a class="headerlink" href="#urllib.request.AbstractDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>This is a mixin class that helps with HTTP authentication, both to the remote
host and to a proxy. password_mgr, if given, should be something that is
compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgr</code></a>; refer to section
<a class="reference internal" href="#http-password-mgr">HTTPPasswordMgr Objects</a> for information on the interface that must be
supported.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPDigestAuthHandler">
class urllib.request.HTTPDigestAuthHandler(password_mgr=None)<a class="headerlink" href="#urllib.request.HTTPDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>Handle authentication with the remote host. password_mgr, if given, should
be something that is compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgr</code></a>; refer to
section <a class="reference internal" href="#http-password-mgr">HTTPPasswordMgr Objects</a> for information on the interface that must
be supported. When both Digest Authentication Handler and Basic
Authentication Handler are both added, Digest Authentication is always tried
first. If the Digest Authentication returns a 40x response again, it is sent
to Basic Authentication handler to Handle. This Handler method will raise a
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> when presented with an authentication scheme other than
Digest or Basic.
<div class="versionchanged">
Changed in version 3.3: Raise <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> on unsupported Authentication Scheme.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.ProxyDigestAuthHandler">
class urllib.request.ProxyDigestAuthHandler(password_mgr=None)<a class="headerlink" href="#urllib.request.ProxyDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd>Handle authentication with the proxy. password_mgr, if given, should be
something that is compatible with <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgr</code></a>; refer to section
<a class="reference internal" href="#http-password-mgr">HTTPPasswordMgr Objects</a> for information on the interface that must be
supported.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPHandler">
class urllib.request.HTTPHandler<a class="headerlink" href="#urllib.request.HTTPHandler" title="Permalink to this definition">¶</a></dt>
<dd>A class to handle opening of HTTP URLs.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPSHandler">
class urllib.request.HTTPSHandler(debuglevel=0, context=None, check_hostname=None)<a class="headerlink" href="#urllib.request.HTTPSHandler" title="Permalink to this definition">¶</a></dt>
<dd>A class to handle opening of HTTPS URLs. context and check_hostname
have the same meaning as in <a class="reference internal" href="http.client.html#http.client.HTTPSConnection" title="http.client.HTTPSConnection"><code class="xref py py-class docutils literal notranslate">http.client.HTTPSConnection</code></a>.
<div class="versionchanged">
Changed in version 3.2: context and check_hostname were added.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.FileHandler">
class urllib.request.FileHandler<a class="headerlink" href="#urllib.request.FileHandler" title="Permalink to this definition">¶</a></dt>
<dd>Open local files.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.DataHandler">
class urllib.request.DataHandler<a class="headerlink" href="#urllib.request.DataHandler" title="Permalink to this definition">¶</a></dt>
<dd>Open data URLs.
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.FTPHandler">
class urllib.request.FTPHandler<a class="headerlink" href="#urllib.request.FTPHandler" title="Permalink to this definition">¶</a></dt>
<dd>Open FTP URLs.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.CacheFTPHandler">
class urllib.request.CacheFTPHandler<a class="headerlink" href="#urllib.request.CacheFTPHandler" title="Permalink to this definition">¶</a></dt>
<dd>Open FTP URLs, keeping a cache of open FTP connections to minimize delays.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.UnknownHandler">
class urllib.request.UnknownHandler<a class="headerlink" href="#urllib.request.UnknownHandler" title="Permalink to this definition">¶</a></dt>
<dd>A catch-all class to handle unknown URLs.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.HTTPErrorProcessor">
class urllib.request.HTTPErrorProcessor<a class="headerlink" href="#urllib.request.HTTPErrorProcessor" title="Permalink to this definition">¶</a></dt>
<dd>Process HTTP error responses.
</dd></dl>

<section id="request-objects">
<h2>Request Objects<a class="headerlink" href="#request-objects" title="Permalink to this headline">¶</a></h2>
The following methods describe <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a>’s public interface,
and so all may be overridden in subclasses. It also defines several
public attributes that can be used by clients to inspect the parsed
request.
<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.Request.full_url">
Request.full_url<a class="headerlink" href="#urllib.request.Request.full_url" title="Permalink to this definition">¶</a></dt>
<dd>The original URL passed to the constructor.
<div class="versionchanged">
Changed in version 3.4.
</div>
Request.full_url is a property with setter, getter and a deleter. Getting
<a class="reference internal" href="#urllib.request.Request.full_url" title="urllib.request.Request.full_url"><code class="xref py py-attr docutils literal notranslate">full_url</code></a> returns the original request URL with the
fragment, if it was present.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.Request.type">
Request.type<a class="headerlink" href="#urllib.request.Request.type" title="Permalink to this definition">¶</a></dt>
<dd>The URI scheme.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.Request.host">
Request.host<a class="headerlink" href="#urllib.request.Request.host" title="Permalink to this definition">¶</a></dt>
<dd>The URI authority, typically a host, but may also contain a port
separated by a colon.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.Request.origin_req_host">
Request.origin_req_host<a class="headerlink" href="#urllib.request.Request.origin_req_host" title="Permalink to this definition">¶</a></dt>
<dd>The original host for the request, without port.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.Request.selector">
Request.selector<a class="headerlink" href="#urllib.request.Request.selector" title="Permalink to this definition">¶</a></dt>
<dd>The URI path. If the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> uses a proxy, then selector
will be the full URL that is passed to the proxy.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.Request.data">
Request.data<a class="headerlink" href="#urllib.request.Request.data" title="Permalink to this definition">¶</a></dt>
<dd>The entity body for the request, or <code class="docutils literal notranslate">None</code> if not specified.
<div class="versionchanged">
Changed in version 3.4: Changing value of <a class="reference internal" href="#urllib.request.Request.data" title="urllib.request.Request.data"><code class="xref py py-attr docutils literal notranslate">Request.data</code></a> now deletes “Content-Length”
header if it was previously set or calculated.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.Request.unverifiable">
Request.unverifiable<a class="headerlink" href="#urllib.request.Request.unverifiable" title="Permalink to this definition">¶</a></dt>
<dd>boolean, indicates whether the request is unverifiable as defined
by <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.Request.method">
Request.method<a class="headerlink" href="#urllib.request.Request.method" title="Permalink to this definition">¶</a></dt>
<dd>The HTTP request method to use. By default its value is <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>,
which means that <a class="reference internal" href="#urllib.request.Request.get_method" title="urllib.request.Request.get_method"><code class="xref py py-meth docutils literal notranslate">get_method()</code></a> will do its normal computation
of the method to be used. Its value can be set (thus overriding the default
computation in <a class="reference internal" href="#urllib.request.Request.get_method" title="urllib.request.Request.get_method"><code class="xref py py-meth docutils literal notranslate">get_method()</code></a>) either by providing a default
value by setting it at the class level in a <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> subclass, or by
passing a value in to the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> constructor via the method
argument.
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.4: A default value can now be set in subclasses; previously it could only
be set via the constructor argument.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.Request.get_method">
Request.get_method()<a class="headerlink" href="#urllib.request.Request.get_method" title="Permalink to this definition">¶</a></dt>
<dd>Return a string indicating the HTTP request method. If
<a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><code class="xref py py-attr docutils literal notranslate">Request.method</code></a> is not <code class="docutils literal notranslate">None</code>, return its value, otherwise return
<code class="docutils literal notranslate">'GET'</code> if <a class="reference internal" href="#urllib.request.Request.data" title="urllib.request.Request.data"><code class="xref py py-attr docutils literal notranslate">Request.data</code></a> is <code class="docutils literal notranslate">None</code>, or <code class="docutils literal notranslate">'POST'</code> if it’s not.
This is only meaningful for HTTP requests.
<div class="versionchanged">
Changed in version 3.3: get_method now looks at the value of <a class="reference internal" href="#urllib.request.Request.method" title="urllib.request.Request.method"><code class="xref py py-attr docutils literal notranslate">Request.method</code></a>.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.Request.add_header">
Request.add_header(key, val)<a class="headerlink" href="#urllib.request.Request.add_header" title="Permalink to this definition">¶</a></dt>
<dd>Add another header to the request. Headers are currently ignored by all
handlers except HTTP handlers, where they are added to the list of headers sent
to the server. Note that there cannot be more than one header with the same
name, and later calls will overwrite previous calls in case the key 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. Note that headers added using
this method are also added to redirected requests.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.Request.add_unredirected_header">
Request.add_unredirected_header(key, header)<a class="headerlink" href="#urllib.request.Request.add_unredirected_header" title="Permalink to this definition">¶</a></dt>
<dd>Add a header that will not be added to a redirected request.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.Request.has_header">
Request.has_header(header)<a class="headerlink" href="#urllib.request.Request.has_header" title="Permalink to this definition">¶</a></dt>
<dd>Return whether the instance has the named header (checks both regular and
unredirected).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.Request.remove_header">
Request.remove_header(header)<a class="headerlink" href="#urllib.request.Request.remove_header" title="Permalink to this definition">¶</a></dt>
<dd>Remove named header from the request instance (both from regular and
unredirected headers).
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.Request.get_full_url">
Request.get_full_url()<a class="headerlink" href="#urllib.request.Request.get_full_url" title="Permalink to this definition">¶</a></dt>
<dd>Return the URL given in the constructor.
<div class="versionchanged">
Changed in version 3.4.
</div>
Returns <a class="reference internal" href="#urllib.request.Request.full_url" title="urllib.request.Request.full_url"><code class="xref py py-attr docutils literal notranslate">Request.full_url</code></a>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.Request.set_proxy">
Request.set_proxy(host, type)<a class="headerlink" href="#urllib.request.Request.set_proxy" title="Permalink to this definition">¶</a></dt>
<dd>Prepare the request by connecting to a proxy server. The host and type will
replace those of the instance, and the instance’s selector will be the original
URL given in the constructor.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.Request.get_header">
Request.get_header(header_name, default=None)<a class="headerlink" href="#urllib.request.Request.get_header" title="Permalink to this definition">¶</a></dt>
<dd>Return the value of the given header. If the header is not present, return
the default value.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.Request.header_items">
Request.header_items()<a class="headerlink" href="#urllib.request.Request.header_items" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of tuples (header_name, header_value) of the Request headers.
</dd></dl>

<div class="versionchanged">
Changed in version 3.4: The request methods add_data, has_data, get_data, get_type, get_host,
get_selector, get_origin_req_host and is_unverifiable that were deprecated
since 3.3 have been removed.
</div>
</section>
<section id="openerdirector-objects">
<h2>OpenerDirector Objects<a class="headerlink" href="#openerdirector-objects" title="Permalink to this headline">¶</a></h2>
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a> instances have the following methods:
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.OpenerDirector.add_handler">
OpenerDirector.add_handler(handler)<a class="headerlink" href="#urllib.request.OpenerDirector.add_handler" title="Permalink to this definition">¶</a></dt>
<dd>handler should be an instance of <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>. The following methods
are searched, and added to the possible chains (note that HTTP errors are a
special case). Note that, in the following, protocol should be replaced
with the actual protocol to handle, for example <code class="xref py py-meth docutils literal notranslate">http_response()</code> would
be the HTTP protocol response handler. Also type should be replaced with
the actual HTTP code, for example <code class="xref py py-meth docutils literal notranslate">http_error_404()</code> would handle HTTP
404 errors.
<ul>
<li><code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_open()</code> — signal that the handler knows how to open protocol
URLs.
See <a class="reference internal" href="#protocol-open"><code class="xref py py-meth docutils literal notranslate">BaseHandler.&lt;protocol&gt;_open()</code></a> for more information.
</li>
<li><code class="xref py py-meth docutils literal notranslate">http_error_&lt;type&gt;()</code> — signal that the handler knows how to handle HTTP
errors with HTTP error code type.
See <a class="reference internal" href="#http-error-nnn"><code class="xref py py-meth docutils literal notranslate">BaseHandler.http_error_&lt;nnn&gt;()</code></a> for more information.
</li>
<li><code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_error()</code> — signal that the handler knows how to handle errors
from (non-<code class="docutils literal notranslate">http</code>) protocol.</li>
<li><code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_request()</code> — signal that the handler knows how to pre-process
protocol requests.
See <a class="reference internal" href="#protocol-request"><code class="xref py py-meth docutils literal notranslate">BaseHandler.&lt;protocol&gt;_request()</code></a> for more information.
</li>
<li><code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_response()</code> — signal that the handler knows how to
post-process protocol responses.
See <a class="reference internal" href="#protocol-response"><code class="xref py py-meth docutils literal notranslate">BaseHandler.&lt;protocol&gt;_response()</code></a> for more information.
</li>
</ul>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.OpenerDirector.open">
OpenerDirector.open(url, data=None[, timeout])<a class="headerlink" href="#urllib.request.OpenerDirector.open" title="Permalink to this definition">¶</a></dt>
<dd>Open the given url (which can be a request object or a string), optionally
passing the given data. Arguments, return values and exceptions raised are
the same as those of <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a> (which simply calls the <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-meth docutils literal notranslate">open()</code></a>
method on the currently installed global <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a>). The
optional timeout 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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.OpenerDirector.error">
OpenerDirector.error(proto, *args)<a class="headerlink" href="#urllib.request.OpenerDirector.error" title="Permalink to this definition">¶</a></dt>
<dd>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 <code class="xref py py-meth docutils literal notranslate">http_error_&lt;type&gt;()</code>
methods of the handler classes.
Return values and exceptions raised are the same as those of <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a>.
</dd></dl>

OpenerDirector objects open URLs in three stages:
The order in which these methods are called within each stage is determined by
sorting the handler instances.
<ol class="arabic">
<li>Every handler with a method named like <code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_request()</code> has that
method called to pre-process the request.</li>
<li>Handlers with a method named like <code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_open()</code> 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"><code class="xref py py-const docutils literal notranslate">None</code></a>
value (ie. a response), or raises an exception (usually
<a class="reference internal" href="urllib.error.html#urllib.error.URLError" title="urllib.error.URLError"><code class="xref py py-exc docutils literal notranslate">URLError</code></a>). Exceptions are allowed to propagate.
In fact, the above algorithm is first tried for methods named
<code class="xref py py-meth docutils literal notranslate">default_open()</code>. If all such methods return <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>, the algorithm
is repeated for methods named like <code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_open()</code>. If all such methods
return <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>, the algorithm is repeated for methods named
<code class="xref py py-meth docutils literal notranslate">unknown_open()</code>.
Note that the implementation of these methods may involve calls of the parent
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a> instance’s <a class="reference internal" href="#urllib.request.OpenerDirector.open" title="urllib.request.OpenerDirector.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a> and
<a class="reference internal" href="#urllib.request.OpenerDirector.error" title="urllib.request.OpenerDirector.error"><code class="xref py py-meth docutils literal notranslate">error()</code></a> methods.
</li>
<li>Every handler with a method named like <code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_response()</code> has that
method called to post-process the response.</li>
</ol>
</section>
<section id="basehandler-objects">
<h2>BaseHandler Objects<a class="headerlink" href="#basehandler-objects" title="Permalink to this headline">¶</a></h2>
<a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></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:
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.BaseHandler.add_parent">
BaseHandler.add_parent(director)<a class="headerlink" href="#urllib.request.BaseHandler.add_parent" title="Permalink to this definition">¶</a></dt>
<dd>Add a director as parent.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.BaseHandler.close">
BaseHandler.close()<a class="headerlink" href="#urllib.request.BaseHandler.close" title="Permalink to this definition">¶</a></dt>
<dd>Remove any parents.
</dd></dl>

The following attribute and methods should only be used by classes derived from
<a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>.
<div class="admonition note">
Note
The convention has been adopted that subclasses defining
<code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_request()</code> or <code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_response()</code> methods are named
<code class="xref py py-class docutils literal notranslate">*Processor</code>; all others are named <code class="xref py py-class docutils literal notranslate">*Handler</code>.
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.BaseHandler.parent">
BaseHandler.parent<a class="headerlink" href="#urllib.request.BaseHandler.parent" title="Permalink to this definition">¶</a></dt>
<dd>A valid <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a>, which can be used to open using a different
protocol, or handle errors.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.BaseHandler.default_open">
BaseHandler.default_open(req)<a class="headerlink" href="#urllib.request.BaseHandler.default_open" title="Permalink to this definition">¶</a></dt>
<dd>This method is not defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but subclasses should
define it if they want to catch all URLs.
This method, if implemented, will be called by the parent
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a>. It should return a file-like object as described in
the return value of the <a class="reference internal" href="#urllib.request.OpenerDirector.open" title="urllib.request.OpenerDirector.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a> method of <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a>, or <code class="docutils literal notranslate">None</code>.
It should raise <a class="reference internal" href="urllib.error.html#urllib.error.URLError" title="urllib.error.URLError"><code class="xref py py-exc docutils literal notranslate">URLError</code></a>, unless a truly exceptional
thing happens (for example, <a class="reference internal" href="exceptions.html#MemoryError" title="MemoryError"><code class="xref py py-exc docutils literal notranslate">MemoryError</code></a> should not be mapped to
<code class="xref py py-exc docutils literal notranslate">URLError</code>).
This method will be called before any protocol-specific open method.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py">
BaseHandler.&lt;protocol&gt;_open(req)</dt>
<dd>This method is not defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but subclasses should
define it if they want to handle URLs with the given protocol.
This method, if defined, will be called by the parent <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a>.
Return values should be the same as for <code class="xref py py-meth docutils literal notranslate">default_open()</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.BaseHandler.unknown_open">
BaseHandler.unknown_open(req)<a class="headerlink" href="#urllib.request.BaseHandler.unknown_open" title="Permalink to this definition">¶</a></dt>
<dd>This method is not defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but subclasses should
define it if they want to catch all URLs with no specific registered handler to
open it.
This method, if implemented, will be called by the <a class="reference internal" href="#urllib.request.BaseHandler.parent" title="urllib.request.BaseHandler.parent"><code class="xref py py-attr docutils literal notranslate">parent</code></a>
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a>. Return values should be the same as for
<a class="reference internal" href="#urllib.request.BaseHandler.default_open" title="urllib.request.BaseHandler.default_open"><code class="xref py py-meth docutils literal notranslate">default_open()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.BaseHandler.http_error_default">
BaseHandler.http_error_default(req, fp, code, msg, hdrs)<a class="headerlink" href="#urllib.request.BaseHandler.http_error_default" title="Permalink to this definition">¶</a></dt>
<dd>This method is not defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but subclasses should
override it if they intend to provide a catch-all for otherwise unhandled HTTP
errors. It will be called automatically by the <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a> getting
the error, and should not normally be called in other circumstances.
req will be a <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> object, fp will be a file-like object with
the HTTP error body, code will be the three-digit code of the error, msg
will be the user-visible explanation of the code and hdrs will be a mapping
object with the headers of the error.
Return values and exceptions raised should be the same as those of
<a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py">
BaseHandler.http_error_&lt;nnn&gt;(req, fp, code, msg, hdrs)</dt>
<dd>nnn should be a three-digit HTTP error code. This method is also not defined
in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but will be called, if it exists, on an instance of a
subclass, when an HTTP error with code nnn occurs.
Subclasses should override this method to handle specific HTTP errors.
Arguments, return values and exceptions raised should be the same as for
<code class="xref py py-meth docutils literal notranslate">http_error_default()</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py">
BaseHandler.&lt;protocol&gt;_request(req)</dt>
<dd>This method is not defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but subclasses should
define it if they want to pre-process requests of the given protocol.
This method, if defined, will be called by the parent <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a>.
req will be a <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> object. The return value should be a
<a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> object.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py">
BaseHandler.&lt;protocol&gt;_response(req, response)</dt>
<dd>This method is not defined in <a class="reference internal" href="#urllib.request.BaseHandler" title="urllib.request.BaseHandler"><code class="xref py py-class docutils literal notranslate">BaseHandler</code></a>, but subclasses should
define it if they want to post-process responses of the given protocol.
This method, if defined, will be called by the parent <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a>.
req will be a <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> object. response will be an object
implementing the same interface as the return value of <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a>. The
return value should implement the same interface as the return value of
<a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a>.
</dd></dl>

</section>
<section id="httpredirecthandler-objects">
<h2>HTTPRedirectHandler Objects<a class="headerlink" href="#httpredirecthandler-objects" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
Note
Some HTTP redirections require action from this module’s client code. If this
is the case, <a class="reference internal" href="urllib.error.html#urllib.error.HTTPError" title="urllib.error.HTTPError"><code class="xref py py-exc docutils literal notranslate">HTTPError</code></a> is raised. See <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2616.html">RFC 2616</a> for
details of the precise meanings of the various redirection codes.
An <code class="xref py py-class docutils literal notranslate">HTTPError</code> exception raised as a security consideration if the
HTTPRedirectHandler is presented with a redirected URL which is not an HTTP,
HTTPS or FTP URL.
</div>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPRedirectHandler.redirect_request">
HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl)<a class="headerlink" href="#urllib.request.HTTPRedirectHandler.redirect_request" title="Permalink to this definition">¶</a></dt>
<dd>Return a <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> or <code class="docutils literal notranslate">None</code> in response to a redirect. This is called
by the default implementations of the <code class="xref py py-meth docutils literal notranslate">http_error_30*()</code> methods when a
redirection is received from the server. If a redirection should take place,
return a new <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> to allow <code class="xref py py-meth docutils literal notranslate">http_error_30*()</code> to perform the
redirect to newurl. Otherwise, raise <a class="reference internal" href="urllib.error.html#urllib.error.HTTPError" title="urllib.error.HTTPError"><code class="xref py py-exc docutils literal notranslate">HTTPError</code></a> if
no other handler should try to handle this URL, or return <code class="docutils literal notranslate">None</code> if you
can’t but another handler might.
<div class="admonition note">
Note
The default implementation of this method does not strictly follow <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2616.html">RFC 2616</a>,
which says that 301 and 302 responses to <code class="docutils literal notranslate">POST</code> 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
<code class="docutils literal notranslate">GET</code>, and the default implementation reproduces this behavior.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPRedirectHandler.http_error_301">
HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs)<a class="headerlink" href="#urllib.request.HTTPRedirectHandler.http_error_301" title="Permalink to this definition">¶</a></dt>
<dd>Redirect to the <code class="docutils literal notranslate">Location:</code> or <code class="docutils literal notranslate">URI:</code> URL. This method is called by the
parent <a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a> when getting an HTTP ‘moved permanently’ response.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPRedirectHandler.http_error_302">
HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs)<a class="headerlink" href="#urllib.request.HTTPRedirectHandler.http_error_302" title="Permalink to this definition">¶</a></dt>
<dd>The same as <a class="reference internal" href="#urllib.request.HTTPRedirectHandler.http_error_301" title="urllib.request.HTTPRedirectHandler.http_error_301"><code class="xref py py-meth docutils literal notranslate">http_error_301()</code></a>, but called for the ‘found’ response.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPRedirectHandler.http_error_303">
HTTPRedirectHandler.http_error_303(req, fp, code, msg, hdrs)<a class="headerlink" href="#urllib.request.HTTPRedirectHandler.http_error_303" title="Permalink to this definition">¶</a></dt>
<dd>The same as <a class="reference internal" href="#urllib.request.HTTPRedirectHandler.http_error_301" title="urllib.request.HTTPRedirectHandler.http_error_301"><code class="xref py py-meth docutils literal notranslate">http_error_301()</code></a>, but called for the ‘see other’ response.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPRedirectHandler.http_error_307">
HTTPRedirectHandler.http_error_307(req, fp, code, msg, hdrs)<a class="headerlink" href="#urllib.request.HTTPRedirectHandler.http_error_307" title="Permalink to this definition">¶</a></dt>
<dd>The same as <a class="reference internal" href="#urllib.request.HTTPRedirectHandler.http_error_301" title="urllib.request.HTTPRedirectHandler.http_error_301"><code class="xref py py-meth docutils literal notranslate">http_error_301()</code></a>, but called for the ‘temporary redirect’
response.
</dd></dl>

</section>
<section id="httpcookieprocessor-objects">
<h2>HTTPCookieProcessor Objects<a class="headerlink" href="#httpcookieprocessor-objects" title="Permalink to this headline">¶</a></h2>
<a class="reference internal" href="#urllib.request.HTTPCookieProcessor" title="urllib.request.HTTPCookieProcessor"><code class="xref py py-class docutils literal notranslate">HTTPCookieProcessor</code></a> instances have one attribute:
<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.HTTPCookieProcessor.cookiejar">
HTTPCookieProcessor.cookiejar<a class="headerlink" href="#urllib.request.HTTPCookieProcessor.cookiejar" title="Permalink to this definition">¶</a></dt>
<dd>The <a class="reference internal" href="http.cookiejar.html#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">http.cookiejar.CookieJar</code></a> in which cookies are stored.
</dd></dl>

</section>
<section id="proxyhandler-objects">
<h2>ProxyHandler Objects<a class="headerlink" href="#proxyhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py">
ProxyHandler.&lt;protocol&gt;_open(request)</dt>
<dd>The <a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><code class="xref py py-class docutils literal notranslate">ProxyHandler</code></a> will have a method <code class="xref py py-meth docutils literal notranslate">&lt;protocol&gt;_open()</code> for every
protocol which has a proxy in the proxies dictionary given in the
constructor. The method will modify requests to go through the proxy, by
calling <code class="docutils literal notranslate">request.set_proxy()</code>, and call the next handler in the chain to
actually execute the protocol.
</dd></dl>

</section>
<section id="httppasswordmgr-objects">
<h2>HTTPPasswordMgr Objects<a class="headerlink" href="#httppasswordmgr-objects" title="Permalink to this headline">¶</a></h2>
These methods are available on <a class="reference internal" href="#urllib.request.HTTPPasswordMgr" title="urllib.request.HTTPPasswordMgr"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgr</code></a> and
<a class="reference internal" href="#urllib.request.HTTPPasswordMgrWithDefaultRealm" title="urllib.request.HTTPPasswordMgrWithDefaultRealm"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgrWithDefaultRealm</code></a> objects.
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPPasswordMgr.add_password">
HTTPPasswordMgr.add_password(realm, uri, user, passwd)<a class="headerlink" href="#urllib.request.HTTPPasswordMgr.add_password" title="Permalink to this definition">¶</a></dt>
<dd>uri can be either a single URI, or a sequence of URIs. realm, user and
passwd must be strings. This causes <code class="docutils literal notranslate">(user, passwd)</code> to be used as
authentication tokens when authentication for realm and a super-URI of any of
the given URIs is given.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPPasswordMgr.find_user_password">
HTTPPasswordMgr.find_user_password(realm, authuri)<a class="headerlink" href="#urllib.request.HTTPPasswordMgr.find_user_password" title="Permalink to this definition">¶</a></dt>
<dd>Get user/password for given realm and URI, if any. This method will return
<code class="docutils literal notranslate">(None, None)</code> if there is no matching user/password.
For <a class="reference internal" href="#urllib.request.HTTPPasswordMgrWithDefaultRealm" title="urllib.request.HTTPPasswordMgrWithDefaultRealm"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgrWithDefaultRealm</code></a> objects, the realm <code class="docutils literal notranslate">None</code> will be
searched if the given realm has no matching user/password.
</dd></dl>

</section>
<section id="httppasswordmgrwithpriorauth-objects">
<h2>HTTPPasswordMgrWithPriorAuth Objects<a class="headerlink" href="#httppasswordmgrwithpriorauth-objects" title="Permalink to this headline">¶</a></h2>
This password manager extends <a class="reference internal" href="#urllib.request.HTTPPasswordMgrWithDefaultRealm" title="urllib.request.HTTPPasswordMgrWithDefaultRealm"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgrWithDefaultRealm</code></a> to support
tracking URIs for which authentication credentials should always be sent.
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPPasswordMgrWithPriorAuth.add_password">
HTTPPasswordMgrWithPriorAuth.add_password(realm, uri, user, passwd, is_authenticated=False)<a class="headerlink" href="#urllib.request.HTTPPasswordMgrWithPriorAuth.add_password" title="Permalink to this definition">¶</a></dt>
<dd>realm, uri, user, passwd are as for
<a class="reference internal" href="#urllib.request.HTTPPasswordMgr.add_password" title="urllib.request.HTTPPasswordMgr.add_password"><code class="xref py py-meth docutils literal notranslate">HTTPPasswordMgr.add_password()</code></a>. is_authenticated sets the initial
value of the <code class="docutils literal notranslate">is_authenticated</code> flag for the given URI or list of URIs.
If is_authenticated is specified as <code class="docutils literal notranslate">True</code>, realm is ignored.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPPasswordMgrWithPriorAuth.find_user_password">
HTTPPasswordMgrWithPriorAuth.find_user_password(realm, authuri)<a class="headerlink" href="#urllib.request.HTTPPasswordMgrWithPriorAuth.find_user_password" title="Permalink to this definition">¶</a></dt>
<dd>Same as for <a class="reference internal" href="#urllib.request.HTTPPasswordMgrWithDefaultRealm" title="urllib.request.HTTPPasswordMgrWithDefaultRealm"><code class="xref py py-class docutils literal notranslate">HTTPPasswordMgrWithDefaultRealm</code></a> objects
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPPasswordMgrWithPriorAuth.update_authenticated">
HTTPPasswordMgrWithPriorAuth.update_authenticated(self, uri, is_authenticated=False)<a class="headerlink" href="#urllib.request.HTTPPasswordMgrWithPriorAuth.update_authenticated" title="Permalink to this definition">¶</a></dt>
<dd>Update the <code class="docutils literal notranslate">is_authenticated</code> flag for the given uri or list
of URIs.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPPasswordMgrWithPriorAuth.is_authenticated">
HTTPPasswordMgrWithPriorAuth.is_authenticated(self, authuri)<a class="headerlink" href="#urllib.request.HTTPPasswordMgrWithPriorAuth.is_authenticated" title="Permalink to this definition">¶</a></dt>
<dd>Returns the current state of the <code class="docutils literal notranslate">is_authenticated</code> flag for
the given URI.
</dd></dl>

</section>
<section id="abstractbasicauthhandler-objects">
<h2>AbstractBasicAuthHandler Objects<a class="headerlink" href="#abstractbasicauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.AbstractBasicAuthHandler.http_error_auth_reqed">
AbstractBasicAuthHandler.http_error_auth_reqed(authreq, host, req, headers)<a class="headerlink" href="#urllib.request.AbstractBasicAuthHandler.http_error_auth_reqed" title="Permalink to this definition">¶</a></dt>
<dd>Handle an authentication request by getting a user/password pair, and re-trying
the request. authreq should be the name of the header where the information
about the realm is included in the request, host specifies the URL and path to
authenticate for, req should be the (failed) <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> object, and
headers should be the error headers.
host is either an authority (e.g. <code class="docutils literal notranslate">&quot;python.org&quot;</code>) or a URL containing an
authority component (e.g. <code class="docutils literal notranslate">&quot;http://python.org/&quot;</code>). In either case, the
authority must not contain a userinfo component (so, <code class="docutils literal notranslate">&quot;python.org&quot;</code> and
<code class="docutils literal notranslate">&quot;python.org:80&quot;</code> are fine, <code class="docutils literal notranslate">&quot;joe:password&#64;python.org&quot;</code> is not).
</dd></dl>

</section>
<section id="httpbasicauthhandler-objects">
<h2>HTTPBasicAuthHandler Objects<a class="headerlink" href="#httpbasicauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPBasicAuthHandler.http_error_401">
HTTPBasicAuthHandler.http_error_401(req, fp, code, msg, hdrs)<a class="headerlink" href="#urllib.request.HTTPBasicAuthHandler.http_error_401" title="Permalink to this definition">¶</a></dt>
<dd>Retry the request with authentication information, if available.
</dd></dl>

</section>
<section id="proxybasicauthhandler-objects">
<h2>ProxyBasicAuthHandler Objects<a class="headerlink" href="#proxybasicauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.ProxyBasicAuthHandler.http_error_407">
ProxyBasicAuthHandler.http_error_407(req, fp, code, msg, hdrs)<a class="headerlink" href="#urllib.request.ProxyBasicAuthHandler.http_error_407" title="Permalink to this definition">¶</a></dt>
<dd>Retry the request with authentication information, if available.
</dd></dl>

</section>
<section id="abstractdigestauthhandler-objects">
<h2>AbstractDigestAuthHandler Objects<a class="headerlink" href="#abstractdigestauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.AbstractDigestAuthHandler.http_error_auth_reqed">
AbstractDigestAuthHandler.http_error_auth_reqed(authreq, host, req, headers)<a class="headerlink" href="#urllib.request.AbstractDigestAuthHandler.http_error_auth_reqed" title="Permalink to this definition">¶</a></dt>
<dd>authreq should be the name of the header where the information about the realm
is included in the request, host should be the host to authenticate to, req
should be the (failed) <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> object, and headers should be the
error headers.
</dd></dl>

</section>
<section id="httpdigestauthhandler-objects">
<h2>HTTPDigestAuthHandler Objects<a class="headerlink" href="#httpdigestauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPDigestAuthHandler.http_error_401">
HTTPDigestAuthHandler.http_error_401(req, fp, code, msg, hdrs)<a class="headerlink" href="#urllib.request.HTTPDigestAuthHandler.http_error_401" title="Permalink to this definition">¶</a></dt>
<dd>Retry the request with authentication information, if available.
</dd></dl>

</section>
<section id="proxydigestauthhandler-objects">
<h2>ProxyDigestAuthHandler Objects<a class="headerlink" href="#proxydigestauthhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.ProxyDigestAuthHandler.http_error_407">
ProxyDigestAuthHandler.http_error_407(req, fp, code, msg, hdrs)<a class="headerlink" href="#urllib.request.ProxyDigestAuthHandler.http_error_407" title="Permalink to this definition">¶</a></dt>
<dd>Retry the request with authentication information, if available.
</dd></dl>

</section>
<section id="httphandler-objects">
<h2>HTTPHandler Objects<a class="headerlink" href="#httphandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPHandler.http_open">
HTTPHandler.http_open(req)<a class="headerlink" href="#urllib.request.HTTPHandler.http_open" title="Permalink to this definition">¶</a></dt>
<dd>Send an HTTP request, which can be either GET or POST, depending on
<code class="docutils literal notranslate">req.has_data()</code>.
</dd></dl>

</section>
<section id="httpshandler-objects">
<h2>HTTPSHandler Objects<a class="headerlink" href="#httpshandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPSHandler.https_open">
HTTPSHandler.https_open(req)<a class="headerlink" href="#urllib.request.HTTPSHandler.https_open" title="Permalink to this definition">¶</a></dt>
<dd>Send an HTTPS request, which can be either GET or POST, depending on
<code class="docutils literal notranslate">req.has_data()</code>.
</dd></dl>

</section>
<section id="filehandler-objects">
<h2>FileHandler Objects<a class="headerlink" href="#filehandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.FileHandler.file_open">
FileHandler.file_open(req)<a class="headerlink" href="#urllib.request.FileHandler.file_open" title="Permalink to this definition">¶</a></dt>
<dd>Open the file locally, if there is no host name, or the host name is
<code class="docutils literal notranslate">'localhost'</code>.
<div class="versionchanged">
Changed in version 3.2: This method is applicable only for local hostnames. When a remote
hostname is given, an <a class="reference internal" href="urllib.error.html#urllib.error.URLError" title="urllib.error.URLError"><code class="xref py py-exc docutils literal notranslate">URLError</code></a> is raised.
</div>
</dd></dl>

</section>
<section id="datahandler-objects">
<h2>DataHandler Objects<a class="headerlink" href="#datahandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.DataHandler.data_open">
DataHandler.data_open(req)<a class="headerlink" href="#urllib.request.DataHandler.data_open" title="Permalink to this definition">¶</a></dt>
<dd>Read a data URL. This kind of URL contains the content encoded in the URL
itself. The data URL syntax is specified in <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2397.html">RFC 2397</a>. This implementation
ignores white spaces in base64 encoded data URLs so the URL may be wrapped
in whatever source file it comes from. But even though some browsers don’t
mind about a missing padding at the end of a base64 encoded data URL, this
implementation will raise an <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> in that case.
</dd></dl>

</section>
<section id="ftphandler-objects">
<h2>FTPHandler Objects<a class="headerlink" href="#ftphandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.FTPHandler.ftp_open">
FTPHandler.ftp_open(req)<a class="headerlink" href="#urllib.request.FTPHandler.ftp_open" title="Permalink to this definition">¶</a></dt>
<dd>Open the FTP file indicated by req. The login is always done with empty
username and password.
</dd></dl>

</section>
<section id="cacheftphandler-objects">
<h2>CacheFTPHandler Objects<a class="headerlink" href="#cacheftphandler-objects" title="Permalink to this headline">¶</a></h2>
<a class="reference internal" href="#urllib.request.CacheFTPHandler" title="urllib.request.CacheFTPHandler"><code class="xref py py-class docutils literal notranslate">CacheFTPHandler</code></a> objects are <a class="reference internal" href="#urllib.request.FTPHandler" title="urllib.request.FTPHandler"><code class="xref py py-class docutils literal notranslate">FTPHandler</code></a> objects with the
following additional methods:
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.CacheFTPHandler.setTimeout">
CacheFTPHandler.setTimeout(t)<a class="headerlink" href="#urllib.request.CacheFTPHandler.setTimeout" title="Permalink to this definition">¶</a></dt>
<dd>Set timeout of connections to t seconds.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.CacheFTPHandler.setMaxConns">
CacheFTPHandler.setMaxConns(m)<a class="headerlink" href="#urllib.request.CacheFTPHandler.setMaxConns" title="Permalink to this definition">¶</a></dt>
<dd>Set maximum number of cached connections to m.
</dd></dl>

</section>
<section id="unknownhandler-objects">
<h2>UnknownHandler Objects<a class="headerlink" href="#unknownhandler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.UnknownHandler.unknown_open">
UnknownHandler.unknown_open()<a class="headerlink" href="#urllib.request.UnknownHandler.unknown_open" title="Permalink to this definition">¶</a></dt>
<dd>Raise a <a class="reference internal" href="urllib.error.html#urllib.error.URLError" title="urllib.error.URLError"><code class="xref py py-exc docutils literal notranslate">URLError</code></a> exception.
</dd></dl>

</section>
<section id="httperrorprocessor-objects">
<h2>HTTPErrorProcessor Objects<a class="headerlink" href="#httperrorprocessor-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPErrorProcessor.http_response">
HTTPErrorProcessor.http_response(request, response)<a class="headerlink" href="#urllib.request.HTTPErrorProcessor.http_response" title="Permalink to this definition">¶</a></dt>
<dd>Process HTTP error responses.
For 200 error codes, the response object is returned immediately.
For non-200 error codes, this simply passes the job on to the
<code class="xref py py-meth docutils literal notranslate">http_error_&lt;type&gt;()</code> handler methods, via <a class="reference internal" href="#urllib.request.OpenerDirector.error" title="urllib.request.OpenerDirector.error"><code class="xref py py-meth docutils literal notranslate">OpenerDirector.error()</code></a>.
Eventually, <a class="reference internal" href="#urllib.request.HTTPDefaultErrorHandler" title="urllib.request.HTTPDefaultErrorHandler"><code class="xref py py-class docutils literal notranslate">HTTPDefaultErrorHandler</code></a> will raise an
<a class="reference internal" href="urllib.error.html#urllib.error.HTTPError" title="urllib.error.HTTPError"><code class="xref py py-exc docutils literal notranslate">HTTPError</code></a> if no other handler handles the error.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.HTTPErrorProcessor.https_response">
HTTPErrorProcessor.https_response(request, response)<a class="headerlink" href="#urllib.request.HTTPErrorProcessor.https_response" title="Permalink to this definition">¶</a></dt>
<dd>Process HTTPS error responses.
The behavior is same as <a class="reference internal" href="#urllib.request.HTTPErrorProcessor.http_response" title="urllib.request.HTTPErrorProcessor.http_response"><code class="xref py py-meth docutils literal notranslate">http_response()</code></a>.
</dd></dl>

</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
In addition to the examples below, more examples are given in
<a class="reference internal" href="../howto/urllib2.html#urllib-howto">HOWTO Fetch Internet Resources Using The urllib Package</a>.
This example gets the python.org main page and displays the first 300 bytes of
it.
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import urllib.request
&gt;&gt;&gt; with urllib.request.urlopen(&#39;http://www.python.org/&#39;) as f:
... print(f.read(300))
...
b&#39;&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot;
&quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd&quot;&gt;\n\n\n&lt;html
xmlns=&quot;http://www.w3.org/1999/xhtml&quot; xml:lang=&quot;en&quot; lang=&quot;en&quot;&gt;\n\n&lt;head&gt;\n
&lt;meta http-equiv=&quot;content-type&quot; content=&quot;text/html; charset=utf-8&quot; /&gt;\n
&lt;title&gt;Python Programming &#39;
</pre></div>
</div>
Note that urlopen returns a bytes object. This is because there is no way
for urlopen to automatically determine the encoding of the byte stream
it receives from the HTTP server. In general, a program will decode
the returned bytes object to string once it determines or guesses
the appropriate encoding.
The following W3C document, <a class="reference external" href="https://www.w3.org/International/O-charset">https://www.w3.org/International/O-charset</a>, lists
the various ways in which an (X)HTML or an XML document could have specified its
encoding information.
As the python.org website uses utf-8 encoding as specified in its meta tag, we
will use the same for decoding the bytes object.
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; with urllib.request.urlopen(&#39;http://www.python.org/&#39;) as f:
... print(f.read(100).decode(&#39;utf-8&#39;))
...
&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot;
&quot;http://www.w3.org/TR/xhtml1/DTD/xhtm
</pre></div>
</div>
It is also possible to achieve the same result without using the
<a class="reference internal" href="../glossary.html#term-context-manager">context manager</a> approach.
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import urllib.request
&gt;&gt;&gt; f = urllib.request.urlopen(&#39;http://www.python.org/&#39;)
&gt;&gt;&gt; print(f.read(100).decode(&#39;utf-8&#39;))
&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot;
&quot;http://www.w3.org/TR/xhtml1/DTD/xhtm
</pre></div>
</div>
In the following example, we are sending a data-stream to the stdin of a CGI
and reading the data it returns to us. Note that this example will only work
when the Python installation supports SSL.
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import urllib.request
&gt;&gt;&gt; req = urllib.request.Request(url=&#39;https://localhost/cgi-bin/test.cgi&#39;,
... data=b&#39;This data is passed to stdin of the CGI&#39;)
&gt;&gt;&gt; with urllib.request.urlopen(req) as f:
... print(f.read().decode(&#39;utf-8&#39;))
...
Got Data: &quot;This data is passed to stdin of the CGI&quot;
</pre></div>
</div>
The code for the sample CGI used in the above example is:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>#!/usr/bin/env python
import sys
data = sys.stdin.read()
print(&#39;Content-type: text/plain\n\nGot Data: &quot;%s&quot;&#39; % data)
</pre></div>
</div>
Here is an example of doing a <code class="docutils literal notranslate">PUT</code> request using <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import urllib.request
DATA = b&#39;some data&#39;
req = urllib.request.Request(url=&#39;http://localhost:8080&#39;, data=DATA, method=&#39;PUT&#39;)
with urllib.request.urlopen(req) as f:
 pass
print(f.status)
print(f.reason)
</pre></div>
</div>
Use of Basic HTTP Authentication:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import urllib.request
# Create an OpenerDirector with support for Basic HTTP Authentication...
auth_handler = urllib.request.HTTPBasicAuthHandler()
auth_handler.add_password(realm=&#39;PDQ Application&#39;,
 uri=&#39;https://mahler:8092/site-updates.py&#39;,
 user=&#39;klem&#39;,
 passwd=&#39;kadidd!ehopper&#39;)
opener = urllib.request.build_opener(auth_handler)
# ...and install it globally so it can be used with urlopen.
urllib.request.install_opener(opener)
urllib.request.urlopen(&#39;http://www.example.com/login.html&#39;)
</pre></div>
</div>
<a class="reference internal" href="#urllib.request.build_opener" title="urllib.request.build_opener"><code class="xref py py-func docutils literal notranslate">build_opener()</code></a> provides many handlers by default, including a
<a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><code class="xref py py-class docutils literal notranslate">ProxyHandler</code></a>. By default, <a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><code class="xref py py-class docutils literal notranslate">ProxyHandler</code></a> uses the environment
variables named <code class="docutils literal notranslate">&lt;scheme&gt;_proxy</code>, where <code class="docutils literal notranslate">&lt;scheme&gt;</code> is the URL scheme
involved. For example, the <code class="xref std std-envvar docutils literal notranslate">http_proxy</code> environment variable is read to
obtain the HTTP proxy’s URL.
This example replaces the default <a class="reference internal" href="#urllib.request.ProxyHandler" title="urllib.request.ProxyHandler"><code class="xref py py-class docutils literal notranslate">ProxyHandler</code></a> with one that uses
programmatically supplied proxy URLs, and adds proxy authorization support with
<a class="reference internal" href="#urllib.request.ProxyBasicAuthHandler" title="urllib.request.ProxyBasicAuthHandler"><code class="xref py py-class docutils literal notranslate">ProxyBasicAuthHandler</code></a>.
<div class="highlight-python3 notranslate"><div class="highlight"><pre>proxy_handler = urllib.request.ProxyHandler({&#39;http&#39;: &#39;http://www.example.com:3128/&#39;})
proxy_auth_handler = urllib.request.ProxyBasicAuthHandler()
proxy_auth_handler.add_password(&#39;realm&#39;, &#39;host&#39;, &#39;username&#39;, &#39;password&#39;)

opener = urllib.request.build_opener(proxy_handler, proxy_auth_handler)
# This time, rather than install the OpenerDirector, we use it directly:
opener.open(&#39;http://www.example.com/login.html&#39;)
</pre></div>
</div>
Adding HTTP headers:
Use the headers argument to the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> constructor, or:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import urllib.request
req = urllib.request.Request(&#39;http://www.example.com/&#39;)
req.add_header(&#39;Referer&#39;, &#39;http://www.python.org/&#39;)
# Customize the default User-Agent header value:
req.add_header(&#39;User-Agent&#39;, &#39;urllib-example/0.1 (Contact: . . .)&#39;)
r = urllib.request.urlopen(req)
</pre></div>
</div>
<a class="reference internal" href="#urllib.request.OpenerDirector" title="urllib.request.OpenerDirector"><code class="xref py py-class docutils literal notranslate">OpenerDirector</code></a> automatically adds a User-Agent header to
every <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a>. To change this:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import urllib.request
opener = urllib.request.build_opener()
opener.addheaders = [(&#39;User-agent&#39;, &#39;Mozilla/5.0&#39;)]
opener.open(&#39;http://www.example.com/&#39;)
</pre></div>
</div>
Also, remember that a few standard headers (Content-Length,
Content-Type and Host)
are added when the <a class="reference internal" href="#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">Request</code></a> is passed to <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a> (or
<a class="reference internal" href="#urllib.request.OpenerDirector.open" title="urllib.request.OpenerDirector.open"><code class="xref py py-meth docutils literal notranslate">OpenerDirector.open()</code></a>).
Here is an example session that uses the <code class="docutils literal notranslate">GET</code> method to retrieve a URL
containing parameters:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import urllib.request
&gt;&gt;&gt; import urllib.parse
&gt;&gt;&gt; params = urllib.parse.urlencode({&#39;spam&#39;: 1, &#39;eggs&#39;: 2, &#39;bacon&#39;: 0})
&gt;&gt;&gt; url = &quot;http://www.musi-cal.com/cgi-bin/query?%s&quot; % params
&gt;&gt;&gt; with urllib.request.urlopen(url) as f:
... print(f.read().decode(&#39;utf-8&#39;))
...
</pre></div>
</div>
The following example uses the <code class="docutils literal notranslate">POST</code> method instead. Note that params output
from urlencode is encoded to bytes before it is sent to urlopen as data:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import urllib.request
&gt;&gt;&gt; import urllib.parse
&gt;&gt;&gt; data = urllib.parse.urlencode({&#39;spam&#39;: 1, &#39;eggs&#39;: 2, &#39;bacon&#39;: 0})
&gt;&gt;&gt; data = data.encode(&#39;ascii&#39;)
&gt;&gt;&gt; with urllib.request.urlopen(&quot;http://requestb.in/xrbl82xr&quot;, data) as f:
... print(f.read().decode(&#39;utf-8&#39;))
...
</pre></div>
</div>
The following example uses an explicitly specified HTTP proxy, overriding
environment settings:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import urllib.request
&gt;&gt;&gt; proxies = {&#39;http&#39;: &#39;http://proxy.example.com:8080/&#39;}
&gt;&gt;&gt; opener = urllib.request.FancyURLopener(proxies)
&gt;&gt;&gt; with opener.open(&quot;http://www.python.org&quot;) as f:
... f.read().decode(&#39;utf-8&#39;)
...
</pre></div>
</div>
The following example uses no proxies at all, overriding environment settings:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import urllib.request
&gt;&gt;&gt; opener = urllib.request.FancyURLopener({})
&gt;&gt;&gt; with opener.open(&quot;http://www.python.org/&quot;) as f:
... f.read().decode(&#39;utf-8&#39;)
...
</pre></div>
</div>
</section>
<section id="legacy-interface">
<h2>Legacy interface<a class="headerlink" href="#legacy-interface" title="Permalink to this headline">¶</a></h2>
The following functions and classes are ported from the Python 2 module
<code class="docutils literal notranslate">urllib</code> (as opposed to <code class="docutils literal notranslate">urllib2</code>). They might become deprecated at
some point in the future.
<dl class="py function">
<dt class="sig sig-object py" id="urllib.request.urlretrieve">
urllib.request.urlretrieve(url, filename=None, reporthook=None, data=None)<a class="headerlink" href="#urllib.request.urlretrieve" title="Permalink to this definition">¶</a></dt>
<dd>Copy a network object denoted by a URL to a local file. If the URL
points to a local file, the object will not be copied unless filename is supplied.
Return a tuple <code class="docutils literal notranslate">(filename, headers)</code> where filename is the
local file name under which the object can be found, and headers is whatever
the <code class="xref py py-meth docutils literal notranslate">info()</code> method of the object returned by <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a> returned (for
a remote object). Exceptions are the same as for <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a>.
The second argument, if present, specifies the file location to copy to (if
absent, the location will be a tempfile with a generated name). The third
argument, if present, is a callable that will be called once on
establishment of the network connection and once after each block read
thereafter. The callable will be passed three arguments; a count of blocks
transferred so far, a block size in bytes, and the total size of the file. The
third argument may be <code class="docutils literal notranslate">-1</code> on older FTP servers which do not return a file
size in response to a retrieval request.
The following example illustrates the most common usage scenario:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import urllib.request
&gt;&gt;&gt; local_filename, headers = urllib.request.urlretrieve(&#39;http://python.org/&#39;)
&gt;&gt;&gt; html = open(local_filename)
&gt;&gt;&gt; html.close()
</pre></div>
</div>
If the url uses the <code class="file docutils literal notranslate">http:</code> scheme identifier, the optional data
argument may be given to specify a <code class="docutils literal notranslate">POST</code> request (normally the request
type is <code class="docutils literal notranslate">GET</code>). The data argument must be a bytes object in standard
application/x-www-form-urlencoded format; see the
<a class="reference internal" href="urllib.parse.html#urllib.parse.urlencode" title="urllib.parse.urlencode"><code class="xref py py-func docutils literal notranslate">urllib.parse.urlencode()</code></a> function.
<a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><code class="xref py py-func docutils literal notranslate">urlretrieve()</code></a> will raise <code class="xref py py-exc docutils literal notranslate">ContentTooShortError</code> when it detects that
the amount of data available was less than the expected amount (which is the
size reported by a Content-Length header). This can occur, for example, when
the download is interrupted.
The Content-Length is treated as a lower bound: if there’s more data to read,
urlretrieve reads more data, but if less data is available, it raises the
exception.
You can still retrieve the downloaded data in this case, it is stored in the
<code class="xref py py-attr docutils literal notranslate">content</code> attribute of the exception instance.
If no Content-Length header was supplied, urlretrieve can not check the size
of the data it has downloaded, and just returns it. In this case you just have
to assume that the download was successful.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="urllib.request.urlcleanup">
urllib.request.urlcleanup()<a class="headerlink" href="#urllib.request.urlcleanup" title="Permalink to this definition">¶</a></dt>
<dd>Cleans up temporary files that may have been left behind by previous
calls to <a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><code class="xref py py-func docutils literal notranslate">urlretrieve()</code></a>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.URLopener">
class urllib.request.URLopener(proxies=None, **x509)<a class="headerlink" href="#urllib.request.URLopener" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 3.3.
</div>
Base class for opening and reading URLs. Unless you need to support opening
objects using schemes other than <code class="file docutils literal notranslate">http:</code>, <code class="file docutils literal notranslate">ftp:</code>, or <code class="file docutils literal notranslate">file:</code>,
you probably want to use <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><code class="xref py py-class docutils literal notranslate">FancyURLopener</code></a>.
By default, the <a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><code class="xref py py-class docutils literal notranslate">URLopener</code></a> class sends a User-Agent header
of <code class="docutils literal notranslate">urllib/VVV</code>, where VVV is the <a class="reference internal" href="urllib.html#module-urllib" title="urllib"><code class="xref py py-mod docutils literal notranslate">urllib</code></a> version number.
Applications can define their own User-Agent header by subclassing
<a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><code class="xref py py-class docutils literal notranslate">URLopener</code></a> or <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><code class="xref py py-class docutils literal notranslate">FancyURLopener</code></a> and setting the class attribute
<a class="reference internal" href="#urllib.request.URLopener.version" title="urllib.request.URLopener.version"><code class="xref py py-attr docutils literal notranslate">version</code></a> to an appropriate string value in the subclass definition.
The optional proxies parameter should be a dictionary mapping scheme names to
proxy URLs, where an empty dictionary turns proxies off completely. Its default
value is <code class="docutils literal notranslate">None</code>, in which case environmental proxy settings will be used if
present, as discussed in the definition of <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a>, above.
Additional keyword parameters, collected in x509, may be used for
authentication of the client when using the <code class="file docutils literal notranslate">https:</code> scheme. The keywords
key_file and cert_file are supported to provide an SSL key and certificate;
both are needed to support client authentication.
<a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><code class="xref py py-class docutils literal notranslate">URLopener</code></a> objects will raise an <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> exception if the server
returns an error code.
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.URLopener.open">
open(fullurl, data=None)<a class="headerlink" href="#urllib.request.URLopener.open" title="Permalink to this definition">¶</a></dt>
<dd>Open fullurl using the appropriate protocol. This method sets up cache and
proxy information, then calls the appropriate open method with its input
arguments. If the scheme is not recognized, <a class="reference internal" href="#urllib.request.URLopener.open_unknown" title="urllib.request.URLopener.open_unknown"><code class="xref py py-meth docutils literal notranslate">open_unknown()</code></a> is called.
The data argument has the same meaning as the data argument of
<a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a>.
This method always quotes fullurl using <a class="reference internal" href="urllib.parse.html#urllib.parse.quote" title="urllib.parse.quote"><code class="xref py py-func docutils literal notranslate">quote()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.URLopener.open_unknown">
open_unknown(fullurl, data=None)<a class="headerlink" href="#urllib.request.URLopener.open_unknown" title="Permalink to this definition">¶</a></dt>
<dd>Overridable interface to open unknown URL types.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.URLopener.retrieve">
retrieve(url, filename=None, reporthook=None, data=None)<a class="headerlink" href="#urllib.request.URLopener.retrieve" title="Permalink to this definition">¶</a></dt>
<dd>Retrieves the contents of url and places it in filename. The return value
is a tuple consisting of a local filename and either an
<a class="reference internal" href="email.compat32-message.html#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">email.message.Message</code></a> object containing the response headers (for remote
URLs) or <code class="docutils literal notranslate">None</code> (for local URLs). The caller must then open and read the
contents of filename. If filename is not given and the URL refers to a
local file, the input filename is returned. If the URL is non-local and
filename is not given, the filename is the output of <a class="reference internal" href="tempfile.html#tempfile.mktemp" title="tempfile.mktemp"><code class="xref py py-func docutils literal notranslate">tempfile.mktemp()</code></a>
with a suffix that matches the suffix of the last path component of the input
URL. If reporthook is given, it must be a function accepting three numeric
parameters: A chunk number, the maximum size chunks are read in and the total size of the download
(-1 if unknown). It will be called once at the start and after each chunk of data is read from the
network. reporthook is ignored for local URLs.
If the url uses the <code class="file docutils literal notranslate">http:</code> scheme identifier, the optional data
argument may be given to specify a <code class="docutils literal notranslate">POST</code> request (normally the request type
is <code class="docutils literal notranslate">GET</code>). The data argument must in standard
application/x-www-form-urlencoded format; see the
<a class="reference internal" href="urllib.parse.html#urllib.parse.urlencode" title="urllib.parse.urlencode"><code class="xref py py-func docutils literal notranslate">urllib.parse.urlencode()</code></a> function.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.request.URLopener.version">
version<a class="headerlink" href="#urllib.request.URLopener.version" title="Permalink to this definition">¶</a></dt>
<dd>Variable that specifies the user agent of the opener object. To get
<a class="reference internal" href="urllib.html#module-urllib" title="urllib"><code class="xref py py-mod docutils literal notranslate">urllib</code></a> to tell servers that it is a particular user agent, set this in a
subclass as a class variable or in the constructor before calling the base
constructor.
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="urllib.request.FancyURLopener">
class urllib.request.FancyURLopener(...)<a class="headerlink" href="#urllib.request.FancyURLopener" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 3.3.
</div>
<a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><code class="xref py py-class docutils literal notranslate">FancyURLopener</code></a> subclasses <a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><code class="xref py py-class docutils literal notranslate">URLopener</code></a> providing default handling
for the following HTTP response codes: 301, 302, 303, 307 and 401. For the 30x
response codes listed above, the Location header is used to fetch
the actual URL. For 401 response codes (authentication required), basic HTTP
authentication is performed. For the 30x response codes, recursion is bounded
by the value of the maxtries attribute, which defaults to 10.
For all other response codes, the method <code class="xref py py-meth docutils literal notranslate">http_error_default()</code> is called
which you can override in subclasses to handle the error appropriately.
<div class="admonition note">
Note
According to the letter of <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2616.html">RFC 2616</a>, 301 and 302 responses to POST requests
must not be automatically redirected without confirmation by the user. In
reality, browsers do allow automatic redirection of these responses, changing
the POST to a GET, and <a class="reference internal" href="urllib.html#module-urllib" title="urllib"><code class="xref py py-mod docutils literal notranslate">urllib</code></a> reproduces this behaviour.
</div>
The parameters to the constructor are the same as those for <a class="reference internal" href="#urllib.request.URLopener" title="urllib.request.URLopener"><code class="xref py py-class docutils literal notranslate">URLopener</code></a>.
<div class="admonition note">
Note
When performing basic authentication, a <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><code class="xref py py-class docutils literal notranslate">FancyURLopener</code></a> instance calls
its <a class="reference internal" href="#urllib.request.FancyURLopener.prompt_user_passwd" title="urllib.request.FancyURLopener.prompt_user_passwd"><code class="xref py py-meth docutils literal notranslate">prompt_user_passwd()</code></a> method. The default implementation asks the
users for the required information on the controlling terminal. A subclass may
override this method to support more appropriate behavior if needed.
</div>
The <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><code class="xref py py-class docutils literal notranslate">FancyURLopener</code></a> class offers one additional method that should be
overloaded to provide the appropriate behavior:
<dl class="py method">
<dt class="sig sig-object py" id="urllib.request.FancyURLopener.prompt_user_passwd">
prompt_user_passwd(host, realm)<a class="headerlink" href="#urllib.request.FancyURLopener.prompt_user_passwd" title="Permalink to this definition">¶</a></dt>
<dd>Return information needed to authenticate the user at the given host in the
specified security realm. The return value should be a tuple, <code class="docutils literal notranslate">(user,
password)</code>, which can be used for basic authentication.
The implementation prompts for this information on the terminal; an application
should override this method to use an appropriate interaction model in the local
environment.
</dd></dl>

</dd></dl>

</section>
<section id="urllib-request-restrictions">
<h2><a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate">urllib.request</code></a> Restrictions<a class="headerlink" href="#urllib-request-restrictions" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div></div></blockquote>
<ul id="index-11">
<li>Currently, only the following protocols are supported: HTTP (versions 0.9 and
1.0), FTP, local files, and data URLs.
<div class="versionchanged">
Changed in version 3.4: Added support for data URLs.
</div>
</li>
<li>The caching feature of <a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><code class="xref py py-func docutils literal notranslate">urlretrieve()</code></a> has been disabled until someone
finds the time to hack proper processing of Expiration time headers.</li>
<li>There should be a function to query whether a particular URL is in the cache.</li>
<li>For backward compatibility, if a URL appears to point to a local file but the
file can’t be opened, the URL is re-interpreted using the FTP protocol. This
can sometimes cause confusing error messages.</li>
<li>The <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a> and <a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><code class="xref py py-func docutils literal notranslate">urlretrieve()</code></a> functions can cause arbitrarily
long delays while waiting for a network connection to be set up. This means
that it is difficult to build an interactive web client using these functions
without using threads.
</li>
<li id="index-12">The data returned by <a class="reference internal" href="#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate">urlopen()</code></a> or <a class="reference internal" href="#urllib.request.urlretrieve" title="urllib.request.urlretrieve"><code class="xref py py-func docutils literal notranslate">urlretrieve()</code></a> is the raw data
returned by the server. This may be binary data (such as an image), plain text
or (for example) HTML. The HTTP protocol provides type information in the reply
header, which can be inspected by looking at the Content-Type
header. If the returned data is HTML, you can use the module
<a class="reference internal" href="html.parser.html#module-html.parser" title="html.parser: A simple parser that can handle HTML and XHTML."><code class="xref py py-mod docutils literal notranslate">html.parser</code></a> to parse it.
</li>
<li id="index-13">The code handling the FTP protocol cannot differentiate between a file and a
directory. This can lead to unexpected behavior when attempting to read a URL
that points to a file that is not accessible. If the URL ends in a <code class="docutils literal notranslate">/</code>, it is
assumed to refer to a directory and will be handled accordingly. But if an
attempt to read a file leads to a 550 error (meaning the URL cannot be found or
is not accessible, often for permission reasons), then the path is treated as a
directory in order to handle the case when a directory is specified by a URL but
the trailing <code class="docutils literal notranslate">/</code> has been left off. This can cause misleading results when
you try to fetch a file whose read permissions make it inaccessible; the FTP
code will try to read it, fail with a 550 error, and then perform a directory
listing for the unreadable file. If fine-grained control is needed, consider
using the <a class="reference internal" href="ftplib.html#module-ftplib" title="ftplib: FTP protocol client (requires sockets)."><code class="xref py py-mod docutils literal notranslate">ftplib</code></a> module, subclassing <a class="reference internal" href="#urllib.request.FancyURLopener" title="urllib.request.FancyURLopener"><code class="xref py py-class docutils literal notranslate">FancyURLopener</code></a>, or changing
_urlopener to meet your needs.</li>
</ul>
</section>
</section>
<section id="module-urllib.response">
<h1><a class="reference internal" href="#module-urllib.response" title="urllib.response: Response classes used by urllib."><code class="xref py py-mod docutils literal notranslate">urllib.response</code></a> — Response classes used by urllib<a class="headerlink" href="#module-urllib.response" title="Permalink to this headline">¶</a></h1>
The <a class="reference internal" href="#module-urllib.response" title="urllib.response: Response classes used by urllib."><code class="xref py py-mod docutils literal notranslate">urllib.response</code></a> module defines functions and classes which define a
minimal file-like interface, including <code class="docutils literal notranslate">read()</code> and <code class="docutils literal notranslate">readline()</code>.
Functions defined by this module are used internally by the <a class="reference internal" href="#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate">urllib.request</code></a> module.
The typical response object is a <a class="reference internal" href="#urllib.response.addinfourl" title="urllib.response.addinfourl"><code class="xref py py-class docutils literal notranslate">urllib.response.addinfourl</code></a> instance:
<dl class="py class">
<dt class="sig sig-object py" id="urllib.response.addinfourl">
class urllib.response.addinfourl<a class="headerlink" href="#urllib.response.addinfourl" title="Permalink to this definition">¶</a></dt>
<dd><dl class="py attribute">
<dt class="sig sig-object py" id="urllib.response.addinfourl.url">
url<a class="headerlink" href="#urllib.response.addinfourl.url" title="Permalink to this definition">¶</a></dt>
<dd>URL of the resource retrieved, commonly used to determine if a redirect was followed.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.response.addinfourl.headers">
headers<a class="headerlink" href="#urllib.response.addinfourl.headers" title="Permalink to this definition">¶</a></dt>
<dd>Returns the headers of the response in the form of an <a class="reference internal" href="email.message.html#email.message.EmailMessage" title="email.message.EmailMessage"><code class="xref py py-class docutils literal notranslate">EmailMessage</code></a> instance.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.response.addinfourl.status">
status<a class="headerlink" href="#urllib.response.addinfourl.status" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.9.
</div>
Status code returned by server.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.response.addinfourl.geturl">
geturl()<a class="headerlink" href="#urllib.response.addinfourl.geturl" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 3.9: Deprecated in favor of <a class="reference internal" href="#urllib.response.addinfourl.url" title="urllib.response.addinfourl.url"><code class="xref py py-attr docutils literal notranslate">url</code></a>.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.response.addinfourl.info">
info()<a class="headerlink" href="#urllib.response.addinfourl.info" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 3.9: Deprecated in favor of <a class="reference internal" href="#urllib.response.addinfourl.headers" title="urllib.response.addinfourl.headers"><code class="xref py py-attr docutils literal notranslate">headers</code></a>.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="urllib.response.addinfourl.code">
code<a class="headerlink" href="#urllib.response.addinfourl.code" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 3.9: Deprecated in favor of <a class="reference internal" href="#urllib.response.addinfourl.status" title="urllib.response.addinfourl.status"><code class="xref py py-attr docutils literal notranslate">status</code></a>.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="urllib.response.addinfourl.getcode">
getcode()<a class="headerlink" href="#urllib.response.addinfourl.getcode" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 3.9: Deprecated in favor of <a class="reference internal" href="#urllib.response.addinfourl.status" title="urllib.response.addinfourl.status"><code class="xref py py-attr docutils literal notranslate">status</code></a>.
</div>
</dd></dl>

</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">urllib.request</code> — Extensible library for opening URLs</a><ul>
<li><a class="reference internal" href="#request-objects">Request Objects</a></li>
<li><a class="reference internal" href="#openerdirector-objects">OpenerDirector Objects</a></li>
<li><a class="reference internal" href="#basehandler-objects">BaseHandler Objects</a></li>
<li><a class="reference internal" href="#httpredirecthandler-objects">HTTPRedirectHandler Objects</a></li>
<li><a class="reference internal" href="#httpcookieprocessor-objects">HTTPCookieProcessor Objects</a></li>
<li><a class="reference internal" href="#proxyhandler-objects">ProxyHandler Objects</a></li>
<li><a class="reference internal" href="#httppasswordmgr-objects">HTTPPasswordMgr Objects</a></li>
<li><a class="reference internal" href="#httppasswordmgrwithpriorauth-objects">HTTPPasswordMgrWithPriorAuth Objects</a></li>
<li><a class="reference internal" href="#abstractbasicauthhandler-objects">AbstractBasicAuthHandler Objects</a></li>
<li><a class="reference internal" href="#httpbasicauthhandler-objects">HTTPBasicAuthHandler Objects</a></li>
<li><a class="reference internal" href="#proxybasicauthhandler-objects">ProxyBasicAuthHandler Objects</a></li>
<li><a class="reference internal" href="#abstractdigestauthhandler-objects">AbstractDigestAuthHandler Objects</a></li>
<li><a class="reference internal" href="#httpdigestauthhandler-objects">HTTPDigestAuthHandler Objects</a></li>
<li><a class="reference internal" href="#proxydigestauthhandler-objects">ProxyDigestAuthHandler Objects</a></li>
<li><a class="reference internal" href="#httphandler-objects">HTTPHandler Objects</a></li>
<li><a class="reference internal" href="#httpshandler-objects">HTTPSHandler Objects</a></li>
<li><a class="reference internal" href="#filehandler-objects">FileHandler Objects</a></li>
<li><a class="reference internal" href="#datahandler-objects">DataHandler Objects</a></li>
<li><a class="reference internal" href="#ftphandler-objects">FTPHandler Objects</a></li>
<li><a class="reference internal" href="#cacheftphandler-objects">CacheFTPHandler Objects</a></li>
<li><a class="reference internal" href="#unknownhandler-objects">UnknownHandler Objects</a></li>
<li><a class="reference internal" href="#httperrorprocessor-objects">HTTPErrorProcessor Objects</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#legacy-interface">Legacy interface</a></li>
<li><a class="reference internal" href="#urllib-request-restrictions"><code class="xref py py-mod docutils literal notranslate">urllib.request</code> Restrictions</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-urllib.response"><code class="xref py py-mod docutils literal notranslate">urllib.response</code> — Response classes used by urllib</a></li>
</ul>

<h4>Previous topic</h4>
 <a href="urllib.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">urllib</code> — URL handling modules</a>
 <h4>Next topic</h4>
 <a href="urllib.parse.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">urllib.parse</code> — Parse URLs into components</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/library/urllib.request.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="urllib.parse.html" title="urllib.parse — Parse URLs into components"
 >next</a> |</li>
 <li class="right" >
 <a href="urllib.html" title="urllib — URL handling modules"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" >Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">urllib.request</code> — Extensible library for opening URLs</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" 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>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : urllib.request.html