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 : http.cookiejar.html

<!DOCTYPE html>

<title>http.cookiejar — Cookie handling for HTTP clients &#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="xmlrpc — XMLRPC server and client modules" href="xmlrpc.html" />
 <link rel="prev" title="http.cookies — HTTP state management" href="http.cookies.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/http.cookiejar.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">http.cookiejar</code> — Cookie handling for HTTP clients</a><ul>
<li><a class="reference internal" href="#cookiejar-and-filecookiejar-objects">CookieJar and FileCookieJar Objects</a></li>
<li><a class="reference internal" href="#filecookiejar-subclasses-and-co-operation-with-web-browsers">FileCookieJar subclasses and co-operation with web browsers</a></li>
<li><a class="reference internal" href="#cookiepolicy-objects">CookiePolicy Objects</a></li>
<li><a class="reference internal" href="#defaultcookiepolicy-objects">DefaultCookiePolicy Objects</a></li>
<li><a class="reference internal" href="#cookie-objects">Cookie Objects</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</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="xmlrpc.html" title="xmlrpc — XMLRPC server and client modules"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="http.cookies.html" title="http.cookies — HTTP state management"
 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">http.cookiejar</code> — Cookie handling for HTTP clients</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-http.cookiejar">
<h1><a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a> — Cookie handling for HTTP clients<a class="headerlink" href="#module-http.cookiejar" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/http/cookiejar.py">Lib/http/cookiejar.py</a>
<hr class="docutils" />
The <a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a> module defines classes for automatic handling of HTTP
cookies. It is useful for accessing web sites that require small pieces of data
– cookies – to be set on the client machine by an HTTP response from a
web server, and then returned to the server in later HTTP requests.
Both the regular Netscape cookie protocol and the protocol defined by
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> are handled. RFC 2965 handling is switched off by default.
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2109.html">RFC 2109</a> cookies are parsed as Netscape cookies and subsequently treated
either as Netscape or RFC 2965 cookies according to the ‘policy’ in effect.
Note that the great majority of cookies on the internet are Netscape cookies.
<a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a> attempts to follow the de-facto Netscape cookie protocol (which
differs substantially from that set out in the original Netscape specification),
including taking note of the <code class="docutils literal notranslate">max-age</code> and <code class="docutils literal notranslate">port</code> cookie-attributes
introduced with RFC 2965.
<div class="admonition note">
Note
The various named parameters found in Set-Cookie and
Set-Cookie2 headers (eg. <code class="docutils literal notranslate">domain</code> and <code class="docutils literal notranslate">expires</code>) are
conventionally referred to as attributes. To distinguish them from
Python attributes, the documentation for this module uses the term
cookie-attribute instead.
</div>
The module defines the following exception:
<dl class="py exception">
<dt class="sig sig-object py" id="http.cookiejar.LoadError">
exception http.cookiejar.LoadError<a class="headerlink" href="#http.cookiejar.LoadError" title="Permalink to this definition">¶</a></dt>
<dd>Instances of <a class="reference internal" href="#http.cookiejar.FileCookieJar" title="http.cookiejar.FileCookieJar"><code class="xref py py-class docutils literal notranslate">FileCookieJar</code></a> raise this exception on failure to load
cookies from a file. <a class="reference internal" href="#http.cookiejar.LoadError" title="http.cookiejar.LoadError"><code class="xref py py-exc docutils literal notranslate">LoadError</code></a> is a subclass of <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a>.
<div class="versionchanged">
Changed in version 3.3: LoadError was made a subclass of <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> instead of
<a class="reference internal" href="exceptions.html#IOError" title="IOError"><code class="xref py py-exc docutils literal notranslate">IOError</code></a>.
</div>
</dd></dl>

The following classes are provided:
<dl class="py class">
<dt class="sig sig-object py" id="http.cookiejar.CookieJar">
class http.cookiejar.CookieJar(policy=None)<a class="headerlink" href="#http.cookiejar.CookieJar" title="Permalink to this definition">¶</a></dt>
<dd>policy is an object implementing the <a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> interface.
The <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> class stores HTTP cookies. It extracts cookies from HTTP
requests, and returns them in HTTP responses. <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> instances
automatically expire contained cookies when necessary. Subclasses are also
responsible for storing and retrieving cookies from a file or database.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="http.cookiejar.FileCookieJar">
class http.cookiejar.FileCookieJar(filename=None, delayload=None, policy=None)<a class="headerlink" href="#http.cookiejar.FileCookieJar" title="Permalink to this definition">¶</a></dt>
<dd>policy is an object implementing the <a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> interface. For the
other arguments, see the documentation for the corresponding attributes.
A <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> which can load cookies from, and perhaps save cookies to, a
file on disk. Cookies are NOT loaded from the named file until either the
<a class="reference internal" href="#http.cookiejar.FileCookieJar.load" title="http.cookiejar.FileCookieJar.load"><code class="xref py py-meth docutils literal notranslate">load()</code></a> or <a class="reference internal" href="#http.cookiejar.FileCookieJar.revert" title="http.cookiejar.FileCookieJar.revert"><code class="xref py py-meth docutils literal notranslate">revert()</code></a> method is called. Subclasses of this class are
documented in section <a class="reference internal" href="#file-cookie-jar-classes">FileCookieJar subclasses and co-operation with web browsers</a>.
This should not be initialized directly – use its subclasses below instead.
<div class="versionchanged">
Changed in version 3.8: The filename parameter supports a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="http.cookiejar.CookiePolicy">
class http.cookiejar.CookiePolicy<a class="headerlink" href="#http.cookiejar.CookiePolicy" title="Permalink to this definition">¶</a></dt>
<dd>This class is responsible for deciding whether each cookie should be accepted
from / returned to the server.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy">
class http.cookiejar.DefaultCookiePolicy(blocked_domains=None, allowed_domains=None, netscape=True, rfc2965=False, rfc2109_as_netscape=None, hide_cookie2=False, strict_domain=False, strict_rfc2965_unverifiable=True, strict_ns_unverifiable=False, strict_ns_domain=DefaultCookiePolicy.DomainLiberal, strict_ns_set_initial_dollar=False, strict_ns_set_path=False, secure_protocols=('https', 'wss'))<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy" title="Permalink to this definition">¶</a></dt>
<dd>Constructor arguments should be passed as keyword arguments only.
blocked_domains is a sequence of domain names that we never accept cookies
from, nor return cookies to. allowed_domains if not <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>, this is a
sequence of the only domains for which we accept and return cookies.
secure_protocols is a sequence of protocols for which secure cookies can be
added to. By default https and wss (secure websocket) are considered
secure protocols. For all other arguments, see the documentation for
<a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> and <a class="reference internal" href="#http.cookiejar.DefaultCookiePolicy" title="http.cookiejar.DefaultCookiePolicy"><code class="xref py py-class docutils literal notranslate">DefaultCookiePolicy</code></a> objects.
<a class="reference internal" href="#http.cookiejar.DefaultCookiePolicy" title="http.cookiejar.DefaultCookiePolicy"><code class="xref py py-class docutils literal notranslate">DefaultCookiePolicy</code></a> implements the standard accept / reject rules for
Netscape and <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> cookies. By default, <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2109.html">RFC 2109</a> cookies (ie. cookies
received in a Set-Cookie header with a version cookie-attribute of
1) are treated according to the RFC 2965 rules. However, if RFC 2965 handling
is turned off or <a class="reference internal" href="#http.cookiejar.DefaultCookiePolicy.rfc2109_as_netscape" title="http.cookiejar.DefaultCookiePolicy.rfc2109_as_netscape"><code class="xref py py-attr docutils literal notranslate">rfc2109_as_netscape</code></a> is <code class="docutils literal notranslate">True</code>, RFC 2109 cookies are
‘downgraded’ by the <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> instance to Netscape cookies, by
setting the <code class="xref py py-attr docutils literal notranslate">version</code> attribute of the <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> instance to 0.
<a class="reference internal" href="#http.cookiejar.DefaultCookiePolicy" title="http.cookiejar.DefaultCookiePolicy"><code class="xref py py-class docutils literal notranslate">DefaultCookiePolicy</code></a> also provides some parameters to allow some
fine-tuning of policy.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="http.cookiejar.Cookie">
class http.cookiejar.Cookie<a class="headerlink" href="#http.cookiejar.Cookie" title="Permalink to this definition">¶</a></dt>
<dd>This class represents Netscape, <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2109.html">RFC 2109</a> and <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> cookies. It is not
expected that users of <a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a> construct their own <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a>
instances. Instead, if necessary, call <code class="xref py py-meth docutils literal notranslate">make_cookies()</code> on a
<a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> instance.
</dd></dl>

