F\hM S r SSKrSSKrSSKr/ SQrSR
rSR
rSR
r " S S\ 5 r
\R \R - S - r
\
S
- r\" \" S 5 5 \" \" \\5 5 -
V s0 s H n U S U - _M sn r\R) \" S
5 S\" S5 S05 \R* " S\R, " \
5 - 5 R. rS r\R* " S5 R4 rS r S r / SQr / SQr S\ \ 4S jr " S S\!5 r"Sr#\#S - r$\R* " S \#- S - \$- S - \RJ \RL - 5 r' " S S!\!5 r( " S" S#\(5 r)gs sn f )$a.
Here's a sample session to show how to use this module.
At the moment, this is the only documentation.
The Basics
----------
Importing is easy...
>>> from http import cookies
Most of the time you start by creating a cookie.
>>> C = cookies.SimpleCookie()
Once you've created your Cookie, you can add values just as if it were
a dictionary.
>>> C = cookies.SimpleCookie()
>>> C["fig"] = "newton"
>>> C["sugar"] = "wafer"
>>> C.output()
'Set-Cookie: fig=newton\r\nSet-Cookie: sugar=wafer'
Notice that the printable representation of a Cookie is the
appropriate format for a Set-Cookie: header. This is the
default behavior. You can change the header and printed
attributes by using the .output() function
>>> C = cookies.SimpleCookie()
>>> C["rocky"] = "road"
>>> C["rocky"]["path"] = "/cookie"
>>> print(C.output(header="Cookie:"))
Cookie: rocky=road; Path=/cookie
>>> print(C.output(attrs=[], header="Cookie:"))
Cookie: rocky=road
The load() method of a Cookie extracts cookies from a string. In a
CGI script, you would use this method to extract the cookies from the
HTTP_COOKIE environment variable.
>>> C = cookies.SimpleCookie()
>>> C.load("chips=ahoy; vienna=finger")
>>> C.output()
'Set-Cookie: chips=ahoy\r\nSet-Cookie: vienna=finger'
The load() method is darn-tootin smart about identifying cookies
within a string. Escaped quotation marks, nested semicolons, and other
such trickeries do not confuse it.
>>> C = cookies.SimpleCookie()
>>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')
>>> print(C)
Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"
Each element of the Cookie also supports all of the RFC 2109
Cookie attributes. Here's an example which sets the Path
attribute.
>>> C = cookies.SimpleCookie()
>>> C["oreo"] = "doublestuff"
>>> C["oreo"]["path"] = "/"
>>> print(C)
Set-Cookie: oreo=doublestuff; Path=/
Each dictionary element has a 'value' attribute, which gives you
back the value associated with the key.
>>> C = cookies.SimpleCookie()
>>> C["twix"] = "none for you"
>>> C["twix"].value
'none for you'
The SimpleCookie expects that all values should be standard strings.
Just to be sure, SimpleCookie invokes the str() builtin to convert
the value to a string, when the values are set dictionary-style.
>>> C = cookies.SimpleCookie()
>>> C["number"] = 7
>>> C["string"] = "seven"
>>> C["number"].value
'7'
>>> C["string"].value
'seven'
>>> C.output()
'Set-Cookie: number=7\r\nSet-Cookie: string=seven'
Finis.
N) CookieError
BaseCookie SimpleCookie z; c \ rS rSrSrg)r N)__name__
__module__ __qualname____firstlineno____static_attributes__r
#/usr/lib/python3.13/http/cookies.pyr r s r r z!#$%&'*+-.^_`|~:z
()/<=>?@[]{} z\%03o"\"\z\\z[%s]+c b U b [ U 5 ( a U $ SU R [ 5 - S- $ )zQuote a string for use in a cookie header.
If the string does not need to be double-quoted, then just return the
string. Otherwise, surround the string in doublequotes and quote
(with a \) special characters.
r )
_is_legal_key translate _Translatorstrs r _quoter s1 {mC((
S]];//#55r z\\(?:([0-3][0-7][0-7])|(.))c P U S ( a [ [ U S S5 5 $ U S $ )N )chrint)ms r _unquote_replacer$ s' t3qtQ< t r c | U b [ U 5 S: a U $ U S S:w d U S S:w a U $ U SS n [ [ U 5 $ )Nr r r r )len _unquote_subr$ r s r _unquoter) sO {c#hl
1v}B3
a)C (# ..r )MonTueWedThuFriSatSun)
NJanFebMarAprMayJunJulAugSepOctNovDecc \ SSK JnJ n U" 5 nU" XP- 5 u pgpppnSX XU XiX4- $ )Nr )gmtimetimez#%s, %02d %3s %4d %02d:%02d:%02d GMT)r? r> )future weekdayname monthnamer> r? nowyearmonthdayhhmmsswdyzs r _getdaterM sE !
&C-3CL-A*D"" 0 OSE"2Db E F Fr c
\ rS rSrSrSSSSSSS S
S S . rS
S1rS r\S 5 r \S 5 r
\S 5 r S r S"S jr
S r\R rS rS rS rS rS rS rS#S jr\rS rS"S jrS"S jr\ " \ R< 5 r S!r g)$Morsel a/ A class to hold ONE (key, value) pair.
In a cookie, each such pair may have several attributes, so this class is
used to keep the attributes associated with the appropriate key,value pair.
This class also includes a coded_value attribute, which is used to hold
the network representation of the value.
expiresPathCommentDomainzMax-AgeSecureHttpOnlyVersionSameSite) rQ pathcommentdomainmax-agesecurehttponlyversionsamesiter] r^ c S =U l =U l U l U R H n[ R XS5 M g )Nr )_key_value _coded_value _reserveddict __setitem__)selfkeys r __init__Morsel.__init__ s8 6:: :DK$"3 >>C T + "r c U R $ N)rb rh s r ri
Morsel.key s yyr c U R $ rm )rc rn s r value Morsel.value s {{r c U R $ rm )rd rn s r coded_valueMorsel.coded_value s r c UR 5 nXR ; a [ SU< 35 e[ R XU5 g NzInvalid attribute )lowerre r rf rg )rh KVs r rg Morsel.__setitem__# s5
GGINN" ;< < !$r Nc UR 5 nXR ; a [ SU< 35 e[ R XU5 $ rw )rx re r rf
setdefault)rh ri vals r r} Morsel.setdefault) s6 iik nn $ => >t#..r c " [ U[ 5 ( d [ $ [ R X5 =( aY U R
UR
:H =( a9 U R UR :H =( a U R UR :H $ rm )
isinstancerO NotImplementedrf __eq__rc rb rd rh morsels r r
Morsel.__eq__/ sk &&))! ! D) 9 v}},9 V[[(9 !!V%8%88 :r c [ 5 n[ R X5 UR R U R 5 U$ rm )rO rf update__dict__r s r copy Morsel.copy9 s0 F! t}}-
r c 0 n[ U5 R 5 H7 u p4UR 5 nX0R ; a [ SU< 35 eXBU' M9 [ R X5 g rw )rf itemsrx re r r )rh valuesdatari r~ s r r
Morsel.update? sX V **,HC))+C..(!C"ABBI -
D r c < UR 5 U R ; $ rm )rx re )rh ry s r
isReservedKeyMorsel.isReservedKeyH s wwyDNN**r c UR 5 U R ; a [ SU< 35 e[ U5 ( d [ SU< 35 eXl X l X0l g )Nz Attempt to set a reserved key z Illegal key )rx re r r rb rc rd )rh ri r~ coded_vals r set
Morsel.setK sM 99;$.. ( C IJ J S!! # 78 8 %r c J U R U R U R S.$ )N)ri rq rt rb rc rd rn s r __getstate__Morsel.__getstate__V s# 99[[ ,,
r c @ US U l US U l US U l g )Nri rq rt r )rh states r __setstate__Morsel.__setstate__] s% %L Gn !- 0r c 2 U< SU R U5 < 3$ )Nr ) OutputString)rh attrsheaders r output
Morsel.outputb s $"3"3E":;;r c \ SU R R < SU R 5 < S3$ )N<: >) __class__r r rn s r __repr__Morsel.__repr__g s !^^ 4 4d6G6G6IJJr c J SU R U5 R SS5 - $ )Nz
r r )r replace)rh r s r js_outputMorsel.js_outputj s. '//U;
= =r c $ / nUR nU" U R < SU R < 35 Uc U R n[ U R 5 5 nU GH& u pVUS:X a M XQ; a M US:X a< [
U[ 5 ( a' U" U R U < S[ U5 < 35 MW US:X a1 [
U[ 5 ( a U" SU R U U4- 5 M US:X a< [
U[ 5 ( a' U" U R U < S[ U5 < 35 M XPR ; a+ U( a! U" [ U R U 5 5 GM GM
U" U R U < SU< 35 GM) [ U5 $ )N=r rQ r\ z%s=%drZ )
appendri rt re sortedr r r" rM r r _flags_semispacejoin)rh r resultr r ri rq s r r Morsel.OutputStringt sB $((D$4$456 =NNEtzz|$ JC{ i Juc$:$:$.."5xGH !j&<&<w$.."5u!==> !j&<&<$.."5ve}EF #3t~~c 234 $.."5u=> $ f%%r )rd rb rc rm )N Set-Cookie:)!r r r
r __doc__re r rj propertyri rq rt rg r} r object__ne__r r r r r r r __str__r r r classmethodtypes GenericAlias__class_getitem__r r
r r rO rO s *
I
#F, ! !% / : ]]F + &
1
< GK= &B $E$6$67r rO z,\w\d!#%&'~_`><@,:/\$\*\+\-\.\^\|\)\(\?\}\{\=z\[\]z
\s* # Optional whitespace at start of cookie
(?P # Start of group 'key'
[ax ]+? # Any word of at least one letter
) # End of group 'key'
( # Optional group: there may not be a value.
\s*=\s* # Equal Sign
(?P # Start of group 'val'
"(?:[^\\"]|\\.)*" # Any double-quoted string
| # or
# Special case for "expires" attr
(\w{3,6}day|\w{3}),\s # Day of the week or abbreviated day
[\w\d\s-]{9,11}\s[\d:]{8}\sGMT # Date and time in specific format
| # or
[a- ]* # Any word or empty string
) # End of group 'val'
)? # End of optional value group
\s* # Any number of spaces.
(\s+|;|$) # Ending either at space, semicolon, or EOS.
c j \ rS rSrSrS rS rSS jrS rS r SS jr
\
r S
r SS jr
S r\4S
jrSrg)r i z'A container class for a set of Morsels.c X4$ )zreal_value, coded_value = value_decode(STRING)
Called prior to setting a cookie's value from the network
representation. The VALUE is the value read from HTTP
header.
Override this function to modify the behavior of cookies.
r
rh r~ s r value_decodeBaseCookie.value_decode s xr c [ U5 nX"4$ )zreal_value, coded_value = value_encode(VALUE)
Called prior to setting a cookie's value from the dictionary
representation. The VALUE is the value being assigned.
Override this function to modify the behavior of cookies.
r rh r~ strvals r value_encodeBaseCookie.value_encode s S~ r Nc 6 U( a U R U5 g g rm )load)rh inputs r rj BaseCookie.__init__ s IIe r c U R U[ 5 5 nUR XU5 [ R XU5 g)z+Private method for setting a cookie's valueN)getrO r rf rg )rh ri
real_valuert Ms r __setBaseCookie.__set s2 HHS&( # c{+ A&r c [ U[ 5 ( a [ R XU5 gU R U5 u p4U R XU5 g)z Dictionary style assignment.N)r rO rf rg r _BaseCookie__set)rh ri rq rvalcvals r rg BaseCookie.__setitem__ s? eV $ $ T . **51JD JJs$ 'r c / n[ U R 5 5 nU H% u pgUR UR X5 5 M' UR U5 $ )z"Return a string suitable for HTTP.)r r r r join)rh r r sepr r ri rq s r r BaseCookie.output sG tzz|$ JC MM%,,u5 6 xx r c / n[ U R 5 5 nU H0 u p4UR U< S[ UR 5 < 35 M2 SU R
R < S[ U5 < S3$ )Nr r r r )r r r reprrq r r
_spacejoin)rh lr ri rq s r r BaseCookie.__repr__ sV tzz|$ JC
HHT%++%67 8 !^^ 4 4jmDDr c / n[ U R 5 5 nU H% u pEUR UR U5 5 M' [ U5 $ )z(Return a string suitable for JavaScript.)r r r r _nulljoin)rh r r r ri rq s r r BaseCookie.js_output sC tzz|$ JC MM%//%0 1 r c [ U[ 5 ( a U R U5 gUR 5 H u p#X0U' M g)zLoad cookies from a string (presumably HTTP_COOKIE) or
from a dictionary. Loading cookies from a dictionary 'd'
is equivalent to calling:
map(Cookie.__setitem__, d.keys(), d.values())
N)r r _BaseCookie__parse_stringr )rh rawdatari rq s r r BaseCookie.load sB gs # # (
&mmo
!S .r c 2 Sn[ U5 n/ nSnSnSnSUs=:: a U: Ga5 O GO1UR X5 n U ( d GOU R S5 U R S5 pU R S5 nU
S S:X a U( d Mp UR XzSS U 45 OU
R 5 [ R ; a_ U( d g U c7 U
R 5 [ R ; a UR XzS45 OGg UR Xz[ U 5 45 O)U b% UR XU R U 5 45 SnOg SUs=:: a U: a GM/ O S n U H7 u pn X:X a U c eXU
' M X:X d eU u pU R XU5 X
n M9 g ) Nr Fr r ri r~ $T) r' matchgroupendr rx rO re r r) r r )rh r pattin parsed_items morsel_seenTYPE_ATTRIBUTE
TYPE_KEYVALUEr ri rq r tpr r s r __parse_stringBaseCookie.__parse_string s
H
1jqjjJJs&E U+U[[-? ! A1v}" ##^We$DE 0 00"=yy{fmm3$++^$,GH '' huo(NO" ##]9J9J59Q$RS " E 1jqjjJ
*NBU#}$} #*** "
3d+I +r r
rm )Nr z
)r r r
r r r r rj r rg r r r r r _CookiePatternr r r
r r r r sD 1 ' ( GE! (6 : r r c $ \ rS rSrSrS rS rSrg)r iH z
SimpleCookie supports strings as cookie values. When setting
the value using the dictionary assignment notation, SimpleCookie
calls the builtin str() to convert the value to a string. Values
received from HTTP are kept as strings.
c [ U5 U4$ rm )r) r s r r SimpleCookie.value_decodeO s }c!!r c 2 [ U5 nU[ U5 4$ rm )r r r s r r SimpleCookie.value_encodeR s Svf~%%r r
N)r r r
r r r r r r
r r r r H s "&r r )*r restringr __all__r r r r Exceptionr
ascii_lettersdigits _LegalChars_UnescapedCharsr rangemapordr r compileescape fullmatchr r subr( r$ r) _weekdayname
_monthnamerM rf rO _LegalKeyChars_LegalValueCharsASCIIVERBOSEr r r )r s 0r r s NXz
7 GG
XX
) " ""V]]25GG / E#J#c#.G*HHJH1 (Q,HJ HeIv
7RYY{%;;<FF
6 zz89== /6 A 8
<: Fi8T i8j B!G+ &
BJJ ' 2I I X &: &G
Js E: