z fc
@ s d Z d d l Z y d d l m Z m Z Wn' e k
rU d d l m Z m Z n Xd d l Z d d l Z d d d d d d g Z d
j
Z d j
Z d j
Z
d e f d
YZ e j e j d Z i d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d! d" 6d# d$ 6d% d& 6d' d( 6d) d* 6d+ d, 6d- d. 6d/ d0 6d1 d2 6d3 d4 6d5 d6 6d7 d8 6d9 d: 6d; d< 6d= d> 6d? d@ 6dA dB 6dC dD 6dE dF 6dG dH 6dI dJ 6dK dL 6dM dN 6dO dP 6dQ dR 6dS dT 6dU dV 6dW dX 6dY dZ 6d[ d\ 6d] d^ 6d_ d` 6da db 6dc dd 6de df 6dg dh 6di dj 6dk dl 6dm dn 6do dp 6dq dr 6ds dt 6du dv 6dw dx 6dy dz 6d{ d| 6d} d~ 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6dd6dd6dd6dd6d d
6d d 6d
d6dd6dd6dd6dd6dd6dd6dd 6d d 6d d 6d!d"6d#d$6d%d&6d'd(6d)d*6d+d,6d-d.6d/d06d1d26d3d46d5d66d7d86d9d:6d;d<6d=d>6d?d@6dAdB6dCdD6dEdF6dGdH6dIdJ6dKdL6dMdN6dOdP6dQdR6dSdT6dUdV6dWdX6Z d
j
dY e dZ D Z e e e j d[ Z e j d\ Z e j d] Z d^ Z d_d`dadbdcdddeg Z d dfdgdhdidjdkdldmdndodpdqg
Z dre e ds Z dte f du YZ! dvZ" e" dwZ# e j dxe" dye# dz Z$ d e f d{ YZ% d e% f d| YZ& d e% f d} YZ' d e% f d~ YZ( e( Z) d Z* e+ dk re* n d S( s)
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..
>>> import Cookie
Most of the time you start by creating a cookie. Cookies come in
three flavors, each with slightly different encoding semantics, but
more on that later.
>>> C = Cookie.SimpleCookie()
>>> C = Cookie.SerialCookie()
>>> C = Cookie.SmartCookie()
[Note: Long-time users of Cookie.py will remember using
Cookie.Cookie() to create a Cookie object. Although deprecated, it
is still supported by the code. See the Backward Compatibility notes
for more information.]
Once you've created your Cookie, you can add values just as if it were
a dictionary.
>>> C = Cookie.SmartCookie()
>>> 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 = Cookie.SmartCookie()
>>> 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 = Cookie.SmartCookie()
>>> 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 = Cookie.SmartCookie()
>>> 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 = Cookie.SmartCookie()
>>> 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 = Cookie.SmartCookie()
>>> C["twix"] = "none for you"
>>> C["twix"].value
'none for you'
A Bit More Advanced
-------------------
As mentioned before, there are three different flavors of Cookie
objects, each with different encoding/decoding semantics. This
section briefly discusses the differences.
SimpleCookie
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 = Cookie.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'
SerialCookie
The SerialCookie expects that all values should be serialized using
cPickle (or pickle, if cPickle isn't available). As a result of
serializing, SerialCookie can save almost any Python object to a
value, and recover the exact same object when the cookie has been
returned. (SerialCookie can yield some strange-looking cookie
values, however.)
>>> C = Cookie.SerialCookie()
>>> C["number"] = 7
>>> C["string"] = "seven"
>>> C["number"].value
7
>>> C["string"].value
'seven'
>>> C.output()
'Set-Cookie: number="I7\\012."\r\nSet-Cookie: string="S\'seven\'\\012p1\\012."'
Be warned, however, if SerialCookie cannot de-serialize a value (because
it isn't a valid pickle'd object), IT WILL RAISE AN EXCEPTION.
SmartCookie
The SmartCookie combines aspects of each of the other two flavors.
When setting a value in a dictionary-fashion, the SmartCookie will
serialize (ala cPickle) the value *if and only if* it isn't a
Python string. String objects are *not* serialized. Similarly,
when the load() method parses out values, it attempts to de-serialize
the value. If it fails, then it fallsback to treating the value
as a string.
>>> C = Cookie.SmartCookie()
>>> C["number"] = 7
>>> C["string"] = "seven"
>>> C["number"].value
7
>>> C["string"].value
'seven'
>>> C.output()
'Set-Cookie: number="I7\\012."\r\nSet-Cookie: string=seven'
Backwards Compatibility
-----------------------
In order to keep compatibility with earlier versions of Cookie.py,
it is still possible to use Cookie.Cookie() to create a Cookie. In
fact, this simply returns a SmartCookie.
>>> C = Cookie.Cookie()
>>> print C.__class__.__name__
SmartCookie
Finis.
iN( t dumpst loadst CookieErrort
BaseCookiet SimpleCookiet SerialCookiet SmartCookiet Cookiet s ; t c B s e Z RS( ( t __name__t
__module__( ( ( s /usr/lib64/python2.7/Cookie.pyR s s !#$%&'*+-.^_`|~s \000s s \001s s \002s s \003s s \004s s \005s s \006s s \007s s \010s s \011s s \012s
s \013s s \014s s \015s
s \016s s \017s s \020s s \021s s \022s s \023s s \024s s \025s s \026s s \027s s \030s s \031s s \032s s \033s s \034s s \035s s \036s s \037s s \054t ,s \073t ;s \"t "s \\s \s \177s s \200s s \201s s \202s s \203s s \204s s \205s s \206s s \207s s \210s s \211s s \212s s \213s s \214s s \215s s \216s s \217s s \220s s \221s s \222s s \223s s \224s s \225s s \226s s \227s s \230s s \231s s \232s s \233s s \234s s \235s s \236s s \237s s \240s s \241s s \242s s \243s s \244s s \245s s \246s s \247s s \250s s \251s s \252s s \253s s \254s s \255s s \256s s \257s s \260s s \261s s \262s s \263s s \264s s \265s s \266s s \267s s \270s s \271s s \272s s \273s s \274s s \275s s \276s s \277s s \300s s \301s s \302s s \303s s \304s s \305s s \306s s \307s s \310s s \311s s \312s s \313s s \314s s \315s s \316s s \317s s \320s s \321s s \322s s \323s s \324s s \325s s \326s s \327s s \330s s \331s s \332s s \333s s \334s s \335s s \336s s \337s s \340s s \341s s \342s s \343s s \344s s \345s s \346s s \347s s \350s s \351s s \352s s \353s s \354s s \355s s \356s s \357s s \360s s \361s s \362s s \363s s \364s s \365s s \366s s \367s s \370s s \371s s \372s s \373s s \374s s \375s s \376s s \377s c c s | ] } t | Vq d S( N( t chr( t .0t x( ( s /usr/lib64/python2.7/Cookie.pys 6 s i c C sA d | | | | k r | Sd t t t j | | d Sd S( NR R ( t _nulljoint mapt _Translatort get( t strt
LegalCharst idmapt translate( ( s /usr/lib64/python2.7/Cookie.pyt _quote8 s s \\[0-3][0-7][0-7]s [\\].c C s t | d k r | S| d d k s6 | d d k r: | S| d d !} d } t | } g } x9d | k oy | k n rt j | | } t j | | } | r | r | j | | Pn d } } | r | j d } n | r | j d } n | rN| s| | k rN| j | | | ! | j | | d | d } qb | j | | | ! | j t t | | d | d !d | d } qb Wt | S( Ni i R ii i i ( t lent
_OctalPattt searcht
_QuotePattt appendt startR t intR ( R t it nt rest Omatcht Qmatcht jt k( ( s /usr/lib64/python2.7/Cookie.pyt _unquoteJ s6
+t Mont Tuet Wedt Thut Frit Satt Sunt Jant Febt Mart Aprt Mayt Junt Jult Augt Sept Octt Novt Deci c C so d d l m } m } | } | | | \ } } } } }
} } }
} d | | | | | | | |
| f S( Ni( t gmtimet times# %s, %02d %3s %4d %02d:%02d:%02d GMT( R> R= ( t futuret weekdaynamet monthnameR= R> t nowt yeart montht dayt hht mmt sst wdt yt z( ( s /usr/lib64/python2.7/Cookie.pyt _getdate s
+t Morselc B s e Z i d d 6d d 6d d 6d d 6d d 6d d 6d
d
6d d 6Z d d
h Z d
Z d Z d Z e e e j
d Z d d d Z
e
Z d Z d d Z d d Z RS( t expirest Patht patht Commentt commentt Domaint domains Max-Ages max-aget securet httponlyt Versiont versionc C sB d | _ | _ | _ x$ | j D] } t j | | d q! Wd S( NR ( t Nonet keyt valuet coded_valuet _reservedt dictt __setitem__( t selft K( ( s /usr/lib64/python2.7/Cookie.pyt __init__ s c C sE | j } | | j k r. t d | n t j | | | d S( Ns Invalid Attribute %s( t lowerR] R R^ R_ ( R` Ra t V( ( s /usr/lib64/python2.7/Cookie.pyR_ s c C s | j | j k S( N( Rc R] ( R` Ra ( ( s /usr/lib64/python2.7/Cookie.pyt
isReservedKey s c C sr | j | j k r( t d | n d | | | | k rS t d | n | | _ | | _ | | _ d S( Ns! Attempt to set a reserved key: %sR s Illegal key value: %s( Rc R] R RZ R[ R\ ( R` RZ t valt coded_valR R R ( ( s /usr/lib64/python2.7/Cookie.pyt set s s Set-Cookie:c C s d | | j | f S( Ns %s %s( t OutputString( R` t attrst header( ( s /usr/lib64/python2.7/Cookie.pyt output s c C s# d | j j | j t | j f S( Ns <%s: %s=%s>( t __class__R
RZ t reprR[ ( R` ( ( s /usr/lib64/python2.7/Cookie.pyt __repr__ s c C s d | j | j d d f S( Ns
R s \"( Ri t replace( R` Rj ( ( s /usr/lib64/python2.7/Cookie.pyt js_output s c C s g } | j } | d | j | j f | d k rA | j } n | j } | j x)| D]!\ } } | d k r| q^ n | | k r q^ n | d k r t | t d k r | d | j | t | f q^ | d k rt | t d k r| d | j | | f q^ | d k r>| t | j | q^ | d k rd| t | j | q^ | d | j | | f q^ Wt
| S( Ns %s=%sR RN i s max-ages %s=%dRU RV ( R RZ R\ RY R] t itemst sortt typeRL R t _semispacejoin( R` Rj t resultt RARr Ra Rd ( ( s /usr/lib64/python2.7/Cookie.pyRi s,
$$$ N( R
R R] t _flagsRb R_ Re t _LegalCharst _idmapt stringR Rh RY Rl t __str__Ro Rq Ri ( ( ( s /usr/lib64/python2.7/Cookie.pyRM s&
s, \w\d!#%&'~_`><@,:/\$\*\+\-\.\^\|\)\(\?\}\{\=s \[\]s (?x)\s*(?P[sN ]+?)(\s*=\s*(?P"(?:[^\\"]|\\.)*"|\w{3},\s[\s\w\d-]{9,11}\s[\d:]{8}\sGMT|[s ]*))?\s*(\s+|;|$)c B sz e Z d Z d Z d d Z d Z d Z d d d d Z e Z d Z
d d Z d
Z e
d Z RS(
c C s
| | f S( s
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` Rf ( ( s /usr/lib64/python2.7/Cookie.pyt value_decode2 s c C s t | } | | f S( s real_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` Rf t strval( ( s /usr/lib64/python2.7/Cookie.pyt value_encode< s c C s | r | j | n d S( N( t load( R` t input( ( s /usr/lib64/python2.7/Cookie.pyRb F s c C s? | j | t } | j | | | t j | | | d S( s+ Private method for setting a cookie's valueN( R RM Rh R^ R_ ( R` RZ t
real_valueR\ t M( ( s /usr/lib64/python2.7/Cookie.pyt __setJ s c C sQ t | t r% t j | | | n( | j | \ } } | j | | | d S( s Dictionary style assignment.N( t
isinstanceRM R^ R_ R t _BaseCookie__set( R` RZ R[ t rvalt cval( ( s /usr/lib64/python2.7/Cookie.pyR_ Q s s Set-Cookie:s
c C sY g } | j } | j x- | D]% \ } } | j | j | | q# W| j | S( s" Return a string suitable for HTTP.( Rr Rs R Rl t join( R` Rj Rk t sepRv Rr Ra Rd ( ( s /usr/lib64/python2.7/Cookie.pyRl [ s
c C sm g } | j } | j x4 | D], \ } } | j d | t | j f q# Wd | j j t | f S( Ns %s=%ss <%s: %s>( Rr Rs R Rn R[ Rm R
t
_spacejoin( R` t LRr Ra Rd ( ( s /usr/lib64/python2.7/Cookie.pyRo g s
$c C sS g } | j } | j x* | D]" \ } } | j | j | q# Wt | S( s( Return a string suitable for JavaScript.( Rr Rs R Rq R ( R` Rj Rv Rr Ra Rd ( ( s /usr/lib64/python2.7/Cookie.pyRq o s
c C sS t | t d k r( | j | n' x$ | j D] \ } } | | | s
2~
|$