o
0iQ @ sl d Z ddlZddlZddlZg dZdjZdjZdjZG dd de Z
ej ej d Z
e
d
Zd d eed
eeee D Zeeddeddi edee
jZedZdd Zdd Zedj Z dd Z dd Z g d Z g d Z!de e!fd d Z"G d!d" d"e#Z$d#Z%e%d$ Z&ed%e% d& e& d' ej'ej(B Z)G d(d) d)e#Z*G d*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 @ s e Zd ZdS )r N)__name__
__module__ __qualname__ r
r
3/opt/alt/python310/lib64/python3.10/http/cookies.pyr s r z!#$%&'*+-.^_`|~:z
()/<=>?@[]{}c C s i | ]}|d | qS )z\%03or
).0nr
r
r
s r "\"\z\\z[%s]+z[\x00-\x1F\x7F]c G s t dd | D S )zhDetects control characters within a value.
Supports any type, as header values can be any type.
c s s | ]
}t t|V qd S N)_control_character_researchstr)r vr
r
r s z)_has_control_character..)any)valr
r
r _has_control_character s r c C s& | du st | r
| S d| t d 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 r
r
r _quote s r z\\(?:([0-3][0-7][0-7])|(.))c C s" | d r
t t| d dS | d S )N )chrint)mr
r
r _unquote_replace s r' c C sJ | d u s
t | dk r | S | d dks| d dkr| S | dd } tt| S )Nr# r r r! )len _unquote_subr' r r
r
r _unquote s
r+ )ZMonZTueZWedZThuZFriZSatZSun)
NZJanZFebZMarZAprZMayZJunZJulZAugZSepZOctZNovZDecc C sR ddl m}m } | }||| \ }}}} }
} } }
}d|| ||| || |
| f S )Nr )gmtimetimez#%s, %02d %3s %4d %02d:%02d:%02d GMT)r- r, )ZfutureZ weekdaynameZ monthnamer, r- ZnowZyearZmonthZdayZhhZmmZssZwdyzr
r
r _getdate s r0 c
@ s e Zd ZdZdddddddd d
d Zd d
hZdd Zedd Zedd Z edd Z
dd Z d2ddZ dd Z
ejZd d Zd d Zd!d" Zd#d$ Zd%d& Zd'd( Zd3d*d+ZeZd,d- Zd2d.d/Zd2d0d1Zee j Z dS )4MorselaC 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.
expiresZPathCommentZDomainzMax-AgeZSecureZHttpOnlyZVersionZSameSite) r2 pathcommentZdomainmax-agesecurehttponlyversionZsamesiter7 r8 c C s0 d | _ | _| _| jD ] }t| |d q d S )Nr )_key_value _coded_value _reserveddict __setitem__)selfkeyr
r
r __init__ s
zMorsel.__init__c C | j S r )r: r@ r
r
r rA z
Morsel.keyc C rC r )r; rD r
r
r value$ rE z Morsel.valuec C rC r )r< rD r
r
r coded_value( rE zMorsel.coded_valuec C sP | }|| jvrtd|f t||r td|d|t| || d S )NInvalid attribute %rz.Control characters are not allowed in cookies r )lowerr= r r r> r? )r@ KVr
r
r r? , s
zMorsel.__setitem__Nc C sH | }|| jvrtd|f t||r td||f t| ||S )NrH z3Control characters are not allowed in cookies %r %r)rI r= r r r>
setdefault)r@ rA r r
r
r rL 4 s
zMorsel.setdefaultc C s> t |tstS t| |o | j|jko | j|jko | j|jkS r )
isinstancer1 NotImplementedr> __eq__r; r: r< r@ Zmorselr
r
r rO < s
z
Morsel.__eq__c C s$ t }t|| |j| j |S r )r1 r> update__dict__rP r
r
r copyF s z Morsel.copyc C sR i }t | D ]\}}| }|| jvr td|f |||< qt | | d S )NrH )r> itemsrI r= r rQ )r@ valuesdatarA r r
r
r rQ L s
z
Morsel.updatec C s | | jv S r )rI r= )r@ rJ r
r
r
isReservedKeyU s zMorsel.isReservedKeyc C sf | | jv rtd|f t|std|f t|||r(td|||f || _|| _|| _d S )Nz Attempt to set a reserved key %rzIllegal key %rz6Control characters are not allowed in cookies %r %r %r)rI r= r r r r: r; r< )r@ rA r Z coded_valr
r
r setX s
z
Morsel.setc C s | j | j| jdS )N)rA rF rG r: r; r< rD r
r
r __getstate__f s zMorsel.__getstate__c C s" |d | _ |d | _|d | _d S )NrA rF rG rY )r@ stater
r
r __setstate__m s
zMorsel.__setstate__ Set-Cookie:c C s d|| |f S )Nz%s %s) OutputString)r@ attrsheaderr
r
r outputr s z
Morsel.outputc C s d| j j| f S )N<%s: %s>) __class__r r^ rD r
r
r __repr__w s zMorsel.__repr__c C s d| |dd S )Nz
r r )r^ replace)r@ r_ r
r
r js_outputz s zMorsel.js_outputc C s g }|j }|d| j| jf |d u r| j}t| }|D ]m\}}|dkr'q ||vr,q |dkrCt|trC|d| j| t|f q |dkrXt|trX|d| j| |f q |dkrot|t ro|d| j| t
|f q || j v r|r|t | j| q |d| j| |f q t |S )N%s=%sr r2 r6 z%s=%dr5 )
appendrA rG r= sortedrT rM r% r0 r r _flags_semispacejoin)r@ r_ resultrh rT rA rF r
r
r r^ s.
zMorsel.OutputStringr )Nr] ) r r r __doc__r= rj rB propertyrA rF rG r? rL rO object__ne__rS rQ rW rX rZ r\ ra __str__rd rf r^ classmethodtypes GenericAlias__class_getitem__r
r
r
r r1 sH
!r1 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 @ sn e Zd ZdZdd Zdd ZdddZd d
Zd d ZdddZ e Z
dd Z dddZ dd Z
efddZdS )r z'A container class for a set of Morsels.c C s ||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
r@ r r
r
r value_decode s zBaseCookie.value_decodec C s 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 r@ r Zstrvalr
r
r value_encode s zBaseCookie.value_encodeNc C s |r | | d S d S r )load)r@ inputr
r
r rB s zBaseCookie.__init__c C s. | |t }|||| t| || dS )z+Private method for setting a cookie's valueN)getr1 rX r> r? )r@ rA Z
real_valuerG Mr
r
r Z__set s zBaseCookie.__setc C s< t |trt| || dS | |\}}| ||| dS )z Dictionary style assignment.N)rM r1 r> r? ry _BaseCookie__set)r@ rA rF rvalcvalr
r
r r? s
zBaseCookie.__setitem__r]
c C sN g }t | }|D ]\}}|||}t|r td|| q
||S )z"Return a string suitable for HTTP.z-Control characters are not allowed in cookies)ri rT ra r r rh join) r@ r_ r` seprl rT rA rF Z value_outputr
r
r ra s
zBaseCookie.outputc C sJ g }t | }|D ]\}}|d|t|jf q
d| jjt|f S )Nrg rb )ri rT rh reprrF rc r
_spacejoin)r@ lrT rA rF r
r
r rd s
zBaseCookie.__repr__c C s6 g }t | }|D ] \}}||| q
t|S )z(Return a string suitable for JavaScript.)ri rT rh rf _nulljoin)r@ r_ rl rT rA rF r
r
r rf s
zBaseCookie.js_outputc C s6 t |tr | | dS | D ]\}}|| |< qdS )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)rM r _BaseCookie__parse_stringrT )r@ ZrawdatarA rF r
r
r rz s
zBaseCookie.loadc C sp d}t |}g }d}d}d}d| kr|k rn nz|||} | s#nq| d| d}
} | d}|
d dkrI|s r1 Z_LegalKeyCharsZ_LegalValueCharsASCIIVERBOSEr r r r
r
r
r s\ &]
=