http.cookies
— HTTP 状态管理
¶
源代码： Lib/http/cookies.py
http.cookies
module defines classes for abstracting the concept of cookies, an HTTP state management mechanism. It supports both simple string-only cookies, and provides an abstraction for having any serializable data-type as cookie value.
The module formerly strictly applied the parsing rules described in the RFC 2109 and RFC 2068 specifications. It has since been discovered that MSIE 3.0x doesn’t follow the character rules outlined in those specs and also many current day browsers and servers have relaxed parsing rules when comes to Cookie handling. As a result, the parsing rules used are a bit less strict.
The character set,
string.ascii_letters
,
string.digits
and
!#$%&'*+-.^_`|~:
denote the set of valid characters allowed by this module in Cookie name (as
key
).
3.3 版改变： Allowed ‘:’ as a valid Cookie name character.
注意
On encountering an invalid cookie,
CookieError
is raised, so if your cookie data comes from a browser you should always prepare for invalid data and catch
CookieError
on parsing.
Exception failing because of RFC 2109 invalidity: incorrect attributes, incorrect Set-Cookie header, etc.
This class is a dictionary-like object whose keys are strings and whose values are
Morsel
instances. Note that upon setting a key to a value, the value is first converted to a
Morsel
containing the key and the value.
若
input
is given, it is passed to the
load()
方法。
This class derives from
BaseCookie
and overrides
value_decode()
and
value_encode()
to be the identity and
str()
分别。
另请参阅
http.cookiejar
http.cookiejar
and
http.cookies
modules do not depend on each other.
Return a decoded value from a string representation. Return value can be any type. This method does nothing in
BaseCookie
— it exists so it can be overridden.
Return an encoded value.
val
can be any type, but return value must be a string. This method does nothing in
BaseCookie
— it exists so it can be overridden.
In general, it should be the case that
value_encode()
and
value_decode()
are inverses on the range of
value_decode
.
Return a string representation suitable to be sent as HTTP headers.
attrs
and
header
are sent to each
Morsel
’s
output()
方法。
sep
is used to join the headers together, and is by default the combination
'\r\n'
(CRLF).
Return an embeddable JavaScript snippet, which, if run on a browser which supports JavaScript, will act the same as if the HTTP headers was sent.
The meaning for
attrs
is the same as in
output()
.
若
rawdata
is a string, parse it as an
HTTP_COOKIE
and add the values found there as
Morsel
s. If it is a dictionary, it is equivalent to:
for k, v in rawdata.items():
cookie[k] = v
Abstract a key/value pair, which has some RFC 2109 属性。
Morsels are dictionary-like objects, whose set of keys is constant — the valid RFC 2109 attributes, which are
expires
path
comment
domain
max-age
secure
version
httponly
属性
httponly
specifies that the cookie is only transferred in HTTP requests, and is not accessible through JavaScript. This is intended to mitigate some forms of cross-site scripting.
The keys are case-insensitive and their default value is
''
.
The value of the cookie.
从 3.5 版起弃用：
assigning to
value
; use
set()
代替。
The encoded value of the cookie — this is what should be sent.
从 3.5 版起弃用：
assigning to
coded_value
; use
set()
代替。
The name of the cookie.
从 3.5 版起弃用：
assigning to
key
; use
set()
代替。
设置 key , value and coded_value 属性。
从 3.5 版起弃用： The undocumented LegalChars parameter is ignored and will be removed in a future version.
Whether
K
is a member of the set of keys of a
Morsel
.
Return a string representation of the Morsel, suitable to be sent as an HTTP header. By default, all the attributes are included, unless
attrs
is given, in which case it should be a list of attributes to use.
header
is by default
"Set-Cookie:"
.
Return an embeddable JavaScript snippet, which, if run on a browser which supports JavaScript, will act the same as if the HTTP header was sent.
The meaning for
attrs
is the same as in
output()
.
Return a string representing the Morsel, without any surrounding HTTP or JavaScript.
The meaning for
attrs
is the same as in
output()
.
Update the values in the Morsel dictionary with the values in the dictionary values . Raise an error if any of the keys in the values dict is not a valid RFC 2109 属性。
3.5 版改变： an error is raised for invalid keys.
Return a shallow copy of the Morsel object.
3.5 版改变： return a Morsel object instead of a dict.
Raise an error if key is not a valid
RFC 2109
attribute, otherwise behave the same as
dict.setdefault()
.
以下范例演示如何使用
http.cookies
模块。
>>> from http import cookies
>>> C = cookies.SimpleCookie()
>>> C["fig"] = "newton"
>>> C["sugar"] = "wafer"
>>> print(C) # generate HTTP headers
Set-Cookie: fig=newton
Set-Cookie: sugar=wafer
>>> print(C.output()) # same thing
Set-Cookie: fig=newton
Set-Cookie: sugar=wafer
>>> 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
>>> C = cookies.SimpleCookie()
>>> C.load("chips=ahoy; vienna=finger") # load from a string (HTTP header)
>>> print(C)
Set-Cookie: chips=ahoy
Set-Cookie: vienna=finger
>>> C = cookies.SimpleCookie()
>>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')
>>> print(C)
Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"
>>> C = cookies.SimpleCookie()
>>> C["oreo"] = "doublestuff"
>>> C["oreo"]["path"] = "/"
>>> print(C)
Set-Cookie: oreo=doublestuff; Path=/
>>> C = cookies.SimpleCookie()
>>> C["twix"] = "none for you"
>>> C["twix"].value
'none for you'
>>> C = cookies.SimpleCookie()
>>> C["number"] = 7 # equivalent to C["number"] = str(7)
>>> C["string"] = "seven"
>>> C["number"].value
'7'
>>> C["string"].value
'seven'
>>> print(C)
Set-Cookie: number=7
Set-Cookie: string=seven