ThinkChat🤖让你学习和工作更高效,注册即送10W Token,即刻开启你的AI之旅 广告
### 导航 - [索引](../genindex.xhtml "总目录") - [模块](../py-modindex.xhtml "Python 模块索引") | - [下一页](http.cookiejar.xhtml "http.cookiejar --- Cookie handling for HTTP clients") | - [上一页](http.server.xhtml "http.server --- HTTP 服务器") | - ![](https://box.kancloud.cn/a721fc7ec672275e257bbbfde49a4d4e_16x16.png) - [Python](https://www.python.org/) » - zh\_CN 3.7.3 [文档](../index.xhtml) » - [Python 标准库](index.xhtml) » - [互联网协议和支持](internet.xhtml) » - $('.inline-search').show(0); | # [`http.cookies`](#module-http.cookies "http.cookies: Support for HTTP state management (cookies).") --- HTTP state management **Source code:** [Lib/http/cookies.py](https://github.com/python/cpython/tree/3.7/Lib/http/cookies.py) \[https://github.com/python/cpython/tree/3.7/Lib/http/cookies.py\] - - - - - - The [`http.cookies`](#module-http.cookies "http.cookies: Support for HTTP state management (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**](https://tools.ietf.org/html/rfc2109.html) \[https://tools.ietf.org/html/rfc2109.html\] and [**RFC 2068**](https://tools.ietf.org/html/rfc2068.html) \[https://tools.ietf.org/html/rfc2068.html\] 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.xhtml#string.ascii_letters "string.ascii_letters"), [`string.digits`](string.xhtml#string.digits "string.digits") and `!#$%&'*+-.^_`|~:` denote the set of valid characters allowed by this module in Cookie name (as [`key`](#http.cookies.Morsel.key "http.cookies.Morsel.key")). 在 3.3 版更改: Allowed ':' as a valid Cookie name character. 注解 On encountering an invalid cookie, [`CookieError`](#http.cookies.CookieError "http.cookies.CookieError") is raised, so if your cookie data comes from a browser you should always prepare for invalid data and catch [`CookieError`](#http.cookies.CookieError "http.cookies.CookieError") on parsing. *exception* `http.cookies.``CookieError`Exception failing because of [**RFC 2109**](https://tools.ietf.org/html/rfc2109.html) \[https://tools.ietf.org/html/rfc2109.html\] invalidity: incorrect attributes, incorrect *Set-Cookie* header, etc. *class* `http.cookies.``BaseCookie`(\[*input*\])This class is a dictionary-like object whose keys are strings and whose values are [`Morsel`](#http.cookies.Morsel "http.cookies.Morsel") instances. Note that upon setting a key to a value, the value is first converted to a [`Morsel`](#http.cookies.Morsel "http.cookies.Morsel") containing the key and the value. If *input* is given, it is passed to the [`load()`](#http.cookies.BaseCookie.load "http.cookies.BaseCookie.load") method. *class* `http.cookies.``SimpleCookie`(\[*input*\])This class derives from [`BaseCookie`](#http.cookies.BaseCookie "http.cookies.BaseCookie") and overrides `value_decode()`and `value_encode()`. SimpleCookie supports strings as cookie values. When setting the value, SimpleCookie calls the builtin [`str()`](stdtypes.xhtml#str "str") to convert the value to a string. Values received from HTTP are kept as strings. 参见 Module [`http.cookiejar`](http.cookiejar.xhtml#module-http.cookiejar "http.cookiejar: Classes for automatic handling of HTTP cookies.")HTTP cookie handling for web *clients*. The [`http.cookiejar`](http.cookiejar.xhtml#module-http.cookiejar "http.cookiejar: Classes for automatic handling of HTTP cookies.") and [`http.cookies`](#module-http.cookies "http.cookies: Support for HTTP state management (cookies).") modules do not depend on each other. [**RFC 2109**](https://tools.ietf.org/html/rfc2109.html) \[https://tools.ietf.org/html/rfc2109.html\] - HTTP State Management MechanismThis is the state management specification implemented by this module. ## Cookie Objects `BaseCookie.``value_decode`(*val*)Return a tuple `(real_value, coded_value)` from a string representation. `real_value` can be any type. This method does no decoding in [`BaseCookie`](#http.cookies.BaseCookie "http.cookies.BaseCookie") --- it exists so it can be overridden. `BaseCookie.``value_encode`(*val*)Return a tuple `(real_value, coded_value)`. *val* can be any type, but `coded_value` will always be converted to a string. This method does no encoding in [`BaseCookie`](#http.cookies.BaseCookie "http.cookies.BaseCookie") --- it exists so it can be overridden. In general, it should be the case that [`value_encode()`](#http.cookies.BaseCookie.value_encode "http.cookies.BaseCookie.value_encode") and [`value_decode()`](#http.cookies.BaseCookie.value_decode "http.cookies.BaseCookie.value_decode") are inverses on the range of *value\_decode*. `BaseCookie.``output`(*attrs=None*, *header='Set-Cookie:'*, *sep='\\r\\n'*)Return a string representation suitable to be sent as HTTP headers. *attrs* and *header* are sent to each [`Morsel`](#http.cookies.Morsel "http.cookies.Morsel")'s [`output()`](#http.cookies.BaseCookie.output "http.cookies.BaseCookie.output") method. *sep* is used to join the headers together, and is by default the combination `'\r\n'`(CRLF). `BaseCookie.``js_output`(*attrs=None*)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()`](#http.cookies.BaseCookie.output "http.cookies.BaseCookie.output"). `BaseCookie.``load`(*rawdata*)If *rawdata* is a string, parse it as an `HTTP_COOKIE` and add the values found there as [`Morsel`](#http.cookies.Morsel "http.cookies.Morsel")s. If it is a dictionary, it is equivalent to: ``` for k, v in rawdata.items(): cookie[k] = v ``` ## Morsel Objects *class* `http.cookies.``Morsel`Abstract a key/value pair, which has some [**RFC 2109**](https://tools.ietf.org/html/rfc2109.html) \[https://tools.ietf.org/html/rfc2109.html\] attributes. Morsels are dictionary-like objects, whose set of keys is constant --- the valid [**RFC 2109**](https://tools.ietf.org/html/rfc2109.html) \[https://tools.ietf.org/html/rfc2109.html\] attributes, which are - `expires` - `path` - `comment` - `domain` - `max-age` - `secure` - `version` - `httponly` The attribute `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 `''`. 在 3.5 版更改: `__eq__()` now takes [`key`](#http.cookies.Morsel.key "http.cookies.Morsel.key") and [`value`](#http.cookies.Morsel.value "http.cookies.Morsel.value")into account. 在 3.7 版更改: Attributes [`key`](#http.cookies.Morsel.key "http.cookies.Morsel.key"), [`value`](#http.cookies.Morsel.value "http.cookies.Morsel.value") and [`coded_value`](#http.cookies.Morsel.coded_value "http.cookies.Morsel.coded_value") are read-only. Use [`set()`](#http.cookies.Morsel.set "http.cookies.Morsel.set") for setting them. `Morsel.``value`The value of the cookie. `Morsel.``coded_value`The encoded value of the cookie --- this is what should be sent. `Morsel.``key`The name of the cookie. `Morsel.``set`(*key*, *value*, *coded\_value*)Set the *key*, *value* and *coded\_value* attributes. `Morsel.``isReservedKey`(*K*)Whether *K* is a member of the set of keys of a [`Morsel`](#http.cookies.Morsel "http.cookies.Morsel"). `Morsel.``output`(*attrs=None*, *header='Set-Cookie:'*)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:"`. `Morsel.``js_output`(*attrs=None*)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()`](#http.cookies.Morsel.output "http.cookies.Morsel.output"). `Morsel.``OutputString`(*attrs=None*)Return a string representing the Morsel, without any surrounding HTTP or JavaScript. The meaning for *attrs* is the same as in [`output()`](#http.cookies.Morsel.output "http.cookies.Morsel.output"). `Morsel.``update`(*values*)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**](https://tools.ietf.org/html/rfc2109.html) \[https://tools.ietf.org/html/rfc2109.html\] attribute. 在 3.5 版更改: an error is raised for invalid keys. `Morsel.``copy`(*value*)Return a shallow copy of the Morsel object. 在 3.5 版更改: return a Morsel object instead of a dict. `Morsel.``setdefault`(*key*, *value=None*)Raise an error if key is not a valid [**RFC 2109**](https://tools.ietf.org/html/rfc2109.html) \[https://tools.ietf.org/html/rfc2109.html\] attribute, otherwise behave the same as [`dict.setdefault()`](stdtypes.xhtml#dict.setdefault "dict.setdefault"). ## 示例 The following example demonstrates how to use the [`http.cookies`](#module-http.cookies "http.cookies: Support for HTTP state management (cookies).") module. ``` >>> 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 ``` ### 导航 - [索引](../genindex.xhtml "总目录") - [模块](../py-modindex.xhtml "Python 模块索引") | - [下一页](http.cookiejar.xhtml "http.cookiejar --- Cookie handling for HTTP clients") | - [上一页](http.server.xhtml "http.server --- HTTP 服务器") | - ![](https://box.kancloud.cn/a721fc7ec672275e257bbbfde49a4d4e_16x16.png) - [Python](https://www.python.org/) » - zh\_CN 3.7.3 [文档](../index.xhtml) » - [Python 标准库](index.xhtml) » - [互联网协议和支持](internet.xhtml) » - $('.inline-search').show(0); | © [版权所有](../copyright.xhtml) 2001-2019, Python Software Foundation. Python 软件基金会是一个非盈利组织。 [请捐助。](https://www.python.org/psf/donations/) 最后更新于 5月 21, 2019. [发现了问题](../bugs.xhtml)? 使用[Sphinx](http://sphinx.pocoo.org/)1.8.4 创建。