$fP d Z ddlZddlZddlZg dZdj
Zdj
Zdj
Z G d de Z
ej ej z d z Z
e
d
z Z e ed e eee z
D ci c] } | d | z
c} Zej) ed
d ed di ej* d ej, e
z j. Zd Z ej* d Z ej* d Zd Z g dZ g dZ de e fdZ G d de Z!dZ"e"d z Z# ej* d e"z d z e#z d z ejH ejJ z Z& G d d!e Z' G d" d#e' Z(yc c} w )$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 e Zd Zy)r N)__name__
__module__ __qualname__ #/usr/lib/python3.12/http/cookies.pyr r s r
r z!#$%&'*+-.^_`|~:z
()/<=>?@[]{} z\%03o"\"\z\\z[%s]+c V | t | r| S d| j t z dz 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 s. {mC(
S]];//#55r
z\\[0-3][0-7][0-7]z[\\].c
| t | dk r| S | d dk7 s| d dk7 r| S | dd } d}t | }g }d|cxk r|k r n t | S t j | | }t j | | }|s"|s |j | |d t | S dx}}|r|j d }|r|j d }|r8|r||k r1|j | || |j | |dz |dz }nF|j | || |j t
t | |dz |dz d |dz }d|cxk r|k rt | S t | S )N r r ) len
_OctalPattsearch
_QuotePattappendstartchrint _nulljoin)r inreso_matchq_matchjks r _unquoter0 s {c#hl
1v}B3
a)C
A CA
C
q*1*( S>' ##C+ ##C+w JJs12w S>
A
a A
a A Gq1u JJs1Qx JJs1Q3x AA JJs1Qx JJs3s1Q3qs|Q/0 1AA' q*1*( S>) ( S>r
)MonTueWedThuFriSatSun)
NJanFebMarAprMayJunJulAugSepOctNovDecc n ddl m}m } | } ||| z \ }}}} }
} } }
}d|| ||| || |
| fz S )Nr )gmtimetimez#%s, %02d %3s %4d %02d:%02d:%02d GMT)rF rE )future weekdayname monthnamerE rF nowyearmonthdayhhmmsswdyzs r _getdaterT sW !
&C-3C&L-A*D%b"b"a 0 OS)E"2D"b" E F Fr
c
e Zd ZdZdddddddd d
d Zd d
hZd Zed Zed Z ed Z
d Z d dZ d Z
ej Zd Zd Zd Zd Zd Zd Zd!d ZeZd Zd d Zd d Z ee j: Z y)"MorselaC 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) rW pathcommentdomainmax-agesecurehttponlyversionsamesiterc rd c ~ d x| _ x| _ | _ | j D ] }t j | |d y )Nr )_key_value _coded_value _reserveddict __setitem__)selfkeys r __init__zMorsel.__init__! s? 6:: :DK$"3 >> ,C T3 + ,r
c | j S N)rh rn s r ro z
Morsel.key) s yyr
c | j S rr )ri rs s r valuez Morsel.value- s {{r
c | j S rr )rj rs s r coded_valuezMorsel.coded_value1 s r
c |j }|| j vrt d| t j | || y NzInvalid attribute )lowerrk r rl rm )rn KVs r rm zMorsel.__setitem__5 s9
GGIDNN" ;< < q!$r
Nc |j }|| j vrt d| t j | || S ry )rz rk r rl
setdefault)rn ro vals r r~ zMorsel.setdefault; s: iik dnn $ => >tS#..r
c t |t st S t j | | xrO | j
|j
k( xr4 | j |j k( xr | j |j k( S rr )
isinstancerV NotImplementedrl __eq__ri rh rj rn morsels r r z
Morsel.__eq__A sj &&)! ! D&) 9 v}},9 V[[(9 !!V%8%88 :r
c t }t j || |j j | j |S rr )rV rl update__dict__r s r copyz Morsel.copyK s2 FD! t}}-
r
c i }t | j D ]6 \ }}|j }|| j vrt d| |||< 8 t j | | y ry )rl itemsrz rk r r )rn valuesdataro r s r r z
Morsel.updateQ se V **, HC))+C$..(!C"ABBDI
D$ r
c : |j | j v S rr )rz rk )rn r{ s r
isReservedKeyzMorsel.isReservedKeyZ s wwyDNN**r
c |j | j v rt d| t | st d| || _ || _ || _ y )Nz Attempt to set a reserved key z Illegal key )rz rk r r rh ri rj )rn ro r coded_vals r setz
Morsel.set] sP 99;$.. ( C IJ J S! # 78 8 %r
c J | j | j | j dS )N)ro ru rw rh ri rj rs s r __getstate__zMorsel.__getstate__h s# 99[[ ,,
r
c @ |d | _ |d | _ |d | _ y )Nro ru rw r )rn states r __setstate__zMorsel.__setstate__o s% %L Gn !- 0r
c . |d| j | S )Nr ) OutputString)rn attrsheaders r outputz
Morsel.outputt s $"3"3E":;;r
c X d| j j d| j dS )N<: >) __class__r r rs s r __repr__zMorsel.__repr__y s !^^ 4 4d6G6G6IJJr
c J d| j | j dd z S )Nz
r r )r replace)rn r s r js_outputzMorsel.js_output| s. '//U;
= =r
c g }|j } || j d| j | | j }t | j }|D ] \ }}|dk( r ||vr|dk( r4t
|t r$ || j | dt | J|dk( r+t
|t r |d| j | |fz z|dk( r4t
|t r$ || j | dt | || j v r"|s |t | j | || j | d| t | S )N=r rW rb z%s=%dr` )
r$ ro rw rk sortedr r r' rT r r _flags_semispacejoin)rn r resultr$ r ro ru s r r zMorsel.OutputString s= $((D$4$456 =NNEtzz|$ ?JC{% i Juc$:$.."5xGH !j&<w$.."5u!==> !j&<$.."5ve}EF #3t~~c 234$.."5u=> ?$ f%%r
rr )N Set-Cookie:) r r
r __doc__rk r rp propertyro ru rw rm r~ r object__ne__r r r r r r r __str__r r r classmethodtypes GenericAlias__class_getitem__r r
r rV rV s *
I
#F, ! !% / : ]]F + &
1
< GK= &B $E$6$67r
rV z,\w\d!#%&'~_`><@,:/\$\*\+\-\.\^\|\)\(\?\}\{\=z\[\]z
\s* # Optional whitespace at start of cookie
(?P # Start of group 'key'
[a ]+? # 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 doublequoted string
| # or
\w{3},\s[\w\d\s-]{9,11}\s[\d:]{8}\sGMT # Special case for "expires" attr
| # 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 Z e Zd ZdZd Zd Zd
dZd Zd ZddZ e Z
d Z d
d
Z d Z
efd Zy)r z'A container class for a set of Morsels.c
||fS )a
real_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 rn r s r value_decodezBaseCookie.value_decode s
Cxr
c t | }||fS )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 rn r strvals r value_encodezBaseCookie.value_encode s Sv~ r
Nc , |r| j | y y rr )load)rn inputs r rp zBaseCookie.__init__ s IIe r
c | j |t }|j ||| t j | || y)z+Private method for setting a cookie's valueN)getrV r rl rm )rn ro
real_valuerw Ms r __setzBaseCookie.__set s6 HHS&( # c:{+ sA&r
c t |t rt j | || y| j | \ }}| j ||| y)z Dictionary style assignment.N)r rV rl rm r _BaseCookie__set)rn ro ru rvalcvals r rm zBaseCookie.__setitem__ sB eV $ T3 . **51JD$ JJsD$ 'r
c g }t | j }|D ]& \ }}|j |j || ( |j | S )z"Return a string suitable for HTTP.)r r r$ r join)rn r r sepr r ro ru s r r zBaseCookie.output sP tzz|$ 7JC MM%,,uf5 6 7xx r
c g }t | j }|D ]. \ }}|j |dt |j 0 d| j
j dt | dS )Nr r r r )r r r$ reprru r r
_spacejoin)rn lr ro ru s r r zBaseCookie.__repr__ s] tzz|$ 9JC
HHT%++%67 8 9 !^^ 4 4jmDDr
c g }t | j }|D ]% \ }}|j |j | ' t | S )z(Return a string suitable for JavaScript.)r r r$ r r( )rn r r r ro ru s r r zBaseCookie.js_output sJ tzz|$ 2JC MM%//%0 1 2 r
c t |t r| j | y|j D ]
\ }}|| |< y)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 )rn rawdataro ru s r r zBaseCookie.load
sH gs # (
&mmo
"
U !S
"r
c d}t | }g }d}d}d}d|cxk r|k r!n n |j || } | sn| j d | j d } }
| j d }|
d dk( r|sd|j ||
dd | f n|
j t j v rY|sy | 6|
j t j v r|j ||
df nHy |j ||
t | f n)| &|j ||
| j | f d}ny d|cxk r|k rn d } |D ]9 \ }
}
} |
|k( r
| J | | |
< |
|k( sJ | \ }}| j |
|| | |
} ; y ) Nr Fr r ro r $T) r matchgroupendr$ rz rV rk r r0 r r )rn r pattr) r* parsed_items morsel_seenTYPE_ATTRIBUTE
TYPE_KEYVALUEr ro ru r tpr r s r __parse_stringzBaseCookie.__parse_string s
H
1jqjJJsA&E U+U[[-?C ! A1v}" ##^SWe$DE 0 00"=yy{fmm3$++^S$,GH '' huo(NO" ##]C9J9J59Q$RS " E 1jqjJ
* NBU^#}$} #]*** "
d
3d+I r
rr )Nr z
)r r
r r r r rp r rm r r r r r _CookiePatternr r r
r r r sD 1 ' ( GE! (6 : r
r c e Zd ZdZd Zd Zy)r 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 t | |fS rr )r0 r s r r zSimpleCookie.value_decode_ s }c!!r
c 2 t | }|t | fS rr )r r r s r r zSimpleCookie.value_encodeb s Svf~%%r
N)r r
r r r r r r
r r r X s "&r
r ))r restringr __all__r r( r r Exceptionr
ascii_lettersdigits _LegalChars_UnescapedCharsr rangemapordr r compileescape fullmatchr r r! r# r0 _weekdayname
_monthnamerT rl rV _LegalKeyChars_LegalValueCharsASCIIVERBOSEr r r )r* s 0r r s NXz
7 GG
XX
) " ""V]]25GG / E#J#c#.G*HHJ (Q, J HeIv
7YRYY{%;;<FF
6 RZZ,
-
RZZ
!
)d A 8
<: Fi8T i8j B!G+ "
BJJ # .I I X &: &g
Js
E;