Requests 模块中文文档（五）

原文链接 -> 传送门

The API Documentation / Guide（3）

目录

The API Documentation / Guide（3）

六、身份验证

七、编码

八、Cookies

九、状态码查询

---

六、身份验证

class requests.auth.AuthBase

所有认证的实现都来自于该基类。【源代码】

class requests.auth.HTTPBasicAuth(username, password)

将 HTTP 基本身份验证附加到给定的 Request 对象。【源代码】

class requests.auth.HTTPProxyAuth(username, password)

将 HTTP 代理身份验证附加到给定的 Request 对象。【源代码】

class requests.auth.HTTPDigestAuth(username, password)

将HTTP摘要身份验证附加到给定的 Request 对象。【源代码】

---

七、编码

requests.utils.get_encodings_from_content(content)

从给定的字符串内容中返回编码。【源代码】

参数	含义
content	指定字符串

requests.utils.get_encoding_from_headers(headers)

从 HTTP Header 字典中（dict）返回编码。【源代码】

参数	含义
headers	指定 HTTP Header 字典

requests.utils.get_unicode_from_response(r)

以 unicode 的形式返回请求的内容。【源代码】

参数	含义
r	指定要获取 unicode 内容的 Response 对象

尝试步骤：

• 从 content-type 获取 charset
• 返回并替换所有 unicode 字符。

---

八、Cookies

requests.utils.dict_from_cookiejar(cj)

从 CookieJar 中返回键/值对字典（dict）。【源代码】

参数	含义
cj	指定要提取 cookies 的 CookieJar 对象

requests.utils.add_dict_to_cookiejar(cj, cookie_dict)

从键/值对字典（dict）中返回 CookieJar 对象。【源代码】

参数	含义
cj	指定待插入 cookies 的 CookieJar 对象
cookie_dict	指定待插入 CookieJar 对象的键/值对字典（dict）

requests.cookies.cookiejar_from_dict(cookie_dict, cookiejar=None, overwrite=True)

从键/值对字典（dict）中返回 CookieJar 对象。【源代码】

参数	含义
cookie_dict	指定待插入 CookieJar 对象的键/值对字典（dict）
cookiejar（可选）	指定待插入 cookies 的 CookieJar 对象
overwrite（可选）	如果是 False，那么不会将新的 cookies 替代旧的

class requests.cookies.RequestsCookieJar(policy=None)

兼容性类；其实就是一个 cookielib.CookieJar，但是提供了一个字典（dict）接口。

这是我们为请求或会话创建的默认 CookieJar，因为一些客户端可能期望 response.cookies 和 session.cookies 支持类似字典（dict）的操作。

Requests 内部不使用字典（dict）接口；它只是为了兼容外部的客户端代码。所有请求代码应与外部提供的 CookieJar 实例一起工作，例如 LWPCookieJar 和 FileCookieJar。

与常规 CookieJar 不同，这个类是可以被 pickle 的。

警告

字典（dict）操作只是支持寻常的 O(1) 或 O(n) 这种。

add_cookie_header(request)

添加正确的 Cookie：到请求的头部（urllib2.Request 对象）。

Cookie2 头部也添加进去，除了 policy.hide_cookie2 被设置为 True。

clear(domain=None, path=None, name=None)

清理 cookies。

不带参数调用该方法将清除所有的 cookies。如果只给一个参数，那么只清除 domain 参数指定的域名的 cookies；如果给定两个参数，那么清除 domain 域名中 path 路径的 cookies；如果三个参数全给了，那么会清除 domain 域名中 path 路径下的 name 参数对应的 cookie。

如果没有存在匹配的 cookie，抛出 KeyError 异常。

clear_expired_cookies()

丢弃所有过期的 cookies。

你可能不需要自己调用该方法：过期的 cookies 并不会发送回服务器（如果你使用的是 DefaultCookiePolicy），这个方法经常被 CookieJar 自身调用，而 save() 方法也不会保存过期的 cookies（除非你传入一个 ignore_expires 参数）。

clear_session_cookies()

丢弃所有的会话 cookies。

注意：save() 方法不会保存会话 cookies（除非你传入一个 ignore_discard 参数）。

copy()

返回一个 RequestsCookieJar 对象的拷贝。【源代码】

get(name, default=None, domain=None, path=None)

像字典（dict）的 get() 方法一样，支持可选的域名和路径参数，以解决在多个域名中使用一个 cookie jar 的命名冲突。【源代码】

警告

字典（dict）操作只是支持寻常的 O(1) 或 O(n) 这种。

 get_dict(domain=None, path=None)

参数是可选的域名和路径，返回符合要求的 cookies 字典（dict）。【源代码】

items()

像字典（dict）的 items() 方法一样，从 jar 中返回一个由 (名称, 值) 元组构成的列表。【源代码】

允许客户端代码调用 dict(requestscookiejar) 获取一个键/值对的典型 Python 字典（dict）。

iteritems()

像字典（dict）的 iteritems() 方法一样，从 jar 中返回一个由 (名称, 值) 元组构成的迭代器。【源代码】

iterkeys()

像字典（dict）的 iterkeys() 方法一样，从 jar 中返回一个由 cookies 的名称构成的迭代器。【源代码】

itervalues()

像字典（dict）的 itervalues() 方法一样，从 jar 中返回一个由 cookies 的值构成的迭代器。【源代码】

keys()

像字典（dict）的 keys() 方法一样，从 jar 中返回一个由 cookies 的名称构成的列表。【源代码】

list_domains()

列出 jar 中所有域名的实用方法。【源代码】

list_paths()

列出 jar 中所有路径的实用方法。【源代码】

make_cookies(response, request)

返回从响应对象中提取的 Cookie 对象组成的序列。

multiple_domains

如果 jar 中存在多个域名返回 True，否则返回 False。【源代码】

pop(k[, d]) -> v，删除指定的键并返回相应的值。

如果未找到指定的键，则返回 d（如果有设置的话），否则抛出 KeyError 异常。

popitem() -> (k, v)，删除并返回一些键/值对。

以 2 元组的形式返回；但如果 D 为空，则抛出 KeyError 异常。

set(name, value, **kwargs)

像字典（dict）的 set() 方法一样，支持可选的域名和路径参数，以解决在多个域名中使用一个 cookie jar 的命名冲突。【源代码】

set_cookie_if_ok(cookie, request)

在允许的情况下，设置 cookie。

setdefault(k[, d]) -> D.get(k,d)，如果 k 不在 D 中，也设置 D[k]=d。

update(other)

从另一个 CookieJar 或者字典（dict）更新当前 jar 的 cookies。【源代码】

values()

像字典（dict）的 values() 方法一样，从 jar 中返回一个由 cookies 的值构成的列表。【源代码】

class requests.cookies.CookieConflictError

有两种 cookies 符合 cookie jar 中指定的标准。使用 .get 和 .set 并包含域名和路径参数。【源代码】

---

九、状态码查询

requests.codes

>>> requests.codes['temporary_redirect']
307

>>> requests.codes.teapot
418

>>> requests.codes['\o/']
200