U
if:M
@ st d Z ddlZddlZdddgZdjZdjZdjZG d d deZ ej
ej d
Z e d Z
d d
eedeeee
D Zeeddeddi edee jZdd ZedjZdd Zdd Z dd d d d d d!gZ dd"d#d$d%d&d'd(d)d*d+d,d-g
Z de e fd.d/Z G d0d1 d1e Z!d2Z"e"d3 Z#ed4e" d5 e# d6 ej$ej%B Z&G d7d de Z'G d8d de'Z(dS )9a.
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 @ s e Zd ZdS )r N)__name__
__module__ __qualname__ r
r
1/opt/alt/python38/lib64/python3.8/http/cookies.pyr s z!#$%&'*+-.^_`|~:z
()/<=>?@[]{}c C s i | ]}|d | qS )z\%03or
).0nr
r
r
s r "\"\z\\z[%s]+c C s* | dkst | r| S d| t d S dS )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 _Translatorstrr
r
r _quote s r z\\(?:([0-3][0-7][0-7])|(.))c C s& | d rt t| d dS | d S d S )N )chrint)mr
r
r _unquote_replace s r c C sJ | d kst | dk r| S | d dks0| d dkr4| S | dd } tt| S )Nr r r r )len _unquote_subr r r
r
r _unquote s r# ZMonZTueZWedZThuZFriZSatZSunZJanZFebZMarZAprZMayZJunZJulZAugZSepZOctZNovZDecc 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 r( 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- Zd4d.d/Zd5d0d1ZdS )6MorselaC 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.
expiresPathCommentZDomainzMax-AgeZSecureZHttpOnlyZVersionZSameSite) r* pathcommentZdomainmax-agesecurehttponlyversionZsamesiter0 r1 c C s0 d | _ | _| _| jD ]}t| |d qd S )Nr )_key_value _coded_value _reserveddict __setitem__)selfkeyr
r
r __init__ s
zMorsel.__init__c C s | j S N)r3 r9 r
r
r r: s z
Morsel.keyc C s | j S r< )r4 r= r
r
r value s z Morsel.valuec C s | j S r< )r5 r= r
r
r coded_value s zMorsel.coded_valuec C s2 | }|| jkr td|f t| || d S NzInvalid attribute %r)lowerr6 r r7 r8 )r9 KVr
r
r r8 " s
zMorsel.__setitem__Nc C s. | }|| jkr td|f t| ||S r@ )rA r6 r r7
setdefault)r9 r: valr
r
r rD ( s
zMorsel.setdefaultc C s> t |tstS t| |o<| j|jko<| j|jko<| j|jkS r< )
isinstancer) NotImplementedr7 __eq__r4 r3 r5 r9 Zmorselr
r
r rH . s
z
Morsel.__eq__c C s$ t }t|| |j| j |S r< )r) r7 update__dict__rI r
r
r copy8 s z Morsel.copyc C sR i }t | D ]0\}}| }|| jkr8td|f |||< qt | | d S r@ )r7 itemsrA r6 r rJ )r9 valuesdatar: rE r
r
r rJ > s
z
Morsel.updatec C s | | jkS r< )rA r6 )r9 rB r
r
r
isReservedKeyG s zMorsel.isReservedKeyc C sH | | jkr td|f t|s2td|f || _|| _|| _d S )Nz Attempt to set a reserved key %rzIllegal key %r)rA r6 r r r3 r4 r5 )r9 r: rE Z coded_valr
r
r setJ s z
Morsel.setc C s | j | j| jdS )N)r: r> r? r3 r4 r5 r= r
r
r __getstate__U s zMorsel.__getstate__c C s" |d | _ |d | _|d | _d S )Nr: r> r? rR )r9 stater
r
r __setstate__\ s
zMorsel.__setstate__ Set-Cookie:c C s d|| |f S )Nz%s %s) OutputString)r9 attrsheaderr
r
r outputa s z
Morsel.outputc C s d| j j| f S )N<%s: %s>) __class__r rW r= r
r
r __repr__f s zMorsel.__repr__c C s d| |dd S )Nz
r r )rW replace)r9 rX r
r
r js_outputi s zMorsel.js_outputc C s$ g }|j }|d| j| jf |d kr,| j}t| }|D ]\}}|dkrNq<||krXq<|dkrt|tr|d| j| t|f q<|dkrt|tr|d| j| |f q<|dkrt|t r|d| j| t
|f q<|| j kr|r|t | j| q<|d| j| |f q r
r
r rW s s, zMorsel.OutputString)N)NrV )N)N)r r r __doc__r6 rc r; propertyr: r> r? r8 rD rH object__ne__rL rJ rP rQ rS rU rZ __str__r] r_ rW r
r
r
r r) sD
r) 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
r9 rE 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 r9 rE Zstrvalr
r
r value_encode s zBaseCookie.value_encodeNc C s |r| | d S r< )load)r9 inputr
r
r r; s zBaseCookie.__init__c C s. | |t }|||| t| || dS )z+Private method for setting a cookie's valueN)getr) rQ r7 r8 )r9 r: Z
real_valuer? Mr
r
r Z__set s zBaseCookie.__setc C s: t |trt| || n | |\}}| ||| dS )z Dictionary style assignment.N)rF r) r7 r8 rn _BaseCookie__set)r9 r: r> rvalcvalr
r
r r8 s
zBaseCookie.__setitem__rV
c C s: g }t | }|D ]\}}|||| q||S )z"Return a string suitable for HTTP.)rb rM ra rZ join)r9 rX rY sepre rM r: r> r
r
r rZ s
zBaseCookie.outputc C sJ g }t | }|D ] \}}|d|t|jf qd| jjt|f S )Nr` r[ )rb rM ra reprr> r\ r
_spacejoin)r9 lrM r: r> r
r
r r] s
zBaseCookie.__repr__c C s6 g }t | }|D ]\}}||| qt|S )z(Return a string suitable for JavaScript.)rb rM ra r_ _nulljoin)r9 rX re rM r: r> r
r
r r_ s
zBaseCookie.js_outputc C s4 t |tr| | n| D ]\}}|| |< q 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)rF r _BaseCookie__parse_stringrM )r9 Zrawdatar: r> r
r
r ro s
zBaseCookie.loadc C s d}t |}g }d}d}d}d| kr2|k r n n|||} | sJq | d| d }
} | d}|
d dkr|s|q |||
dd | f q |
tjkr|sd S | d kr|
tjkr|||
df qd S n|||
t | f q | d k r|||
|
| f d}q d S q d } |D ]Z\}
}
} |
|krP| d k sFt | | |
< n,|
|ks^t | \}}| |
|| | |
} q$d S ) Nr Fr r r: rE $T)
r! matchgroupendra rA r) r6 rc r# rl AssertionErrorrs )r9 r Zpattir
Z parsed_itemsZ morsel_seenZTYPE_ATTRIBUTEZ
TYPE_KEYVALUEr r: r> rr tprt ru r
r
r Z__parse_string sJ
zBaseCookie.__parse_string)N)NrV rv )N)r r r rf rl rn r; rs r8 rZ rj r] r_ ro _CookiePatternr} r
r
r
r r s
c @ s e Zd ZdZdd Zdd 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 C s t ||fS r< )r# rk r
r
r rl J s zSimpleCookie.value_decodec C s t |}|t|fS r< )r r rm r
r
r rn M s zSimpleCookie.value_encodeN)r r r rf rl rn r
r
r
r r C s ))rf restring__all__rw r| rd rz Exceptionr Z
ascii_lettersZdigitsZ _LegalCharsZ_UnescapedCharsrQ rangemapordr rJ compileescape fullmatchr r subr" r r# Z _weekdaynameZ
_monthnamer( r7 r) Z_LegalKeyCharsZ_LegalValueCharsASCIIVERBOSEr r r r
r
r
r ' sr ]
4