python模块学习 ---- Cookie

最近在用GAE开发自己的博客程序。虽然GAE的API没有显式的提供操作Cookie的方法，但他现有的架构，使我们有足够的自由来操作Cookie。

Cookie 模块，顾名思义，就是用来操作Cookie的模块。Cookie这块小蛋糕，玩过Web的人都知道，它是Server与Client保持会话时用到的信息 切片。 Http协议本身是无状态的，也就是说，同一个客户端发送的两次请求，对于Web服务器来说，没有直接的关系。既然这样，有人会问，既然Http是无状态 的， 为什么有些网页，只有输入了用户名与密码通过验证之后才可以访问？那是因为：对于通过身份验证的用户，Server会偷偷的在发往Client的数据中添 加 Cookie，Cookie中一般保存一个标识该Client的唯一的ID，Client在接下来对服务器的请求中，会将该ID以Cookie的形式一并 发往Server，Server从回传回来的Cookie中提取ID并与相应的用户绑定起来，从而实现身份验证。说白了，Cookie就是一个在服务器与客户端之间相互传递的字符串（下图通过FireFox的FireBug插件查看访问google.com时的Cookie）。 越扯越远了，回到我们的主题：Python标准模块 -- Cookie。

（上图是Http请求头中的Cookie信息）

（上图是Http响应中的Cookie信息）

Cooke模块中定义了4个直接操作Cookie的类：BaseCookie、SimpleCookie、SerialCookie、 SmartCookie。其中，BaseCookie是基类，定义了操作Cookie的公共部分，其他3个类都继承自BaseCookie，它们之间的区 别仅仅在于序列化数据的方式不同。下面简单讲解这些类的使用。
BaseCookie基类： BaseCookies的行为非常像dict，可以用键/值对的形式来操作它，但是kye必须是字符串，value是Morsel对象 （下面会讲到Morsel）。BaseCookies定义了编码/解码，输入/输出操作的公共规范：

BaseCookie.value_decode(val)
BaseCookie.value_encode(val)：
对数据进行序列化/反序列化。这些方法都返回字符串，以便通过Http传输。
BaseCookie.output()：
返回字符串，该字符串可以作为Http响应头发往客户端。
BaseCookie.js_output()
返回嵌入js脚本的字符串，浏览器通过执行该脚本，就可以得到cooke数据。
BaseCookie.load(newdata)：解析字符串为Cookie数据。

SimpleCookie、SerialCookie、SmartCookie都继承自BaseCookie，具有一致的行为，它们各自对 BaseCookie的value_decode, value_encode进行了重写并实现自己的序列化/反序列化策略，其中：

• SimpleCookie内部使用str()来对数据进行序列化；
• SerialCookie则通过pickle模块来序列化反序列化数据；
• SmartCookie相对聪明点，对于非字符串数据，使用pickle序列/反序列化，否则将字符串原样返回。

下面的例子简单的说明如何使用Cookie模块：

import Cookie


c = Cookie.SimpleCookie()

c['name'] = 'DarkBull'

c['address'] = 'ChinaHangZhou'

c['address']['path'] = '/'	# 路径

c['address']['domain'] = 'appspot.com'	# domain

c['address']['expires'] = 'Fir, 01-Oct-2010 20:00:00 GMT'	# 过期时间

print c.output()

print c.js_output()


# 输出结果,与上图对照

# Set-Cookie: address=ChinaHangZhou; Domain=appspot.com; expires=Fir, 01-Oct-2010 20:00:00 GMT; Path=/

# Set-Cookie: name=DarkBull


# 作为脚本输出

# <script type="text/javascript">

# document.cookie = "address=ChinaHangZhou; Domain=appspot.com; expires=Fir, 01-Oct-2010 20:00:00 GMT; Path=/";

# </script>


# <script type="text/javascript">

# document.cookie = "name=DarkBull";

# </script>

Morsel类 ： 用于表示Cookie中每一项数据的属性而抽象的类。这些属性包括：expires, path, comment, domain, max-age, secure, version等等（看上图下划线标注部分）。如果你玩过web，对这些应该不会陌生，可以在RCF2109中找到他们的具体定义。
Morsel.key，Morsel.value：Cookie数据项的key/value(value可以是二进制数据)；
Morsel.coded_value：数据编码后得到的字符串。Http协议是基于文本的协议，Server无法直接向Client发送二进制数据，只有序列化成字符串后，才能发往Client；
Morsel.set(key, value, coded_value)：设置Cookie数据项的key、value、coded_value；
Morsel.isReversvedKey(key)：如果key是expires, path, comment, domain, max-age, secure, version, httponly中的一个，返回True，否则返回False；
Morsel.output()：返回型如“Set-Cookie: ...”的字符串，表示一个Cookie数据项；
Morsel.js_output()：返回Cookie数据项的脚本字符串；
Morsel.OutputString(): 返回Morsel的字符串表示；

Morsel使用示例：

import Cookie


m = Cookie.Morsel()

m.set('name', 'DarkBull', 'DarkBull')

m['expires'] = 'Fir, 01-Oct-2010 20:00:00 GMT'

m['domain'] = 'appspot.com'

print m.output()


# 结果

# Set-Cookie: name=DarkBull; Domain=appspot.com; expires=Fir, 01-Oct-2010 20:00:00 GMT

关于Cookie模块更详细的内容，可以Python手册。