<div class="admonition seealso">
See also
<dl class="simple">
<dt>Module <a class="reference internal" href="urllib.request.html#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate">urllib.request</code></a></dt><dd>URL opening with automatic cookie handling.
</dd>
<dt>Module <a class="reference internal" href="http.cookies.html#module-http.cookies" title="http.cookies: Support for HTTP state management (cookies)."><code class="xref py py-mod docutils literal notranslate">http.cookies</code></a></dt><dd>HTTP cookie classes, principally useful for server-side code. The
<a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a> and <a class="reference internal" href="http.cookies.html#module-http.cookies" title="http.cookies: Support for HTTP state management (cookies)."><code class="xref py py-mod docutils literal notranslate">http.cookies</code></a> modules do not depend on each
other.
</dd>
<dt><a class="reference external" href="https://curl.se/rfc/cookie_spec.html">https://curl.se/rfc/cookie_spec.html</a></dt><dd>The specification of the original Netscape cookie protocol. Though this is
still the dominant protocol, the ‘Netscape cookie protocol’ implemented by all
the major browsers (and <a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a>) only bears a passing resemblance to
the one sketched out in <code class="docutils literal notranslate">cookie_spec.html</code>.
</dd>
<dt><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2109.html">RFC 2109</a> - HTTP State Management Mechanism</dt><dd>Obsoleted by <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a>. Uses Set-Cookie with version=1.
</dd>
<dt><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> - HTTP State Management Mechanism</dt><dd>The Netscape protocol with the bugs fixed. Uses Set-Cookie2 in
place of Set-Cookie. Not widely used.
</dd>
<dt><a class="reference external" href="http://kristol.org/cookie/errata.html">http://kristol.org/cookie/errata.html</a></dt><dd>Unfinished errata to <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a>.
</dd>
</dl>
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2964.html">RFC 2964</a> - Use of HTTP State Management
</div>
<section id="cookiejar-and-filecookiejar-objects">
<h2>CookieJar and FileCookieJar Objects<a class="headerlink" href="#cookiejar-and-filecookiejar-objects" title="Permalink to this headline">¶</a></h2>
<a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> objects support the <a class="reference internal" href="../glossary.html#term-iterator">iterator</a> protocol for iterating over
contained <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> objects.
<a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> has the following methods:
<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookieJar.add_cookie_header">
CookieJar.add_cookie_header(request)<a class="headerlink" href="#http.cookiejar.CookieJar.add_cookie_header" title="Permalink to this definition">¶</a></dt>
<dd>Add correct Cookie header to request.
If policy allows (ie. the <code class="xref py py-attr docutils literal notranslate">rfc2965</code> and <code class="xref py py-attr docutils literal notranslate">hide_cookie2</code> attributes of
the <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a>’s <a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> instance are true and false
respectively), the Cookie2 header is also added when appropriate.
The request object (usually a <a class="reference internal" href="urllib.request.html#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">urllib.request.Request</code></a> instance)
must support the methods <code class="xref py py-meth docutils literal notranslate">get_full_url()</code>, <code class="xref py py-meth docutils literal notranslate">has_header()</code>,
<code class="xref py py-meth docutils literal notranslate">get_header()</code>, <code class="xref py py-meth docutils literal notranslate">header_items()</code>, <code class="xref py py-meth docutils literal notranslate">add_unredirected_header()</code>
and the attributes <code class="xref py py-attr docutils literal notranslate">host</code>, <code class="xref py py-attr docutils literal notranslate">type</code>, <code class="xref py py-attr docutils literal notranslate">unverifiable</code>
and <code class="xref py py-attr docutils literal notranslate">origin_req_host</code> as documented by <a class="reference internal" href="urllib.request.html#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate">urllib.request</code></a>.
<div class="versionchanged">
Changed in version 3.3: request object needs <code class="xref py py-attr docutils literal notranslate">origin_req_host</code> attribute. Dependency on a
deprecated method <code class="xref py py-meth docutils literal notranslate">get_origin_req_host()</code> has been removed.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookieJar.extract_cookies">
CookieJar.extract_cookies(response, request)<a class="headerlink" href="#http.cookiejar.CookieJar.extract_cookies" title="Permalink to this definition">¶</a></dt>
<dd>Extract cookies from HTTP response and store them in the <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a>,
where allowed by policy.
The <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> will look for allowable Set-Cookie and
Set-Cookie2 headers in the response argument, and store cookies
as appropriate (subject to the <a class="reference internal" href="#http.cookiejar.CookiePolicy.set_ok" title="http.cookiejar.CookiePolicy.set_ok"><code class="xref py py-meth docutils literal notranslate">CookiePolicy.set_ok()</code></a> method’s approval).
The response object (usually the result of a call to
<a class="reference internal" href="urllib.request.html#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-meth docutils literal notranslate">urllib.request.urlopen()</code></a>, or similar) should support an <code class="xref py py-meth docutils literal notranslate">info()</code>
method, which returns 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> instance.
The request object (usually a <a class="reference internal" href="urllib.request.html#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate">urllib.request.Request</code></a> instance)
must support the method <code class="xref py py-meth docutils literal notranslate">get_full_url()</code> and the attributes
<code class="xref py py-attr docutils literal notranslate">host</code>, <code class="xref py py-attr docutils literal notranslate">unverifiable</code> and <code class="xref py py-attr docutils literal notranslate">origin_req_host</code>,
as documented by <a class="reference internal" href="urllib.request.html#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate">urllib.request</code></a>. The request is used to set
default values for cookie-attributes as well as for checking that the
cookie is allowed to be set.
<div class="versionchanged">
Changed in version 3.3: request object needs <code class="xref py py-attr docutils literal notranslate">origin_req_host</code> attribute. Dependency on a
deprecated method <code class="xref py py-meth docutils literal notranslate">get_origin_req_host()</code> has been removed.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookieJar.set_policy">
CookieJar.set_policy(policy)<a class="headerlink" href="#http.cookiejar.CookieJar.set_policy" title="Permalink to this definition">¶</a></dt>
<dd>Set the <a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> instance to be used.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookieJar.make_cookies">
CookieJar.make_cookies(response, request)<a class="headerlink" href="#http.cookiejar.CookieJar.make_cookies" title="Permalink to this definition">¶</a></dt>
<dd>Return sequence of <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> objects extracted from response object.
See the documentation for <a class="reference internal" href="#http.cookiejar.CookieJar.extract_cookies" title="http.cookiejar.CookieJar.extract_cookies"><code class="xref py py-meth docutils literal notranslate">extract_cookies()</code></a> for the interfaces required of
the response and request arguments.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookieJar.set_cookie_if_ok">
CookieJar.set_cookie_if_ok(cookie, request)<a class="headerlink" href="#http.cookiejar.CookieJar.set_cookie_if_ok" title="Permalink to this definition">¶</a></dt>
<dd>Set a <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> if policy says it’s OK to do so.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookieJar.set_cookie">
CookieJar.set_cookie(cookie)<a class="headerlink" href="#http.cookiejar.CookieJar.set_cookie" title="Permalink to this definition">¶</a></dt>
<dd>Set a <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a>, without checking with policy to see whether or not it
should be set.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookieJar.clear">
CookieJar.clear([domain[, path[, name]]])<a class="headerlink" href="#http.cookiejar.CookieJar.clear" title="Permalink to this definition">¶</a></dt>
<dd>Clear some cookies.
If invoked without arguments, clear all cookies. If given a single argument,
only cookies belonging to that domain will be removed. If given two arguments,
cookies belonging to the specified domain and URL path are removed. If
given three arguments, then the cookie with the specified domain, path and
name is removed.
Raises <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate">KeyError</code></a> if no matching cookie exists.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookieJar.clear_session_cookies">
CookieJar.clear_session_cookies()<a class="headerlink" href="#http.cookiejar.CookieJar.clear_session_cookies" title="Permalink to this definition">¶</a></dt>
<dd>Discard all session cookies.
Discards all contained cookies that have a true <code class="xref py py-attr docutils literal notranslate">discard</code> attribute
(usually because they had either no <code class="docutils literal notranslate">max-age</code> or <code class="docutils literal notranslate">expires</code> cookie-attribute,
or an explicit <code class="docutils literal notranslate">discard</code> cookie-attribute). For interactive browsers, the end
of a session usually corresponds to closing the browser window.
Note that the <code class="xref py py-meth docutils literal notranslate">save()</code> method won’t save session cookies anyway, unless you
ask otherwise by passing a true ignore_discard argument.
</dd></dl>

