Wj@T 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. Z ej* d Zd Zd Z ej* d j8 Z d Z d Z g dZ g dZ!de e!fdZ" G d d e# Z$d Z%e%d z Z& ej* d e%z d z e&z d!z ejN ejP 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=;";')
>>> print(C)
Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=;"
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/lib64/python3.12/http/cookies.pyr r s r
r z!#$%&'*+-.^_`|~:z
()/<=>?@[]{} z\%03o"\"\z\\z[%s]+z[\x00-\x1F\x7F]c & t d | D S )zhDetects control characters within a value.
Supports any type, as header values can be any type.
c 3 X K | ]" }t j t | $ y wN)_control_character_researchstr).0vs r z)_has_control_character.. s! AS$++CF3Ss (*)any)vals r _has_control_characterr s ASA AAr
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 _Translatorr s r _quoter$ s. {mC(
S]];//#55r
z\\(?:([0-3][0-7][0-7])|(.))c F | d rt t | d d S | d S )N )chrint)ms r _unquote_replacer, s' t3qtQ< t r
c t | t | dk r| S | d dk7 s| d dk7 r| S | dd } t t | S )Nr( r r r& )len _unquote_subr, r# s r _unquoter1 sO {c#hl
1v}B3
a)C (# ..r
)MonTueWedThuFriSatSun)
NJanFebMarAprMayJunJulAugSepOctNovDecc n ddl m}m } | } ||| z \ }}}} }
} } }
}d|| ||| || |
| fz S )Nr )gmtimetimez#%s, %02d %3s %4d %02d:%02d:%02d GMT)rG rF )future weekdayname monthnamerF rG nowyearmonthdayhhmmsswdyzs r _getdaterU 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 Zd"d ZeZd Zd!d Zd!d Z e e 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) rX pathcommentdomainmax-agesecurehttponlyversionsamesiterd re 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 r )ri ro s r rp z
Morsel.key s yyr
c | j S r )rj rs s r valuez Morsel.value$ s {{r
c | j S r )rk rs s r coded_valuezMorsel.coded_value( s r
c |j }|| j vrt d| t || rt d|d| t j | || y NzInvalid attribute .Control characters are not allowed in cookies r )lowerrl r r rm rn )ro KVs r rn zMorsel.__setitem__, s_
GGIDNN" ;< < !!Q ' NqeSTUVTY Z[ [ q!$r
Nc |j }|| j vrt d| t || rt d|d| t j | || S ry )r{ rl r r rm
setdefault)ro rp r s r r zMorsel.setdefault4 sV iik dnn $ => > !#s + WZ\_ ab btS#..r
c t |t st S t j | | xrO | j
|j
k( xr4 | j |j k( xr | j |j k( S r )
isinstancerW NotImplementedrm __eq__rj ri rk ro morsels r r z
Morsel.__eq__< sj &&)! ! D&) 9 v}},9 V[[(9 !!V%8%88 :r
c t }t j || |j j | j |S r )rW rm update__dict__r s r copyz Morsel.copyF s2 FD! t}}-
r
c i }t | j D ]S \ }}|j }|| j vrt d| t || rt d|d| |||< U t j
| | y ry )rm itemsr{ rl r r r )ro valuesdatarp r s r r z
Morsel.updateL s V **,HC))+C$..(!C"ABB%c3/! #--0G1SG#= > >DI -
D$ r
c ( | j | | S r )r )ro r s r __ior__zMorsel.__ior__X s F r
c : |j | j v S r )r{ rl )ro r| s r
isReservedKeyzMorsel.isReservedKey\ s wwyDNN**r
c |j | j v rt d| t | st d| t ||| rt d|d|d| || _ || _ || _ y )Nz Attempt to set a reserved key z Illegal key rz r )r{ rl r r r ri rj rk )ro rp r coded_vals r setz
Morsel.set_ sw 99;$.. ( C IJ J S! # 78 8 !#sI 6 LOQTV_ac
c %r
c J | j | j | j dS )N)rp ru rw )ri rj rk rs s r __getstate__zMorsel.__getstate__m s# 99[[ ,,
r
c |d }|d }|d }t ||| rt d|d|d| || _ || _ || _ y )Nrp ru rw rz r )r r ri rj rk )ro staterp ru rw s r __setstate__zMorsel.__setstate__t si ElgM* !#uk : N!$q ;/ C D
D 'r
c . |d| j | S )Nr ) OutputString)ro attrsheaders r outputz
Morsel.output s $"3"3E":;;r
c X d| j j d| j dS )N<: >) __class__r r rs s r __repr__zMorsel.__repr__ s !^^ 4 4d6G6G6IJJr
c z | j | }t | r t d d|j dd z S )N-Control characters are not allowed in cookiesz
r r )r r r replace)ro r
output_strings r js_outputzMorsel.js_output sG ))%0
!- 0 MN N $$S%0
2 2r
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 rX rc z%s=%dra )
appendrp rw rl sortedr r r* rU r r$ _flags_semispacejoin)ro r resultr r rp ru s r r zMorsel.OutputString s8 $((D$4$456 =NNEtzz|$ JC{% i Juc$:$.."5xGH !j&<w$.."5u!==> !j&<$.."5ve}EF #3t~~c 234$.."5u=> $ f%%r
r )N Set-Cookie:) r r
r __doc__rl r rq propertyrp ru rw rn r r object__ne__r r r r r r r r __str__r r r classmethodtypes GenericAlias__class_getitem__r r
r rW rW s *
I
#F, ! !%/: ]]F
+ &
(< GK 2 &B $E$6$67r
rW 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 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 ro 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# ro r strvals r value_encodezBaseCookie.value_encode s Sv~ r
Nc , |r| j | y y r )load)ro inputs r rq zBaseCookie.__init__ s IIe r
c | j |t }|j ||| t j | || y)z+Private method for setting a cookie's valueN)getrW r rm rn )ro rp
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 rW rm rn r _BaseCookie__set)ro rp ru rvalcvals r rn zBaseCookie.__setitem__ sB eV $ T3 . **51JD$ JJsD$ 'r
c g }t | j }|D ]> \ }}|j || }t | r t d |j | @ |j
| S )z"Return a string suitable for HTTP.r )r r r r r r join) ro r r sepr r rp ru value_outputs r r zBaseCookie.output sf tzz|$ JC <<v6L%l3!"QRR MM, '
xx 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)ro lr rp ru s r r zBaseCookie.__repr__ sX tzz|$ JC
HHT%++%67 8 !^^ 4 4jmDDr
c g }t | j }|D ]% \ }}|j |j | ' t | S )z(Return a string suitable for JavaScript.)r r r r _nulljoin)ro r r r rp ru s r r zBaseCookie.js_output sE tzz|$ JC MM%//%0 1 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 )ro rawdatarp ru s r r zBaseCookie.load sC 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 ]. \ }
}
} |
|k( r| | |
< | \ }}| j |
|| | |
} 0 y ) Nr Fr& r( rp r $T) r/ matchgroupendr r{ rW rl r r1 r r )ro r pattin parsed_items morsel_seenTYPE_ATTRIBUTE
TYPE_KEYVALUEr rp 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
r )Nr z
)r r
r r r r rq r rn 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 r )r1 r s r r zSimpleCookie.value_decoder s }c!!r
c 2 t | }|t | fS r )r r$ r s r r zSimpleCookie.value_encodeu s Svf~%%r
N)r r
r r r r r r
r r r k s "&r
r ),r restringr __all__r r r r Exceptionr
ascii_lettersdigits _LegalChars_UnescapedCharsr rangemapordr" r compileescape fullmatchr r r r$ subr0 r, r1 _weekdayname
_monthnamerU rm rW _LegalKeyChars_LegalValueCharsASCIIVERBOSEr r r )r s 0r r s NXz
7 GG
XX
) " ""V]]25GG / E#J#c#.G*HHJH1 (Q,HJ HeIv
7YRYY{%;;<FF
"
#56 B
6 rzz89== /6 A 8
<: F@8T @8X B!G+ &
BJJ ' 2L L ^ &: &MJs
F