B
3u;=!
@ 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
1/opt/alt/python37/lib64/python3.7/http/cookies.pyr s z!#$%&'*+-.^_`|~:z
()/<=>?@[]{}c C s i | ]}d | |qS )z\%03or
).0nr
r
r
s r "z\"\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 _Translator)strr
r
r _quote s r z\\[0-3][0-7][0-7]z[\\].c C sP | d kst | dk r| S | d dks0| d dkr4| S | dd } d}t | }g }xd| krh|k rFn nt| |}t| |}|s|s|| |d P d }}|r|d}|r|d}|r|r||k r|| || || |d |d }qR|| || |tt| |d |d d |d }qRW t|S )N r r ) len
_OctalPattsearch
_QuotePattappendstartchrint _nulljoin)r ir
ZresZo_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
r- c @ s e Zd ZdZdddddddd d
Zd d hZd
d Zedd Zedd Z edd Z
dd Z d1ddZ dd Z
ejZd d Zd d Zd d! Zd"d# Zd$d% Zd&d' Zd2d)d*ZeZd+d, Zd3d-d.Zd4d/d0ZdS )5Morsela 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)r/ pathcommentZdomainzmax-agesecurehttponlyversionr3 r4 c C s4 d | _ | _| _x | jD ]}t| |d qW d S )Nr )_key_value _coded_value _reserveddict __setitem__)selfkeyr
r
r __init__ s zMorsel.__init__c C s | j S )N)r6 )r< r
r
r r= ( s z
Morsel.keyc C s | j S )N)r7 )r< r
r
r value, s z Morsel.valuec C s | j S )N)r8 )r< r
r
r coded_value0 s zMorsel.coded_valuec C s2 | }|| jkr td|f t| || d S )NzInvalid attribute %r)lowerr9 r r: r; )r< KVr
r
r r; 4 s
zMorsel.__setitem__Nc C s. | }|| jkr td|f t| ||S )NzInvalid attribute %r)rA r9 r r:
setdefault)r< r= valr
r
r rD : s
zMorsel.setdefaultc C s> t |tstS t| |o<| j|jko<| j|jko<| j|jkS )N)
isinstancer. NotImplementedr: __eq__r7 r6 r8 )r< morselr
r
r rH @ s
z
Morsel.__eq__c C s$ t }t|| |j| j |S )N)r. r: update__dict__)r< rI r
r
r copyJ s z Morsel.copyc C sV i }x@t | D ]0\}}| }|| jkr:td|f |||< qW t | | d S )NzInvalid attribute %r)r: itemsrA r9 r rJ )r< valuesdatar= rE r
r
r rJ P s
z
Morsel.updatec C s | | jkS )N)rA r9 )r< rB 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)rA r9 r r r6 r7 r8 )r< r= rE Z coded_valr
r
r set\ s z
Morsel.setc C s | j | j| jdS )N)r= r? r@ )r6 r7 r8 )r< r
r
r __getstate__g s zMorsel.__getstate__c C s" |d | _ |d | _|d | _d S )Nr= r? r@ )r6 r7 r8 )r< stater
r
r __setstate__n s
zMorsel.__setstate__ Set-Cookie:c C s d|| |f S )Nz%s %s) OutputString)r< attrsheaderr
r
r outputs s z
Morsel.outputc C s d| j j| f S )Nz<%s: %s>) __class__r rV )r< r
r
r __repr__x s zMorsel.__repr__c C s d| |dd S )Nz
r z\")rV replace)r< rW r
r
r js_output{ s zMorsel.js_outputc C s( g }|j }|d| j| jf |d kr,| j}t| }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 r/ zmax-agez%s=%dr2 )
r r= r@ r9 sortedrM rF r# r- r r _flags_semispacejoin)r< rW resultr rM r= r? r
r
r rV s, zMorsel.OutputString)N)NrU )N)N)r r r __doc__r9 r_ r> propertyr= r? r@ r; rD rH object__ne__rL rJ rP rQ rR rT rY __str__r[ r] rV r
r
r
r r. s:
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
)r< 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 )r< rE strvalr
r
r value_encode s zBaseCookie.value_encodeNc C s |r| | d S )N)load)r< inputr
r
r r> s zBaseCookie.__init__c C s. | |t }|||| t| || dS )z+Private method for setting a cookie's valueN)getr. rQ r: r; )r< 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. r: r; ri _BaseCookie__set)r< r= r? rvalcvalr
r
r r; s
zBaseCookie.__setitem__ Set-Cookie:
c C s> g }t | }x"|D ]\}}|||| qW ||S )z"Return a string suitable for HTTP.)r^ rM r rY join)r< rW rX sepra rM r= r? r
r
r rY s
zBaseCookie.outputc C sN g }t | }x(|D ] \}}|d|t|jf qW d| jjt|f S )Nz%s=%sz<%s: %s>)r^ rM r reprr? rZ r
_spacejoin)r< lrM r= r? r
r
r r[ s
zBaseCookie.__repr__c C s: g }t | }x |D ]\}}||| qW t|S )z(Return a string suitable for JavaScript.)r^ rM r r] r$ )r< rW ra rM r= r? r
r
r r] s
zBaseCookie.js_outputc C s8 t |tr| | n x | 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)rF r _BaseCookie__parse_stringrM )r< Zrawdatar= r? r
r
r rj
s
zBaseCookie.loadc C s d}t |}g }d}d}d}x d| kr6|k r n n|||} | sLP | 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 W d } xb|D ]Z\}
}
} |
|krV| d k sLt | | |
< n,|
|ksdt | \}}| |
|| | |
} q*W d S ) Nr Fr r r= rE $T)
r matchgroupendr rA r. r9 r_ r( rg AssertionErrorrn )r< r Zpattr% r
Z parsed_itemsZ morsel_seenZTYPE_ATTRIBUTEZ
TYPE_KEYVALUErz r= r? rm tpro rp r
r
r Z__parse_string sJ
zBaseCookie.__parse_string)N)Nrq rr )N)r r r rb rg ri r> rn r; rY rf r[ r] rj _CookiePatternrx 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)r( )r< rE r
r
r rg \ s zSimpleCookie.value_decodec C s t |}|t|fS )N)r r )r< rE rh r
r
r ri _ s zSimpleCookie.value_encodeN)r r r rb rg ri r
r
r
r r U s )(rb restring__all__rs r$ r` rv Exceptionr Z
ascii_lettersZdigitsZ _LegalCharsZ_UnescapedCharsrQ rangemapordr rJ compileescape fullmatchr r r r r( Z _weekdaynameZ
_monthnamer- r: r. Z_LegalKeyCharsZ_LegalValueCharsASCIIVERBOSEr r r r
r
r
r sD
2 4