3
sj]W
@ s d Z ddlZddlZdddgZdjZdjZdjZd d
ZG d d de Z
ej ej d Z
e
d
Zdd eedeeee D Zejeddeddi ejdeje
jZejdZdd Zdd Zejdj Z d d Z d d Z d d!d"d#d$d%d&gZ dd'd(d)d*d+d,d-d.d/d0d1d2g
Z!de e!fd3d4Z"G d5d6 d6e#Z$d7Z%e%d8 Z&ejd9e% d: e& d; ej'ej(B Z)G d<d de#Z*G d=d de*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 C s$ dd l }d| }|j|tdd d S )Nr zvThe .%s setter is deprecated. The attribute will be read-only in future releases. Please use the set() method instead. )
stacklevel)warningswarnDeprecationWarning)setterr msg r /usr/lib64/python3.6/cookies.py_warn_deprecated_setter s r c @ s e Zd ZdS )r N)__name__
__module__ __qualname__r r r r r s z!#$%&'*+-.^_`|~:z
()/<=>?@[]{}c C s i | ]}d | |qS )z\%03or ).0nr r r
<dictcomp> s r "z\"\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 jt|V qd S )N)_control_character_researchstr)r vr r r <genexpr> s z)_has_control_character.<locals>.<genexpr>)any)valr r r _has_control_character s r! c C s* | dkst | r| S d| jt 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 _Translator)r r 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& r- )len _unquote_subr, )r r r r _unquote s r0 ZMonZTueZWedZThuZFriZSatZSunZJanZFebZMarZAprZMayZJunZJulZAugZSepZOctZNovZDecc C sR ddl m}m } | }||| \ }}}} }
} } }
}d|| ||| || |
| f S )Nr )gmtimetimez#%s, %02d %3s %4d %02d:%02d:%02d GMT)r2 r1 )ZfutureZ weekdaynameZ monthnamer1 r2 ZnowZyearZmonthZdayZhhZmmZssZwdyzr r r _getdate s
r5 c @ s
e Zd ZdZdddddddd d
Zd d hZd
d Zedd Zej dd Zedd Z
e
j dd Z
edd Z e j dd Z dd Z d6dd Z
d d ZejZd d Zd!d" Zd#d$ Zd%d& Zefd'd(Zd)d* Zd+d, Zd7d.d/ZeZd0d1 Zd8d2d3Z d9d4d5Z dS ):Morsela 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. This is most useful when Python
objects are pickled for network transit.
expiresZPathCommentZDomainzMax-AgeZSecureZHttpOnlyZVersion)r7 pathcommentZdomainzmax-agesecurehttponlyversionr; r< c C s4 d | _ | _| _x | jD ]}tj| |d qW d S )Nr )_key_value _coded_value _reserveddict __setitem__)selfkeyr r r __init__ s zMorsel.__init__c C s | j S )N)r> )rD r r r rE % s z
Morsel.keyc C s t d || _d S )NrE )r r> )rD rE r r r rE ) s c C s | j S )N)r? )rD r r r value. s z Morsel.valuec C s t d || _d S )NrG )r r? )rD rG r r r rG 2 s c C s | j S )N)r@ )rD r r r coded_value7 s zMorsel.coded_valuec C s t d || _d S )NrH )r r@ )rD rH r r r rH ; s c C sP |j }|| jkr td|f t||r>td|d|tj| || d S )NzInvalid attribute %rz.Control characters are not allowed in cookies r )lowerrA r r! rB rC )rD KVr r r rC @ s
zMorsel.__setitem__Nc C sH |j }|| jkr td|f t||r:td||f tj| ||S )NzInvalid attribute %rz3Control characters are not allowed in cookies %r %r)rI rA r r! rB
setdefault)rD rE r r r r rL H s
zMorsel.setdefaultc C s> t |tstS tj| |o<| j|jko<| j|jko<| j|jkS )N)
isinstancer6 NotImplementedrB __eq__r? r> r@ )rD morselr r r rO P s
z
Morsel.__eq__c C s$ t }tj|| |jj| j |S )N)r6 rB update__dict__)rD rP r r r copyZ s z Morsel.copyc C st i }x^t |j D ]N\}}|j }|| jkr:td|f t||rXtd|d||||< qW t j| | d S )NzInvalid attribute %rz.Control characters are not allowed in cookies r )rB itemsrI rA r r! rQ )rD valuesdatarE r r r r rQ ` s
z
Morsel.updatec C s | j | | S )N)rQ )rD rU r r r __ior__l s
zMorsel.__ior__c C s |j | jkS )N)rI rA )rD rJ r r r
isReservedKeyp s zMorsel.isReservedKeyc C s |t kr dd l}|jdtdd |j | jkr<td|f t|sRtd|f t|||rptd|||f || _ || _
|| _ d S )Nr zSLegalChars parameter is deprecated, ignored and will be removed in future versions.r( )r z Attempt to set a reserved key %rzIllegal key %rz6Control characters are not allowed in cookies %r %r %r) _LegalCharsr r
r rI rA r r" r! r> r? r@ )rD rE r Z coded_valZ
LegalCharsr r r r sets s z
Morsel.setc C s | j | j| jdS )N)rE rG rH )r> r? r@ )rD r r r __getstate__ s zMorsel.__getstate__c C sT |d }|d }|d }t |||r>td|d|d||| _|| _|| _d S )NrE rG rH z.Control characters are not allowed in cookies r )r! r r> r? r@ )rD staterE rG rH r r r __setstate__ s zMorsel.__setstate__ Set-Cookie:c C s d|| j |f S )Nz%s %s) OutputString)rD attrsheaderr r r output s z
Morsel.outputc C s d| j j| j f S )Nz<%s: %s>) __class__r r_ )rD r r r __repr__ s zMorsel.__repr__c C s* | j |}t|rtdd|jdd S )Nz-Control characters are not allowed in cookiesz
<script type="text/javascript">
<!-- begin hiding
document.cookie = "%s";
// end hiding -->
</script>
r z\")r_ r! r replace)rD r` Z
output_stringr r r js_output s
zMorsel.js_outputc C s( g }|j }|d| j| jf |d kr,| j}t| j }x|D ]\}}|dkrPq>||krZq>|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>W t |S )Nz%s=%sr r7 zmax-agez%s=%dr: )
appendrE rH rA sortedrT rM r* r5 r r% _flags_semispacejoin)rD r` resultrg rT rE rG r r r r_ s, zMorsel.OutputString)N)Nr^ )N)N) r r r __doc__rA ri rF propertyrE r rG rH rC rL rO object__ne__rS rQ rW rX rY rZ r[ r] rb __str__rd rf r_ r r r r r6 sB
r6 z,\w\d!#%&'~_`><@,:/\$\*\+\-\.\^\|\)\(\?\}\{\=z\[\]z
\s* # Optional whitespace at start of cookie
(?P<key> # 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<val> # 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 )rD 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 )rD r strvalr r r value_encode s zBaseCookie.value_encodeNc C s |r| j | d S )N)load)rD inputr r r rF s zBaseCookie.__init__c C s. | j |t }|j||| tj| || dS )z+Private method for setting a cookie's valueN)getr6 rZ rB rC )rD rE Z
real_valuerH Mr r r Z__set s zBaseCookie.__setc C s: t |trtj| || n | j|\}}| j||| dS )z Dictionary style assignment.N)rM r6 rB rC rs _BaseCookie__set)rD rE rG rvalcvalr r r rC s
zBaseCookie.__setitem__ Set-Cookie:
c C sR g }t | j }x6|D ].\}}|j||}t|r:td|j| qW |j|S )z"Return a string suitable for HTTP.z-Control characters are not allowed in cookies)rh rT rb r! r rg join) rD r` ra seprk rT rE rG Z value_outputr r r rb s zBaseCookie.outputc C sN g }t | j }x(|D ] \}}|jd|t|jf qW d| jjt|f S )Nz%s=%sz<%s: %s>)rh rT rg reprrG rc r
_spacejoin)rD lrT rE rG r r r rd ( s
zBaseCookie.__repr__c C s: g }t | j }x |D ]\}}|j|j| qW t|S )z(Return a string suitable for JavaScript.)rh rT rg rf _nulljoin)rD r` rk rT rE rG r r r rf / s
zBaseCookie.js_outputc C s8 t |tr| j| n x |j D ]\}}|| |< q W 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)rM r _BaseCookie__parse_stringrT )rD ZrawdatarE rG r r r rt 7 s
zBaseCookie.loadc C s d}t |}g }d}d}d}x d| ko2|k n r |j||} | sLP | jd| jd }
} | jd}|
d dkr|s~q |j||
dd | f q |
j tjkr|sd S | d kr|
j tjkr|j||
df qd S n|j||
t | f q | d k r|j||
| j
| f d}q d S q W d } xb|D ]Z\}
}
} |
|krV| d k sLt | | |
< n,|
|ksdt | \}}| j |
|| | |
} q*W d S ) Nr Fr& r( rE r $T)
r. matchgroupendrg rI r6 rA ri r0 rq AssertionErrorrx )rD r Zpattir Z parsed_itemsZ morsel_seenZTYPE_ATTRIBUTEZ
TYPE_KEYVALUEr rE rG rw tpry rz r r r Z__parse_stringE sJ
zBaseCookie.__parse_string)N)Nr{ r| )N)r r r rl rq rs rF rx rC rb rp rd rf rt _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 )N)r0 )rD r r r r rq s zSimpleCookie.value_decodec C s t |}|t|fS )N)r r% )rD r rr r r r rs s zSimpleCookie.value_encodeN)r r r rl rq rs r r r r r s ),rl restring__all__r} r rj r r Exceptionr Z
ascii_lettersZdigitsrY Z_UnescapedCharsrZ rangemapordr$ rQ compileescape fullmatchr" r r! r% subr/ r, r0 Z _weekdaynameZ
_monthnamer5 rB r6 Z_LegalKeyCharsZ_LegalValueCharsASCIIVERBOSEr r r r r r r <module> sJ
a