<a class="reference internal" href="#http.cookiejar.FileCookieJar" title="http.cookiejar.FileCookieJar"><code class="xref py py-class docutils literal notranslate">FileCookieJar</code></a> implements the following additional methods:
<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.FileCookieJar.save">
FileCookieJar.save(filename=None, ignore_discard=False, ignore_expires=False)<a class="headerlink" href="#http.cookiejar.FileCookieJar.save" title="Permalink to this definition">¶</a></dt>
<dd>Save cookies to a file.
This base class raises <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>. Subclasses may leave this
method unimplemented.
filename is the name of file in which to save cookies. If filename is not
specified, <code class="xref py py-attr docutils literal notranslate">self.filename</code> is used (whose default is the value passed to
the constructor, if any); if <code class="xref py py-attr docutils literal notranslate">self.filename</code> is <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>,
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised.
ignore_discard: save even cookies set to be discarded. ignore_expires: save
even cookies that have expired
The file is overwritten if it already exists, thus wiping all the cookies it
contains. Saved cookies can be restored later using the <a class="reference internal" href="#http.cookiejar.FileCookieJar.load" title="http.cookiejar.FileCookieJar.load"><code class="xref py py-meth docutils literal notranslate">load()</code></a> or
<a class="reference internal" href="#http.cookiejar.FileCookieJar.revert" title="http.cookiejar.FileCookieJar.revert"><code class="xref py py-meth docutils literal notranslate">revert()</code></a> methods.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.FileCookieJar.load">
FileCookieJar.load(filename=None, ignore_discard=False, ignore_expires=False)<a class="headerlink" href="#http.cookiejar.FileCookieJar.load" title="Permalink to this definition">¶</a></dt>
<dd>Load cookies from a file.
Old cookies are kept unless overwritten by newly loaded ones.
Arguments are as for <a class="reference internal" href="#http.cookiejar.FileCookieJar.save" title="http.cookiejar.FileCookieJar.save"><code class="xref py py-meth docutils literal notranslate">save()</code></a>.
The named file must be in the format understood by the class, or
<a class="reference internal" href="#http.cookiejar.LoadError" title="http.cookiejar.LoadError"><code class="xref py py-exc docutils literal notranslate">LoadError</code></a> will be raised. Also, <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> may be raised, for
example if the file does not exist.
<div class="versionchanged">
Changed in version 3.3: <a class="reference internal" href="exceptions.html#IOError" title="IOError"><code class="xref py py-exc docutils literal notranslate">IOError</code></a> used to be raised, it is now an alias of <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a>.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.FileCookieJar.revert">
FileCookieJar.revert(filename=None, ignore_discard=False, ignore_expires=False)<a class="headerlink" href="#http.cookiejar.FileCookieJar.revert" title="Permalink to this definition">¶</a></dt>
<dd>Clear all cookies and reload cookies from a saved file.
<a class="reference internal" href="#http.cookiejar.FileCookieJar.revert" title="http.cookiejar.FileCookieJar.revert"><code class="xref py py-meth docutils literal notranslate">revert()</code></a> can raise the same exceptions as <a class="reference internal" href="#http.cookiejar.FileCookieJar.load" title="http.cookiejar.FileCookieJar.load"><code class="xref py py-meth docutils literal notranslate">load()</code></a>. If there is a
failure, the object’s state will not be altered.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.FileCookieJar.delayload">
FileCookieJar.delayload<a class="headerlink" href="#http.cookiejar.FileCookieJar.delayload" title="Permalink to this definition">¶</a></dt>
<dd>If true, load cookies lazily from disk. This attribute should not be assigned
to. This is only a hint, since this only affects performance, not behaviour
(unless the cookies on disk are changing). A <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> object may
ignore it. None of the <a class="reference internal" href="#http.cookiejar.FileCookieJar" title="http.cookiejar.FileCookieJar"><code class="xref py py-class docutils literal notranslate">FileCookieJar</code></a> classes included in the standard
library lazily loads cookies.
</dd></dl>

