Python requests
发送请求
导入 Requests 模块
1 | >>> import requests |
HTTP 请求类型
1 | >>> r = requests.get('https://api.github.com/events') |
r为 Response 对象。我们可以从这个对象中获取所有我们想要的信息。
传递 URL 参数
Requests 允许你使用 params 关键字参数,以一个字符串字典来提供这些参数。
1 | >>> payload = {'key1': 'value1', 'key2': 'value2'} |
通过打印输出该 URL,你能看到 URL 已被正确编码:
1 | >>> print(r.url) |
注意字典里值为 None 的键都不会被添加到 URL 的查询字符串里。
你还可以将一个列表作为值传入:
1 | >>> payload = {'key1': 'value1', 'key2': ['value2', 'value3']} |
响应内容
文本响应内容 r.text
我们能读取服务器响应的内容。
1 | >>> import requests |
Requests 会自动解码来自服务器的内容。大多数 unicode 字符集都能被无缝地解码。
请求发出后,Requests 会基于 HTTP 头部对响应的编码作出有根据的推测。
当你访问 r.text 之时,Requests 会使用其推测的文本编码。
你可以找出 Requests 使用了什么编码,并且能够使用 r.encoding 属性来改变它:
1 | >>> r.encoding |
如果你改变了编码,每当你访问 r.text ,Request 都将会使用 r.encoding 的新值。
你可能希望在使用特殊逻辑计算出文本的编码的情况下来修改编码。比如 HTTP 和 XML 自身可以指定编码。这样的话,你应该使用 r.content 来找到编码,然后设置 r.encoding 为相应的编码。这样就能使用正确的编码解析 r.text 了。
二进制响应内容 r.content
你也能以字节的方式访问请求响应体,对于非文本请求:
1 | >>> r.content |
Requests 会自动为你解码 gzip 和 deflate 传输编码的响应数据。
例如,以请求返回的二进制数据创建一张图片,你可以使用如下代码:
1 | >>> from PIL import Image |
JSON 响应内容 r.json()
Requests 中也有一个内置的 JSON 解码器,助你处理 JSON 数据
1 | >>> import requests |
如果 JSON 解码失败, r.json() 就会抛出一个异常。例如,响应内容是 401 (Unauthorized),尝试访问 r.json() 将会抛出 ValueError: No JSON object could be decoded 异常。
需要注意的是,成功调用 r.json() 并不意味着响应的成功。有的服务器会在失败的响应中包含一个 JSON 对象(比如 HTTP 500 的错误细节)。这种 JSON 会被解码返回。要检查请求是否成功,请使用 r.raise_for_status() 或者检查 r.status_code 是否和你的期望相同。
原始响应内容 r.raw
在罕见的情况下,你可能想获取来自服务器的原始套接字响应,那么你可以访问 r.raw。 如果你确实想这么干,那请你确保在初始请求中设置了 stream=True。具体你可以这么做:
1 | >>> r = requests.get('https://api.github.com/events', stream=True) |
但一般情况下,你应该以下面的模式将文本流保存到文件:
1 | with open(filename, 'wb') as fd: |
使用 Response.iter_content 将会处理大量你直接使用 Response.raw 不得不处理的。 当流下载时,上面是优先推荐的获取内容方式。 Note that chunk_size can be freely adjusted to a number that may better fit your use cases.
定制请求头
如果你想为请求添加 HTTP 头部,只要简单地传递一个 dict 给 headers 参数就可以了。
1 | >>> url = 'https://api.github.com/some/endpoint' |
注意: 定制 header 的优先级低于某些特定的信息源,例如:
- 如果在 .netrc 中设置了用户认证信息,使用 headers= 设置的授权就不会生效。而如果设置了 auth= 参数,.netrc 的设置就无效了。
- 如果被重定向到别的主机,授权 header 就会被删除。
- 代理授权 header 会被 URL 中提供的代理身份覆盖掉。
- 在我们能判断内容长度的情况下,header 的 Content-Length 会被改写。
- 更进一步讲,Requests 不会基于定制 header 的具体情况改变自己的行为。只不过在最后的请求中,所有的 header 信息都会被传递进去。
注意: 所有的 header 值必须是 string、bytestring 或者 unicode。尽管传递 unicode header 也是允许的,但不建议这样做。
更加复杂的 POST 请求
通常,你想要发送一些编码为表单形式的数据——非常像一个 HTML 表单。要实现这个,只需简单地传递一个字典给 data 参数。你的数据字典在发出请求时会自动编码为表单形式:
1 | >>> payload = {'key1': 'value1', 'key2': 'value2'} |
你还可以为 data 参数传入一个元组列表。在表单中多个元素使用同一 key 的时候,这种方式尤其有效:
1 | >>> payload = (('key1', 'value1'), ('key1', 'value2')) |
很多时候你想要发送的数据并非编码为表单形式的。如果你传递一个 string 而不是一个 dict,那么数据会被直接发布出去。
1 | >>> import json |
POST一个多部分编码(Multipart-Encoded)的文件
Requests 使得上传多部分编码文件变得很简单
1 | >>> url = 'http://httpbin.org/post' |
可以显式地设置文件名,文件类型和请求头:
1 | files = {'file': ('report.xls', open('report.xls', 'rb'), 'application/vnd.ms-excel', {'Expires': '0'})} |
也可以发送作为文件来接收的字符串:
1 | >>> files = {'file': ('report.csv', 'some,data,to,send\nanother,row,to,send\n')} |
如果你发送一个非常大的文件作为 multipart/form-data 请求,你可能希望将请求做成数据流。默认下 requests 不支持, 但有个第三方包 requests-toolbelt 是支持的。
强烈建议你用二进制模式(binary mode)打开文件。这是因为 Requests 可能会试图为你提供 Content-Length header,在它这样做的时候,这个值会被设为文件的字节数(bytes)。如果用文本模式(text mode)打开文件,就可能会发生错误。
响应状态码
我们可以检测响应状态码
1 | >>> r = requests.get('http://httpbin.org/get') |
为方便引用,Requests还附带了一个内置的状态码查询对象
1 | >>> r.status_code == requests.codes.ok |
如果发送了一个错误请求(一个 4XX 客户端错误,或者 5XX 服务器错误响应),我们可以通过 Response.raise_for_status() 来抛出异常:
1 | >>> bad_r = requests.get('http://httpbin.org/status/404') |
若 r 的 status_code 是 200 ,当我们调用 raise_for_status() 时,得到的是:
1 | >>> r.raise_for_status() |
响应头
我们可以查看以一个 Python 字典形式展示的服务器响应头
1 | >>> r.headers |
但是这个字典比较特殊:它是仅为 HTTP 头部而生的。根据 RFC 2616, HTTP 头部是大小写不敏感的。
因此,我们可以使用任意大写形式来访问这些响应头字段:
1 | >>> r.headers['Content-Type'] |
它还有一个特殊点,那就是服务器可以多次接受同一 header,每次都使用不同的值。但 Requests 会将它们合并,这样它们就可以用一个映射来表示出来
Cookie
如果某个响应中包含一些 cookie,你可以快速访问它们
1 | >>> url = 'http://example.com/some/cookie/setting/url' |
要想发送你的cookies到服务器,可以使用 cookies 参数
1 | >>> url = 'http://httpbin.org/cookies' |
Cookie 的返回对象为 RequestsCookieJar,它的行为和字典类似,但接口更为完整,适合跨域名跨路径使用。
你还可以把 Cookie Jar 传到 Requests 中:
1 | >>> jar = requests.cookies.RequestsCookieJar() |
重定向与请求历史
默认情况下,除了 HEAD, Requests 会自动处理所有重定向。
可以使用响应对象的 history 方法来追踪重定向。
Response.history 是一个 Response 对象的列表,为了完成请求而创建了这些对象。这个对象列表按照从最老到最近的请求进行排序。
例如,Github 将所有的 HTTP 请求重定向到 HTTPS:
1 | >>> r = requests.get('http://github.com') |
如果你使用的是GET、OPTIONS、POST、PUT、PATCH 或者 DELETE,那么你可以通过 allow_redirects 参数禁用重定向处理:
1 | >>> r = requests.get('http://github.com', allow_redirects=False) |
如果你使用了 HEAD,你也可以启用重定向:
1 | >>> r = requests.head('http://github.com', allow_redirects=True) |
超时
你可以告诉 requests 在经过以 timeout 参数设定的秒数时间之后停止等待响应。基本上所有的生产代码都应该使用这一参数。如果不使用,你的程序可能会永远失去响应
1 | >>> requests.get('http://github.com', timeout=0.001) |
timeout 仅对连接过程有效,与响应体的下载无关。 timeout 并不是整个下载响应的时间限制,而是如果服务器在 timeout 秒内没有应答,将会引发一个异常(更精确地说,是在 timeout 秒内没有从基础套接字上接收到任何字节的数据时)If no timeout is specified explicitly, requests do not time out.
错误与异常
- 遇到网络问题(如:DNS 查询失败、拒绝连接等)时,Requests 会抛出一个 ConnectionError 异常。
- 如果 HTTP 请求返回了不成功的状态码, Response.raise_for_status() 会抛出一个 HTTPError 异常。
- 若请求超时,则抛出一个 Timeout 异常。
- 若请求超过了设定的最大重定向次数,则会抛出一个 TooManyRedirects 异常。
- 所有Requests显式抛出的异常都继承自 requests.exceptions.RequestException 。
本文标题:Python requests
文章作者:Mr Bluyee
发布时间:2018-07-19
最后更新:2019-07-15
原始链接:https://www.mrbluyee.com/2018/07/19/Python-requests/
版权声明:The author owns the copyright, please indicate the source reproduced.