+
Bi?N ^ R t ^ RIt^ RIt^ RIt. R OtRP
tRP
tRP
t ! R R] 4 t
]P ]P , R , t
]
R
, t]! ]! R 4 4 ]! ]! ]]4 4 ,
U u/ uF
p V R V , bK up t]P) ]! R
4 R]! R4 R/4 ]P* ! R]P, ! ]
4 , 4 P. tR t]P* ! R4 P4 tR t R t . R!Ot . R"Ot ^ ] ] 3R lt ! R R]!4 t"Rt#]#R, t$]P* ! R]#, R , ]$, R , ]PJ ]PL , 4 t' ! R R]!4 t( ! R R](4 t)R# u up i )#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 ] tR t^tRtR# )r N)__name__
__module__ __qualname____firstlineno____static_attributes__r #/usr/lib/python3.14/http/cookies.pyr r s r z!#$%&'*+-.^_`|~:z
()/<=>?@[]{} z\%03o"\"\z\\z[%s]+c v V e \ V 4 ' d V # RV P \ 4 , R, # )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 j V ^, ' d \ \ V ^, ^4 4 # V ^, # ) )chrint)ms &r _unquote_replacer s) tt3qtQ< t r c V e \ V 4 ^8 d V # V ^ , R8w g V R, R8w d V # V ^R p \ \ V 4 # )Nr )len _unquote_subr r s &r _unquoter% sO {c#hl
1v}B3
a)C (# ..r c | ^ RI HpH p V! 4 pV! WP, 4 w rgrrrpRW , WV, WiW3, # ) )gmtimetimez#%s, %02d %3s %4d %02d:%02d:%02d GMT)r) r( )future weekdayname monthnamer( r) nowyearmonthdayhhmmsswdyzs &&& r _getdater7 sE !
&C-3CL-A*D"" 0 OSE"2Db E F Fr c P a ] tR t^t o RtRRRRRRRRR R
R R R
RRRRRRR/
t]P ]R4 t0 R)mt R t
] R 4 t ] R 4 t
] R 4 tR tR*R ltR t]P& tR tR tR tR! tR" tR# tR+R$ lt]tR% t R*R& lt R*R' lt ] ! ] PB 4 t"R(t#V t$R# ),Morsela/ 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.
expirespathPathcommentCommentdomainDomainmax-agezMax-AgesecureSecurehttponlyHttpOnlyversionVersionsamesiteSameSite partitioned Partitionedr c n R ;V n ;V n V n \ P W P
4 R # N)_key_value _coded_valuedictupdate_reserved_defaultsselfs &r __init__Morsel.__init__ s, 6:: :DK$"3
D112r c V P # rM )rN rT s &r key
Morsel.key s yyr c V P # rM )rO rT s &r value Morsel.value s {{r c V P # rM )rP rT s &r coded_valueMorsel.coded_value! s r c VP 4 pWP 9 g \ R V: 24 h\ P WV4 R# Invalid attribute N)lower _reservedr rQ __setitem__)rU KVs &&&r rf Morsel.__setitem__% s5
GGINN" ;< < !$r Nc VP 4 pWP 9 d \ R V: 24 h\ P WV4 # )rc )rd re r rQ
setdefault)rU rY vals &&&r rk Morsel.setdefault+ s6 iik nn $ => >t#..r c * \ V\ 4 ' g \ # \ P W4 ;' d\ V P
VP
8H ;' d; V P VP 8H ;' d V P VP 8H # rM )
isinstancer9 NotImplementedrQ __eq__rO rN rP rU morsels &&r rq
Morsel.__eq__1 sz &&))! ! D) 9 9 v}},9 9 V[[(9 9 !!V%8%88 :r c \ 4 p\ P W4 VP P V P 4 V# rM )r9 rQ rR __dict__rr s & r copy Morsel.copy; s0 F! t}}-
r c / p\ V4 P 4 F8 w r4VP 4 pW0P 9 d \ R V: 24 hWBV& K: \ P W4 R# rb )rQ itemsrd re r rR )rU valuesdatarY rl s && r rR
Morsel.updateA sX V **,HC))+C..(!C"ABBI -
D r c < VP 4 V P 9 # rM )rd re )rU rg s &&r
isReservedKeyMorsel.isReservedKeyJ s wwyDNN**r c VP 4 V P 9 d \ R V: 24 h\ V4 ' g \ RV: 24 hWn W n W0n R# )z Attempt to set a reserved key z Illegal key N)rd re r r rN rO rP )rU rY rl coded_vals &&&&r set
Morsel.setM sM 99;$.. ( C IJ J S!! # 78 8 %r c N R V P RV P RV P /# )rY r\ r_ rN rO rP rT s &r __getstate__Morsel.__getstate__X s) 499 T[[ 4,,
r c Z VR , V n VR, V n VR, V n R# )rY r\ r_ Nr )rU states &&r __setstate__Morsel.__setstate___ s% %L Gn !- 0r c 2 V: R V P V4 : 2# )r ) OutputString)rU attrsheaders &&&r output
Morsel.outputd s $"3"3E":;;r c \ R V P P : RV P 4 : R2# )<: >) __class__r r rT s &r __repr__Morsel.__repr__i s !^^ 4 4d6G6G6IJJr c R R V P V4 P RR4 , # )z
r r )r replace)rU r s &&r js_outputMorsel.js_outputl s. '//U;
= =r c j . pVP pV! V P : R V P : 24 Vf
V P p\ V P 4 4 pV EFH w rVVR8X d K WQ9 d K VR8X dB \
V\ 4 ' d, V! V P V, : R \ V4 : 24 K_ VR8X d; \
V\ 4 ' d% V! RV P V, V3, 4 K VR8X dB \
V\ 4 ' d, V! V P V, : R \ V4 : 24 K WPP 9 d1 V' d& V! \ V P V, 4 4 EK% EK( V! V P V, : R V: 24 EKK \ V4 # )=r r: rA z%s=%dr= )
appendrY r_ re sortedrz ro r r7 r r _flags_semispacejoin)rU r resultr rz rY r\ s && r r Morsel.OutputStringv sK $((D$4$456 =NNEtzz|$ JC{ i Juc$:$:$.."5"5xGH !j&<&<w$.."5u!==> !j&<&<$.."5"5ve}EF #3t~~c 234 $.."5"5u=> $ f%%r )rP rN rO > rB rD rJ rM )N Set-Cookie:)%r r
r r __doc__re rQ fromkeysrS r rV propertyrY r\ r_ rf rk rq object__ne__rw rR r r r r r __str__r r r classmethodtypes GenericAlias__class_getitem__r
__classdictcell__
__classdict__s @r r9 r9 s * YVYXYXZYZ} I y"5
2F3 ! !% / : ]]F + &
1
< GK= &B $E$6$67r r9 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 v a ] tR tRt o RtR tR tRR ltR tR t RR lt
]
t R
t RR lt
R t]3R
ltRtV tR# )r i z'A container class for a set of Morsels.c W3# )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 rU rl s &&r value_decodeBaseCookie.value_decode s xr c \ V4 pW"3# )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 rU rl strvals && r value_encodeBaseCookie.value_encode s S~ r Nc < V' d V P V4 R # R # rM )load)rU inputs &&r rV BaseCookie.__init__ s IIe r c V P V\ 4 4 pVP WV4 \ P WV4 R# )z+Private method for setting a cookie's valueN)getr9 r rQ rf )rU rY
real_valuer_ Ms &&&& r __setBaseCookie.__set s2 HHS&( # c{+ A&r c \ V\ 4 ' d \ P WV4 R# V P V4 w r4V P WV4 R# )z Dictionary style assignment.N)ro r9 rQ rf r _BaseCookie__set)rU rY r\ rvalcvals &&& r rf BaseCookie.__setitem__ s? eV $ $ T . **51JD JJs$ 'r c . p\ V P 4 4 pV F% w rgVP VP W4 4 K' VP V4 # )z"Return a string suitable for HTTP.)r rz r r join)rU r r sepr rz rY r\ s &&&& r r BaseCookie.output sG tzz|$ JC MM%,,u5 6 xx r c . p\ V P 4 4 pV F0 w r4VP V: R \ VP 4 : 24 K2 RV P
P : R\ V4 : R2# )r r r r )r rz r reprr\ r r
_spacejoin)rU lrz rY r\ s & r r BaseCookie.__repr__ sV tzz|$ JC
HHT%++%67 8 !^^ 4 4jmDDr c . p\ V P 4 4 pV F% w rEVP VP V4 4 K' \ V4 # )z(Return a string suitable for JavaScript.)r rz r r _nulljoin)rU r r rz rY r\ s && r r BaseCookie.js_output sC tzz|$ JC MM%//%0 1 r c \ V\ 4 ' d V P V4 R# VP 4 F w r#W0V& K R# )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)ro r _BaseCookie__parse_stringrz )rU rawdatarY r\ s && r r BaseCookie.load sB gs # # (
&mmo
!S .r c T ^ p\ V4 p. pRp^p^p^ Tu;8: d V8 Ed= M EM8VP W4 p V ' g EM V P R4 V P R4 rV P ^ 4 pV
^ , R8X d' V' g Ky VP WzR, V 34 K V
P 4 \ P 9 dh V' g R# V f; V
P 4 \ P 9 d VP WzR34 K R# VP Wz\ V 4 34 EK V e( VP WV P V 4 34 RpEKJ R# Rp V F> w rp W8X d
V f Q hWV
& K W8X g Q hV w rV P WV4 W
, p K@ R# )r' FrY rl $:r NNNT) r# matchgroupendr rd r9 re r r% r r )rU r pattin parsed_items morsel_seenTYPE_ATTRIBUTE
TYPE_KEYVALUEr rY r\ r tpr r s &&& r __parse_stringBaseCookie.__parse_string
sy
H
1jqjjJJs&E U+U[[-? ! A1v}" ##^We$DE 0 00"=yy{fmm3$++^$,GH '' huo(NO" ##]9J9J59Q$RS "
*NBU#}$} #*** "
3d+I +r r rM )Nr z
)r r
r r r r r rV r rf r r r r r _CookiePatternr r
r r s @r r r sL 1 ' ( GE! (6 : : r c 0 a ] tR tRt o RtR tR tRtV tR# )r iJ 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 \ V4 V3# rM )r% r s &&r r SimpleCookie.value_decodeQ s }c!!r c 2 \ V4 pV\ V4 3# rM )r r r s && r r SimpleCookie.value_encodeT s Svf~%%r r N) r r
r r r r r r
r r s @r r r J s "& &r )r r r )MonTueWedThuFriSatSun)
NJanFebMarAprMayJunJulAugSepOctNovDec)*r restringr __all__r r r r Exceptionr
ascii_lettersdigits _LegalChars_UnescapedCharsr rangemapordr rR compileescape fullmatchr r subr$ r r% _weekdayname
_monthnamer7 rQ r9 _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
<: Fk8T k8n B!G+ &
BJJ ' 2I I X &: &K
Js F*