</section>
<section id="filecookiejar-subclasses-and-co-operation-with-web-browsers">
<h2>FileCookieJar subclasses and co-operation with web browsers<a class="headerlink" href="#filecookiejar-subclasses-and-co-operation-with-web-browsers" title="Permalink to this headline">¶</a></h2>
The following <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> subclasses are provided for reading and
writing.
<dl class="py class">
<dt class="sig sig-object py" id="http.cookiejar.MozillaCookieJar">
class http.cookiejar.MozillaCookieJar(filename=None, delayload=None, policy=None)<a class="headerlink" href="#http.cookiejar.MozillaCookieJar" title="Permalink to this definition">¶</a></dt>
<dd>A <a class="reference internal" href="#http.cookiejar.FileCookieJar" title="http.cookiejar.FileCookieJar"><code class="xref py py-class docutils literal notranslate">FileCookieJar</code></a> that can load from and save cookies to disk in the
Mozilla <code class="docutils literal notranslate">cookies.txt</code> file format (which is also used by curl and the Lynx
and Netscape browsers).
<div class="admonition note">
Note
This loses information about <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> cookies, and also about newer or
non-standard cookie-attributes such as <code class="docutils literal notranslate">port</code>.
</div>
<div class="admonition warning">
Warning
Back up your cookies before saving if you have cookies whose loss / corruption
would be inconvenient (there are some subtleties which may lead to slight
changes in the file over a load / save round-trip).
</div>
Also note that cookies saved while Mozilla is running will get clobbered by
Mozilla.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="http.cookiejar.LWPCookieJar">
class http.cookiejar.LWPCookieJar(filename=None, delayload=None, policy=None)<a class="headerlink" href="#http.cookiejar.LWPCookieJar" title="Permalink to this definition">¶</a></dt>
<dd>A <a class="reference internal" href="#http.cookiejar.FileCookieJar" title="http.cookiejar.FileCookieJar"><code class="xref py py-class docutils literal notranslate">FileCookieJar</code></a> that can load from and save cookies to disk in format
compatible with the libwww-perl library’s <code class="docutils literal notranslate">Set-Cookie3</code> file format. This is
convenient if you want to store cookies in a human-readable file.
<div class="versionchanged">
Changed in version 3.8: The filename parameter supports a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
</dd></dl>

