v"S d Z ddlZddlZddlZg dZdj Zdj Zdj Z G d de Z
ej ej z d z Z
e
d
z Zd e ed e eee z
D Ze ed
d ed di ej d ej e
z j Z ej d Zd Zd Z ej d j 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 ej' ej( z Z) G d" d#e# Z* G d$ d%e* Z+dS )&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 ZdS )r N)__name__
__module__ __qualname__ 3/opt/alt/python311/lib64/python3.11/http/cookies.pyr r s Dr
r z!#$%&'*+-.^_`|~:z
()/<=>?@[]{}c i | ]}|d |z S )z\%03or ).0ns r
r s4 J J J (Q, J J Jr
"\"\z\\z[%s]+z[\x00-\x1F\x7F]c 4 t d | D S )zhDetects control characters within a value.
Supports any type, as header values can be any type.
c 3 d K | ]+}t t | V ,d S N)_control_character_researchstr)r vs r z)_has_control_character.. s7 AA$++CFF33AAAAAAr
)any)vals r _has_control_characterr! s! AASAAA A AAr
c h | t | r| S d| 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.
Nr )
_is_legal_key translate _Translatorr s r _quoter' s6 {mC(({
S]];///#55r
z\\(?:([0-3][0-7][0-7])|(.))c h | d r#t t | d d S | d S )N )chrint)ms r _unquote_replacer/ s1 t 3qtQ<< t r
c | t | dk r| S | d dk s | d dk r| S | dd } t t | S )Nr+ r r r) )len _unquote_subr/ r& s r _unquoter4 s\ {c#hhll
1v}}B3
ad)C (# . ..r
)MonTueWedThuFriSatSun)
NJanFebMarAprMayJunJulAugSepOctNovDecc ddl m}m } | } ||| z \ }}}} }
} } }
}d|| ||| || |
| fz S )Nr )gmtimetimez#%s, %02d %3s %4d %02d:%02d:%02d GMT)rJ rI )future weekdayname monthnamerI rJ nowyearmonthdayhhmmsswdyzs r _getdaterX su !!!!!!!!
$&&C-3VC&L-A-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 dS )#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) r[ pathcommentdomainmax-agesecurehttponlyversionsamesiterg rh c | d x| _ x| _ | _ | j D ] }t | |d d S )Nr )_key_value _coded_value _reserveddict __setitem__)selfkeys r __init__zMorsel.__init__ sP 6:: :DK$"3 > , ,C T3 + + + + , ,r
c | j S r )rl rr s r rs z
Morsel.key s
yr
c | j S r )rm rv s r valuez Morsel.value$ s
{r
c | j S r )rn rv s r coded_valuezMorsel.coded_value( s r
c | }|| j vrt d| t || rt d|d| t | || d S NInvalid attribute .Control characters are not allowed in cookies r )lowerro r r! rp rq )rr KVs r rq zMorsel.__setitem__, s
GGIIDN"" + ;<< < !!Q ' ' \ Zq Z ZUV Z Z[[ [ q!$$$$$r
Nc | }|| j vrt d| t || rt d|d| t | || S r| )r ro r r! rp
setdefault)rr rs r s r r zMorsel.setdefault4 sz iikk dn $ $ + =>> > !#s + + c +WZWZWZ\_\_ abb btS#...r
c t |t st S t | | o/| j |j k o | j |j k o| j |j k S r )
isinstancerZ NotImplementedrp __eq__rm rl rn rr morsels r r z
Morsel.__eq__< sg &&)) "! ! D&)) 9 v},9 V[(9 !V%88 :r
c t }t || |j | j |S r )rZ rp update__dict__r s r copyz Morsel.copyF s< FD!!! t}---
r
c i }t | D ]9\ }}| }|| j vrt d| |||< :t | | d S )Nr} )rp itemsr ro r r )rr valuesdatars r s r r z
Morsel.updateL s V **,, HC))++C$.((!kCC"ABBBDII D$ r
c 8 | | j v S r )r ro )rr r s r
isReservedKeyzMorsel.isReservedKeyU s wwyyDN**r
c | | j v rt d| t | st d| t ||| rt d|d|d| || _ || _ || _ d S )Nz Attempt to set a reserved key z Illegal key r~ r )r ro r r# r! rl rm rn )rr rs r coded_vals r setz
Morsel.setX s 99;;$. ( ( +CC IJJ J S!! 9 +## 788 8 !#sI 6 6 c +LOCCQTQTQTV_V_ac c
c %r
c , | j | j | j dS )N)rs rx rz rl rm rn rv s r __getstate__zMorsel.__getstate__f s! 9[ ,
r
c T |d | _ |d | _ |d | _ d S )Nrs rx rz r )rr states r __setstate__zMorsel.__setstate__m s+ %L Gn !- 0r
Set-Cookie:c 6 |d| | S )Nr ) OutputString)rr attrsheaders r outputz
Morsel.outputr s" &&$"3"3E":":":;;r
c L d| j j d| dS )N<: >) __class__r r rv s r __repr__zMorsel.__repr__w s, !^ 4 4 4d6G6G6I6I6I6IJJr
c Z d| | dd z S )Nz
r r )r replace)rr r s r js_outputzMorsel.js_outputz s4 ''//U;;
= =r
c g }|j } || j d| j || j }t | }|D ] \ }}|dk r
||vr|dk r>t
|t r) || j | dt | V|dk r1t
|t r |d| j | |fz |dk r>t
|t r) || j | dt | || j v r'|r# |t | j | || j | d| t | S )N=r r[ rf z%s=%drd )
appendrs rz ro sortedr r r- rX r r' _flags_semispacejoin)rr r resultr r rs rx s r r zMorsel.OutputString s $(((D$4$45666 =NEtzz||$$ ? ?JC{{% i Juc$:$: $."5"5"5xGHHHH !!j&<&<!w$."5u!==>>>> !!j&<&<!$."5"5"5ve}}}EFFFF ## 5F3t~c 233444$."5"5"5uu=>>>> f%%%r
r )Nr ) r r
r __doc__ro r rt propertyrs rx rz rq r r object__ne__r r r r r r r __str__r r r classmethodtypes GenericAlias__class_getitem__r r
r rZ rZ s *
I
#F, , , X X ! ! X!% % %/ / / /: : : ]F + + + & & &
1 1 1
< < < < GK K K= = = = & & & &B $ E$677r
rZ 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 \ e Zd ZdZd Zd ZddZd Zd Zdd
Z e Z
d Z dd Z d
Z
efdZdS )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 rr 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& rr r strvals r value_encodezBaseCookie.value_encode s Sv~ r
Nc 8 |r| | d S d S r )load)rr inputs r rt zBaseCookie.__init__ s, IIe r
c | |t }| ||| t | || dS )z+Private method for setting a cookie's valueN)getrZ r rp rq )rr rs
real_valuerz Ms r __setzBaseCookie.__set sM HHS&(( # # c:{+++ sA&&&&&r
c t |t r t | || dS | | \ }}| ||| dS )z Dictionary style assignment.N)r rZ rp rq r _BaseCookie__set)rr rs rx rvalcvals r rq zBaseCookie.__setitem__ se eV $ $ ( T3 . . . . . **511JD$ JJsD$ ' ' ' ' 'r
r
c g }t | }|D ]N\ }}| || }t | rt d | | O| | S )z"Return a string suitable for HTTP.z-Control characters are not allowed in cookies)r r r r! r r join) rr r r sepr r rs rx value_outputs r r zBaseCookie.output s tzz||$$ ( (JC <<v66L%l33
S!"QRRR MM, ' ' ' 'xx r
c g }t | }|D ]1\ }}| |dt |j 2d| j j dt | dS )Nr r r r )r r r reprrx r r
_spacejoin)rr lr rs rx s r r zBaseCookie.__repr__ s tzz||$$ 9 9JC
HHT%+%6%6%67 8 8 8 8 9 !^ 4 4 4jmmmmDDr
c g }t | }|D ]-\ }}| | | .t | S )z(Return a string suitable for JavaScript.)r r r r _nulljoin)rr r r r rs rx s r r zBaseCookie.js_output s^ tzz||$$ 2 2JC MM%//%00 1 1 1 1 r
c t |t r| | n | D ]
\ }}|| |< dS )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 )rr rawdatars rx s r r zBaseCookie.load sZ gs # # " ( ( ( ( &mmoo
"
"
U !S r
c d}t | }g }d}d}d}d|cxk r|k rVn nR| || } | sn8| d | d } }
| d }|
d dk r$|sz| ||
dd | f n|
t j v rg|sd S | ;|
t j v r| ||
df nZd S | ||
t | f n2| .| ||
|
| f d}nd S d|cxk r|k Pn d } |D ]B\ }
}
} |
|k r
| J | | |
< |
|k sJ | \ }}| |
|| | |
} Cd S ) Nr Fr) r+ rs r $T) r2 matchgroupendr r rZ ro r r4 r r )rr r pattir parsed_items morsel_seenTYPE_ATTRIBUTE
TYPE_KEYVALUEr rs rx r tpr r s r __parse_stringzBaseCookie.__parse_string s-
HH
1jjjjqjjjjjJJsA&&E
U++U[[-?-?C ! A1v}}" ##^SWe$DEEEE 000" F=yy{{fm33$++^S$,GHHHH '' huoo(NOOOO" ##]C9J9J59Q9Q$RSSS " E 1jjjjqjjjjJ
* NBU^##}}} #]**** "
d
3d+++I r
r )Nr r )r r
r r r r rt r rq r r r r r _CookiePatternr r r
r r r s 11 ' ' ' ( ( ( GE E E! ! ! ! (6 : : : : : : r
r c e Zd ZdZd Zd ZdS )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 )r4 r s r r zSimpleCookie.value_decode` s }}c!!r
c B t | }|t | fS r )r r' r s r r zSimpleCookie.value_encodec s Svf~~%%r
N)r r
r r r r r r
r r r Y s< " " "& & & & &r
r ),r restringr __all__r r r r Exceptionr
ascii_lettersdigits _LegalChars_UnescapedCharsr rangemapordr% r compileescape fullmatchr# r r! r' subr3 r/ r4 _weekdayname
_monthnamerX rp rZ _LegalKeyChars_LegalValueCharsASCIIVERBOSEr r r r r
r r s NX Xz
7
7
7 G
X
) " "V]25GG /J JEE#JJ##cc#.G.G*H*HHJ J J CHHeCIIv
7YRY{%;%;;<<F
"
#566 B B B
6
6
6 rz899= / / /6 A@@ 8 8 8
<: F F F Fp8 p8 p8 p8 p8T p8 p8 p8x B!G+ "
BJ # .L L L L L L L L ^ & & & & &: & & & & &r