U
e5dO
@ st d Z ddlZddlZdddgZdjZdjZdjZG d d deZ ej
ej d
Z e d Z
d d
eedeeee
D Zeeddeddi edee jZdd ZedZedZdd Zddd 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 d/d0 d0e Z d1Z!e!d2 Z"ed3e! d4 e" d5 ej#ej$B Z%G d6d de Z&G d7d de&Z'dS )8a.
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
$/usr/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]z[\\].c C sN | d kst | dk r| S | d dks0| d dkr4| S | dd } d}t | }g }d| krf|k rFn nt| |}t| |}|s|s|| |d qFd }}|r|d}|r|d}|r|r||k r|| || || |d |d }qP|| || |tt| |d |d d |d }qPt|S )N r r ) len
_OctalPattsearch
_QuotePattappendstartchrint _nulljoin)r ir
resZo_matchZq_matchjkr
r
r _unquote s6
$
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 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- 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) r2 pathcommentZdomainmax-agesecurehttponlyversionZsamesiter8 r9 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)r; rA r
r
r rB ( s z
Morsel.keyc C s | j S rD )r< rE r
r
r value, s z Morsel.valuec C s | j S rD )r= rE r
r
r coded_value0 s zMorsel.coded_valuec C s2 | }|| jkr td|f t| || d S NzInvalid attribute %r)lowerr> r r? r@ )rA KVr
r
r r@ 4 s
zMorsel.__setitem__Nc C s. | }|| jkr td|f t| ||S rH )rI r> r r?
setdefault)rA rB valr
r
r rL : s
zMorsel.setdefaultc C s> t |tstS t| |o<| j|jko<| j|jko<| j|jkS rD )
isinstancer1 NotImplementedr? __eq__r< r; r= rA Zmorselr
r
r rP @ s
z
Morsel.__eq__c C s$ t }t|| |j| j |S rD )r1 r? update__dict__rQ r
r
r copyJ s z Morsel.copyc C sR i }t | D ]0\}}| }|| jkr8td|f |||< qt | | d S rH )r? itemsrI r> r rR )rA valuesdatarB rM r
r
r rR P s
z
Morsel.updatec C s | | jkS rD )rI r> )rA rJ r
r
r
isReservedKeyY s zMorsel.isReservedKeyc C sH | | jkr td|f t|s2td|f || _|| _|| _d S )Nz Attempt to set a reserved key %rzIllegal key %r)rI r> r r r; r< r= )rA rB rM Z coded_valr
r
r set\ s z
Morsel.setc C s | j | j| jdS )N)rB rF rG r; r< r= rE r
r
r __getstate__g s zMorsel.__getstate__c C s" |d | _ |d | _|d | _d S )NrB rF rG rZ )rA stater
r
r __setstate__n s
zMorsel.__setstate__ Set-Cookie:c C s d|| |f S )Nz%s %s) OutputString)rA attrsheaderr
r
r outputs s z
Morsel.outputc C s d| j j| f S )N<%s: %s>) __class__r r_ rE r
r
r __repr__x s zMorsel.__repr__c C s d| |dd S )Nz
r r )r_ replace)rA r` r
r
r js_output{ 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 sortedrU rN r% r0 r r _flags_semispacejoin)rA r` resultr" rU rB rF r
r
r r_ s, zMorsel.OutputString)N)Nr^ )N)N)r r r __doc__r> rj rC propertyrB rF rG r@ rL rP object__ne__rT rR rX rY r[ r] rb __str__re rg r_ r
r
r
r r1 sD
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
rA rM 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 rA rM Zstrvalr
r
r value_encode s zBaseCookie.value_encodeNc C s |r| | d S rD )load)rA inputr
r
r rC s zBaseCookie.__init__c C s. | |t }|||| t| || dS )z+Private method for setting a cookie's valueN)getr1 rY r? r@ )rA rB Z
real_valuerG Mr
r
r Z__set s zBaseCookie.__setc C s: t |trt| || n | |\}}| ||| dS )z Dictionary style assignment.N)rN r1 r? r@ ru _BaseCookie__set)rA rB rF rvalcvalr
r
r r@ s
zBaseCookie.__setitem__r^
c C s: g }t | }|D ]\}}|||| q||S )z"Return a string suitable for HTTP.)ri rU r" rb join)rA r` ra seprl rU rB rF r
r
r rb s
zBaseCookie.outputc C sJ g }t | }|D ] \}}|d|t|jf qd| jjt|f S )Nrh rc )ri rU r" reprrF rd r
_spacejoin)rA lrU rB rF r
r
r re s
zBaseCookie.__repr__c C s6 g }t | }|D ]\}}||| qt|S )z(Return a string suitable for JavaScript.)ri rU r" rg r& )rA r` rl rU rB rF r
r
r rg 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)rN r _BaseCookie__parse_stringrU )rA ZrawdatarB rF r
r
r rv
s
zBaseCookie.loadc C sh 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 ]>\}
}
} |
|krB| | |
< n | \}}| |
|| | |
} q$d S ) Nr Fr r rB rM $T) r matchgroupendr" rI r1 r> rj r+ rs rz )rA r Zpattr' r
Z parsed_itemsZ morsel_seenZTYPE_ATTRIBUTEZ
TYPE_KEYVALUEr rB rF ry tpr{ r| r
r
r Z__parse_string sF
zBaseCookie.__parse_string)N)Nr^ r} )N)r r r rm rs ru rC rz r@ rb rq re rg rv _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 rD )r+ rr r
r
r rs \ s zSimpleCookie.value_decodec C s t |}|t|fS rD )r r rt r
r
r ru _ s zSimpleCookie.value_encodeN)r r r rm rs ru r
r
r
r r U s )(rm restring__all__r~ r& rk r Exceptionr Z
ascii_lettersZdigitsZ _LegalCharsZ_UnescapedCharsrY rangemapordr rR compileescape fullmatchr r r r! r+ Z _weekdaynameZ
_monthnamer0 r? r1 Z_LegalKeyCharsZ_LegalValueCharsASCIIVERBOSEr r r r
r
r
r ' sr ]
2 4