</section>
<section id="cookiepolicy-objects">
<h2>CookiePolicy Objects<a class="headerlink" href="#cookiepolicy-objects" title="Permalink to this headline">¶</a></h2>
Objects implementing the <a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> interface have the following
methods:
<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookiePolicy.set_ok">
CookiePolicy.set_ok(cookie, request)<a class="headerlink" href="#http.cookiejar.CookiePolicy.set_ok" title="Permalink to this definition">¶</a></dt>
<dd>Return boolean value indicating whether cookie should be accepted from server.
cookie is a <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> instance. request is an object
implementing the interface defined by the documentation for
<a class="reference internal" href="#http.cookiejar.CookieJar.extract_cookies" title="http.cookiejar.CookieJar.extract_cookies"><code class="xref py py-meth docutils literal notranslate">CookieJar.extract_cookies()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookiePolicy.return_ok">
CookiePolicy.return_ok(cookie, request)<a class="headerlink" href="#http.cookiejar.CookiePolicy.return_ok" title="Permalink to this definition">¶</a></dt>
<dd>Return boolean value indicating whether cookie should be returned to server.
cookie is a <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> instance. request is an object
implementing the interface defined by the documentation for
<a class="reference internal" href="#http.cookiejar.CookieJar.add_cookie_header" title="http.cookiejar.CookieJar.add_cookie_header"><code class="xref py py-meth docutils literal notranslate">CookieJar.add_cookie_header()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookiePolicy.domain_return_ok">
CookiePolicy.domain_return_ok(domain, request)<a class="headerlink" href="#http.cookiejar.CookiePolicy.domain_return_ok" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">False</code> if cookies should not be returned, given cookie domain.
This method is an optimization. It removes the need for checking every cookie
with a particular domain (which might involve reading many files). Returning
true from <a class="reference internal" href="#http.cookiejar.CookiePolicy.domain_return_ok" title="http.cookiejar.CookiePolicy.domain_return_ok"><code class="xref py py-meth docutils literal notranslate">domain_return_ok()</code></a> and <a class="reference internal" href="#http.cookiejar.CookiePolicy.path_return_ok" title="http.cookiejar.CookiePolicy.path_return_ok"><code class="xref py py-meth docutils literal notranslate">path_return_ok()</code></a> leaves all the
work to <a class="reference internal" href="#http.cookiejar.CookiePolicy.return_ok" title="http.cookiejar.CookiePolicy.return_ok"><code class="xref py py-meth docutils literal notranslate">return_ok()</code></a>.
If <a class="reference internal" href="#http.cookiejar.CookiePolicy.domain_return_ok" title="http.cookiejar.CookiePolicy.domain_return_ok"><code class="xref py py-meth docutils literal notranslate">domain_return_ok()</code></a> returns true for the cookie domain,
<a class="reference internal" href="#http.cookiejar.CookiePolicy.path_return_ok" title="http.cookiejar.CookiePolicy.path_return_ok"><code class="xref py py-meth docutils literal notranslate">path_return_ok()</code></a> is called for the cookie path. Otherwise,
<a class="reference internal" href="#http.cookiejar.CookiePolicy.path_return_ok" title="http.cookiejar.CookiePolicy.path_return_ok"><code class="xref py py-meth docutils literal notranslate">path_return_ok()</code></a> and <a class="reference internal" href="#http.cookiejar.CookiePolicy.return_ok" title="http.cookiejar.CookiePolicy.return_ok"><code class="xref py py-meth docutils literal notranslate">return_ok()</code></a> are never called for that cookie
domain. If <a class="reference internal" href="#http.cookiejar.CookiePolicy.path_return_ok" title="http.cookiejar.CookiePolicy.path_return_ok"><code class="xref py py-meth docutils literal notranslate">path_return_ok()</code></a> returns true, <a class="reference internal" href="#http.cookiejar.CookiePolicy.return_ok" title="http.cookiejar.CookiePolicy.return_ok"><code class="xref py py-meth docutils literal notranslate">return_ok()</code></a> is called
with the <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> object itself for a full check. Otherwise,
<a class="reference internal" href="#http.cookiejar.CookiePolicy.return_ok" title="http.cookiejar.CookiePolicy.return_ok"><code class="xref py py-meth docutils literal notranslate">return_ok()</code></a> is never called for that cookie path.
Note that <a class="reference internal" href="#http.cookiejar.CookiePolicy.domain_return_ok" title="http.cookiejar.CookiePolicy.domain_return_ok"><code class="xref py py-meth docutils literal notranslate">domain_return_ok()</code></a> is called for every cookie domain, not just
for the request domain. For example, the function might be called with both
<code class="docutils literal notranslate">&quot;.example.com&quot;</code> and <code class="docutils literal notranslate">&quot;www.example.com&quot;</code> if the request domain is
<code class="docutils literal notranslate">&quot;www.example.com&quot;</code>. The same goes for <a class="reference internal" href="#http.cookiejar.CookiePolicy.path_return_ok" title="http.cookiejar.CookiePolicy.path_return_ok"><code class="xref py py-meth docutils literal notranslate">path_return_ok()</code></a>.
The request argument is as documented for <a class="reference internal" href="#http.cookiejar.CookiePolicy.return_ok" title="http.cookiejar.CookiePolicy.return_ok"><code class="xref py py-meth docutils literal notranslate">return_ok()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.CookiePolicy.path_return_ok">
CookiePolicy.path_return_ok(path, request)<a class="headerlink" href="#http.cookiejar.CookiePolicy.path_return_ok" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">False</code> if cookies should not be returned, given cookie path.
See the documentation for <a class="reference internal" href="#http.cookiejar.CookiePolicy.domain_return_ok" title="http.cookiejar.CookiePolicy.domain_return_ok"><code class="xref py py-meth docutils literal notranslate">domain_return_ok()</code></a>.
</dd></dl>

In addition to implementing the methods above, implementations of the
<a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> interface must also supply the following attributes,
indicating which protocols should be used, and how. All of these attributes may
be assigned to.
<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.CookiePolicy.netscape">
CookiePolicy.netscape<a class="headerlink" href="#http.cookiejar.CookiePolicy.netscape" title="Permalink to this definition">¶</a></dt>
<dd>Implement Netscape protocol.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.CookiePolicy.rfc2965">
CookiePolicy.rfc2965<a class="headerlink" href="#http.cookiejar.CookiePolicy.rfc2965" title="Permalink to this definition">¶</a></dt>
<dd>Implement <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> protocol.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.CookiePolicy.hide_cookie2">
CookiePolicy.hide_cookie2<a class="headerlink" href="#http.cookiejar.CookiePolicy.hide_cookie2" title="Permalink to this definition">¶</a></dt>
<dd>Don’t add Cookie2 header to requests (the presence of this header
indicates to the server that we understand <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> cookies).
</dd></dl>

The most useful way to define a <a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> class is by subclassing
from <a class="reference internal" href="#http.cookiejar.DefaultCookiePolicy" title="http.cookiejar.DefaultCookiePolicy"><code class="xref py py-class docutils literal notranslate">DefaultCookiePolicy</code></a> and overriding some or all of the methods
above. <a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> itself may be used as a ‘null policy’ to allow
setting and receiving any and all cookies (this is unlikely to be useful).
</section>
<section id="defaultcookiepolicy-objects">
<h2>DefaultCookiePolicy Objects<a class="headerlink" href="#defaultcookiepolicy-objects" title="Permalink to this headline">¶</a></h2>
Implements the standard rules for accepting and returning cookies.
Both <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> and Netscape cookies are covered. RFC 2965 handling is switched
off by default.
The easiest way to provide your own policy is to override this class and call
its methods in your overridden implementations before adding your own additional
checks:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import http.cookiejar
class MyCookiePolicy(http.cookiejar.DefaultCookiePolicy):
 def set_ok(self, cookie, request):
 if not http.cookiejar.DefaultCookiePolicy.set_ok(self, cookie, request):
 return False
 if i_dont_want_to_store_this_cookie(cookie):
 return False
 return True
</pre></div>
</div>
In addition to the features required to implement the <a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a>
interface, this class allows you to block and allow domains from setting and
receiving cookies. There are also some strictness switches that allow you to
tighten up the rather loose Netscape protocol rules a little bit (at the cost of
blocking some benign cookies).
A domain blocklist and allowlist is provided (both off by default). Only domains
not in the blocklist and present in the allowlist (if the allowlist is active)
participate in cookie setting and returning. Use the blocked_domains
constructor argument, and <code class="xref py py-meth docutils literal notranslate">blocked_domains()</code> and
<code class="xref py py-meth docutils literal notranslate">set_blocked_domains()</code> methods (and the corresponding argument and methods
for allowed_domains). If you set an allowlist, you can turn it off again by
setting it to <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>.
Domains in block or allow lists that do not start with a dot must equal the
cookie domain to be matched. For example, <code class="docutils literal notranslate">&quot;example.com&quot;</code> matches a blocklist
entry of <code class="docutils literal notranslate">&quot;example.com&quot;</code>, but <code class="docutils literal notranslate">&quot;www.example.com&quot;</code> does not. Domains that do
start with a dot are matched by more specific domains too. For example, both
<code class="docutils literal notranslate">&quot;www.example.com&quot;</code> and <code class="docutils literal notranslate">&quot;www.coyote.example.com&quot;</code> match <code class="docutils literal notranslate">&quot;.example.com&quot;</code>
(but <code class="docutils literal notranslate">&quot;example.com&quot;</code> itself does not). IP addresses are an exception, and
must match exactly. For example, if blocked_domains contains <code class="docutils literal notranslate">&quot;192.168.1.2&quot;</code>
and <code class="docutils literal notranslate">&quot;.168.1.2&quot;</code>, 192.168.1.2 is blocked, but 193.168.1.2 is not.
<a class="reference internal" href="#http.cookiejar.DefaultCookiePolicy" title="http.cookiejar.DefaultCookiePolicy"><code class="xref py py-class docutils literal notranslate">DefaultCookiePolicy</code></a> implements the following additional methods:
<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.blocked_domains">
DefaultCookiePolicy.blocked_domains()<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.blocked_domains" title="Permalink to this definition">¶</a></dt>
<dd>Return the sequence of blocked domains (as a tuple).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.set_blocked_domains">
DefaultCookiePolicy.set_blocked_domains(blocked_domains)<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.set_blocked_domains" title="Permalink to this definition">¶</a></dt>
<dd>Set the sequence of blocked domains.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.is_blocked">
DefaultCookiePolicy.is_blocked(domain)<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.is_blocked" title="Permalink to this definition">¶</a></dt>
<dd>Return whether domain is on the blocklist for setting or receiving cookies.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.allowed_domains">
DefaultCookiePolicy.allowed_domains()<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.allowed_domains" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>, or the sequence of allowed domains (as a tuple).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.set_allowed_domains">
DefaultCookiePolicy.set_allowed_domains(allowed_domains)<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.set_allowed_domains" title="Permalink to this definition">¶</a></dt>
<dd>Set the sequence of allowed domains, or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.is_not_allowed">
DefaultCookiePolicy.is_not_allowed(domain)<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.is_not_allowed" title="Permalink to this definition">¶</a></dt>
<dd>Return whether domain is not on the allowlist for setting or receiving
cookies.
</dd></dl>

<a class="reference internal" href="#http.cookiejar.DefaultCookiePolicy" title="http.cookiejar.DefaultCookiePolicy"><code class="xref py py-class docutils literal notranslate">DefaultCookiePolicy</code></a> instances have the following attributes, which are
all initialised from the constructor arguments of the same name, and which may
all be assigned to.
<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.rfc2109_as_netscape">
DefaultCookiePolicy.rfc2109_as_netscape<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.rfc2109_as_netscape" title="Permalink to this definition">¶</a></dt>
<dd>If true, request that the <a class="reference internal" href="#http.cookiejar.CookieJar" title="http.cookiejar.CookieJar"><code class="xref py py-class docutils literal notranslate">CookieJar</code></a> instance downgrade <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2109.html">RFC 2109</a> cookies
(ie. cookies received in a Set-Cookie header with a version
cookie-attribute of 1) to Netscape cookies by setting the version attribute of
the <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> instance to 0. The default value is <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>, in which
case RFC 2109 cookies are downgraded if and only if <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> handling is turned
off. Therefore, RFC 2109 cookies are downgraded by default.
</dd></dl>

General strictness switches:
<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.strict_domain">
DefaultCookiePolicy.strict_domain<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.strict_domain" title="Permalink to this definition">¶</a></dt>
<dd>Don’t allow sites to set two-component domains with country-code top-level
domains like <code class="docutils literal notranslate">.co.uk</code>, <code class="docutils literal notranslate">.gov.uk</code>, <code class="docutils literal notranslate">.co.nz</code>.etc. This is far from perfect
and isn’t guaranteed to work!
</dd></dl>

<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> protocol strictness switches:
<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.strict_rfc2965_unverifiable">
DefaultCookiePolicy.strict_rfc2965_unverifiable<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.strict_rfc2965_unverifiable" title="Permalink to this definition">¶</a></dt>
<dd>Follow <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> rules on unverifiable transactions (usually, an unverifiable
transaction is one resulting from a redirect or a request for an image hosted on
another site). If this is false, cookies are never blocked on the basis of
verifiability
</dd></dl>

Netscape protocol strictness switches:
<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.strict_ns_unverifiable">
DefaultCookiePolicy.strict_ns_unverifiable<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.strict_ns_unverifiable" title="Permalink to this definition">¶</a></dt>
<dd>Apply <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> rules on unverifiable transactions even to Netscape cookies.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.strict_ns_domain">
DefaultCookiePolicy.strict_ns_domain<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.strict_ns_domain" title="Permalink to this definition">¶</a></dt>
<dd>Flags indicating how strict to be with domain-matching rules for Netscape
cookies. See below for acceptable values.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.strict_ns_set_initial_dollar">
DefaultCookiePolicy.strict_ns_set_initial_dollar<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.strict_ns_set_initial_dollar" title="Permalink to this definition">¶</a></dt>
<dd>Ignore cookies in Set-Cookie: headers that have names starting with <code class="docutils literal notranslate">'$'</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.strict_ns_set_path">
DefaultCookiePolicy.strict_ns_set_path<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.strict_ns_set_path" title="Permalink to this definition">¶</a></dt>
<dd>Don’t allow setting cookies whose path doesn’t path-match request URI.
</dd></dl>

<code class="xref py py-attr docutils literal notranslate">strict_ns_domain</code> is a collection of flags. Its value is constructed by
or-ing together (for example, <code class="docutils literal notranslate">DomainStrictNoDots|DomainStrictNonDomain</code> means
both flags are set).
<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.DomainStrictNoDots">
DefaultCookiePolicy.DomainStrictNoDots<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.DomainStrictNoDots" title="Permalink to this definition">¶</a></dt>
<dd>When setting cookies, the ‘host prefix’ must not contain a dot (eg.
<code class="docutils literal notranslate">www.foo.bar.com</code> can’t set a cookie for <code class="docutils literal notranslate">.bar.com</code>, because <code class="docutils literal notranslate">www.foo</code>
contains a dot).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.DomainStrictNonDomain">
DefaultCookiePolicy.DomainStrictNonDomain<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.DomainStrictNonDomain" title="Permalink to this definition">¶</a></dt>
<dd>Cookies that did not explicitly specify a <code class="docutils literal notranslate">domain</code> cookie-attribute can only
be returned to a domain equal to the domain that set the cookie (eg.
<code class="docutils literal notranslate">spam.example.com</code> won’t be returned cookies from <code class="docutils literal notranslate">example.com</code> that had no
<code class="docutils literal notranslate">domain</code> cookie-attribute).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.DomainRFC2965Match">
DefaultCookiePolicy.DomainRFC2965Match<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.DomainRFC2965Match" title="Permalink to this definition">¶</a></dt>
<dd>When setting cookies, require a full <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> domain-match.
</dd></dl>

The following attributes are provided for convenience, and are the most useful
combinations of the above flags:
<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.DomainLiberal">
DefaultCookiePolicy.DomainLiberal<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.DomainLiberal" title="Permalink to this definition">¶</a></dt>
<dd>Equivalent to 0 (ie. all of the above Netscape domain strictness flags switched
off).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.DefaultCookiePolicy.DomainStrict">
DefaultCookiePolicy.DomainStrict<a class="headerlink" href="#http.cookiejar.DefaultCookiePolicy.DomainStrict" title="Permalink to this definition">¶</a></dt>
<dd>Equivalent to <code class="docutils literal notranslate">DomainStrictNoDots|DomainStrictNonDomain</code>.
</dd></dl>

</section>
<section id="cookie-objects">
<h2>Cookie Objects<a class="headerlink" href="#cookie-objects" title="Permalink to this headline">¶</a></h2>
<a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> instances have Python attributes roughly corresponding to the
standard cookie-attributes specified in the various cookie standards. The
correspondence is not one-to-one, because there are complicated rules for
assigning default values, because the <code class="docutils literal notranslate">max-age</code> and <code class="docutils literal notranslate">expires</code>
cookie-attributes contain equivalent information, and because <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2109.html">RFC 2109</a> cookies
may be ‘downgraded’ by <a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a> from version 1 to version 0 (Netscape)
cookies.
Assignment to these attributes should not be necessary other than in rare
circumstances in a <a class="reference internal" href="#http.cookiejar.CookiePolicy" title="http.cookiejar.CookiePolicy"><code class="xref py py-class docutils literal notranslate">CookiePolicy</code></a> method. The class does not enforce
internal consistency, so you should know what you’re doing if you do that.
<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.version">
Cookie.version<a class="headerlink" href="#http.cookiejar.Cookie.version" title="Permalink to this definition">¶</a></dt>
<dd>Integer or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>. Netscape cookies have <a class="reference internal" href="#http.cookiejar.Cookie.version" title="http.cookiejar.Cookie.version"><code class="xref py py-attr docutils literal notranslate">version</code></a> 0. <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> and
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2109.html">RFC 2109</a> cookies have a <code class="docutils literal notranslate">version</code> cookie-attribute of 1. However, note that
<a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a> may ‘downgrade’ RFC 2109 cookies to Netscape cookies, in which
case <a class="reference internal" href="#http.cookiejar.Cookie.version" title="http.cookiejar.Cookie.version"><code class="xref py py-attr docutils literal notranslate">version</code></a> is 0.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.name">
Cookie.name<a class="headerlink" href="#http.cookiejar.Cookie.name" title="Permalink to this definition">¶</a></dt>
<dd>Cookie name (a string).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.value">
Cookie.value<a class="headerlink" href="#http.cookiejar.Cookie.value" title="Permalink to this definition">¶</a></dt>
<dd>Cookie value (a string), or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.port">
Cookie.port<a class="headerlink" href="#http.cookiejar.Cookie.port" title="Permalink to this definition">¶</a></dt>
<dd>String representing a port or a set of ports (eg. ‘80’, or ‘80,8080’), or
<a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.path">
Cookie.path<a class="headerlink" href="#http.cookiejar.Cookie.path" title="Permalink to this definition">¶</a></dt>
<dd>Cookie path (a string, eg. <code class="docutils literal notranslate">'/acme/rocket_launchers'</code>).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.secure">
Cookie.secure<a class="headerlink" href="#http.cookiejar.Cookie.secure" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if cookie should only be returned over a secure connection.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.expires">
Cookie.expires<a class="headerlink" href="#http.cookiejar.Cookie.expires" title="Permalink to this definition">¶</a></dt>
<dd>Integer expiry date in seconds since epoch, or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>. See also the
<a class="reference internal" href="#http.cookiejar.Cookie.is_expired" title="http.cookiejar.Cookie.is_expired"><code class="xref py py-meth docutils literal notranslate">is_expired()</code></a> method.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.discard">
Cookie.discard<a class="headerlink" href="#http.cookiejar.Cookie.discard" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if this is a session cookie.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.comment">
Cookie.comment<a class="headerlink" href="#http.cookiejar.Cookie.comment" title="Permalink to this definition">¶</a></dt>
<dd>String comment from the server explaining the function of this cookie, or
<a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.comment_url">
Cookie.comment_url<a class="headerlink" href="#http.cookiejar.Cookie.comment_url" title="Permalink to this definition">¶</a></dt>
<dd>URL linking to a comment from the server explaining the function of this cookie,
or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.rfc2109">
Cookie.rfc2109<a class="headerlink" href="#http.cookiejar.Cookie.rfc2109" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if this cookie was received as an <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2109.html">RFC 2109</a> cookie (ie. the cookie
arrived in a Set-Cookie header, and the value of the Version
cookie-attribute in that header was 1). This attribute is provided because
<a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a> may ‘downgrade’ RFC 2109 cookies to Netscape cookies, in
which case <a class="reference internal" href="#http.cookiejar.Cookie.version" title="http.cookiejar.Cookie.version"><code class="xref py py-attr docutils literal notranslate">version</code></a> is 0.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.port_specified">
Cookie.port_specified<a class="headerlink" href="#http.cookiejar.Cookie.port_specified" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if a port or set of ports was explicitly specified by the server (in the
Set-Cookie / Set-Cookie2 header).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.domain_specified">
Cookie.domain_specified<a class="headerlink" href="#http.cookiejar.Cookie.domain_specified" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if a domain was explicitly specified by the server.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.domain_initial_dot">
Cookie.domain_initial_dot<a class="headerlink" href="#http.cookiejar.Cookie.domain_initial_dot" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if the domain explicitly specified by the server began with a dot
(<code class="docutils literal notranslate">'.'</code>).
</dd></dl>

Cookies may have additional non-standard cookie-attributes. These may be
accessed using the following methods:
<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.has_nonstandard_attr">
Cookie.has_nonstandard_attr(name)<a class="headerlink" href="#http.cookiejar.Cookie.has_nonstandard_attr" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if cookie has the named cookie-attribute.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.get_nonstandard_attr">
Cookie.get_nonstandard_attr(name, default=None)<a class="headerlink" href="#http.cookiejar.Cookie.get_nonstandard_attr" title="Permalink to this definition">¶</a></dt>
<dd>If cookie has the named cookie-attribute, return its value. Otherwise, return
default.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.set_nonstandard_attr">
Cookie.set_nonstandard_attr(name, value)<a class="headerlink" href="#http.cookiejar.Cookie.set_nonstandard_attr" title="Permalink to this definition">¶</a></dt>
<dd>Set the value of the named cookie-attribute.
</dd></dl>

The <a class="reference internal" href="#http.cookiejar.Cookie" title="http.cookiejar.Cookie"><code class="xref py py-class docutils literal notranslate">Cookie</code></a> class also defines the following method:
<dl class="py method">
<dt class="sig sig-object py" id="http.cookiejar.Cookie.is_expired">
Cookie.is_expired(now=None)<a class="headerlink" href="#http.cookiejar.Cookie.is_expired" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if cookie has passed the time at which the server requested it should
expire. If now is given (in seconds since the epoch), return whether the
cookie has expired at the specified time.
</dd></dl>

</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
The first example shows the most common usage of <a class="reference internal" href="#module-http.cookiejar" title="http.cookiejar: Classes for automatic handling of HTTP cookies."><code class="xref py py-mod docutils literal notranslate">http.cookiejar</code></a>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import http.cookiejar, urllib.request
cj = http.cookiejar.CookieJar()
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open(&quot;http://example.com/&quot;)
</pre></div>
</div>
This example illustrates how to open a URL using your Netscape, Mozilla, or Lynx
cookies (assumes Unix/Netscape convention for location of the cookies file):
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import os, http.cookiejar, urllib.request
cj = http.cookiejar.MozillaCookieJar()
cj.load(os.path.join(os.path.expanduser(&quot;~&quot;), &quot;.netscape&quot;, &quot;cookies.txt&quot;))
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open(&quot;http://example.com/&quot;)
</pre></div>
</div>
The next example illustrates the use of <a class="reference internal" href="#http.cookiejar.DefaultCookiePolicy" title="http.cookiejar.DefaultCookiePolicy"><code class="xref py py-class docutils literal notranslate">DefaultCookiePolicy</code></a>. Turn on
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2965.html">RFC 2965</a> cookies, be more strict about domains when setting and returning
Netscape cookies, and block some domains from setting cookies or having them
returned:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import urllib.request
from http.cookiejar import CookieJar, DefaultCookiePolicy
policy = DefaultCookiePolicy(
 rfc2965=True, strict_ns_domain=Policy.DomainStrict,
 blocked_domains=[&quot;ads.net&quot;, &quot;.ads.net&quot;])
cj = CookieJar(policy)
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open(&quot;http://example.com/&quot;)
</pre></div>
</div>
</section>
</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">http.cookiejar</code> — Cookie handling for HTTP clients</a><ul>
<li><a class="reference internal" href="#cookiejar-and-filecookiejar-objects">CookieJar and FileCookieJar Objects</a></li>
<li><a class="reference internal" href="#filecookiejar-subclasses-and-co-operation-with-web-browsers">FileCookieJar subclasses and co-operation with web browsers</a></li>
<li><a class="reference internal" href="#cookiepolicy-objects">CookiePolicy Objects</a></li>
<li><a class="reference internal" href="#defaultcookiepolicy-objects">DefaultCookiePolicy Objects</a></li>
<li><a class="reference internal" href="#cookie-objects">Cookie Objects</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="http.cookies.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">http.cookies</code> — HTTP state management</a>
 <h4>Next topic</h4>
 <a href="xmlrpc.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">xmlrpc</code> — XMLRPC server and client modules</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/http.cookiejar.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="xmlrpc.html" title="xmlrpc — XMLRPC server and client modules"
 >next</a> |</li>
 <li class="right" >
 <a href="http.cookies.html" title="http.cookies — HTTP state management"
 >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">http.cookiejar</code> — Cookie handling for HTTP clients</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 : http.cookiejar.html