Requests: HTTP for Humans

发行版本：v2.7.0.（Installation）

简介

Requests是使用Apache2 Licensed许可证的http库。用python编写， 真正地为人类着想。

Python标准库中的urllib2模块提供了你所需要的大多数http功能，但是它的api太烂了，它是为另一个时代、另一个互联网所创建的。它需要巨量的工作，甚至包括各种方法覆盖，来完成最简单的任务。

在python的世界里，事情不应该这么麻烦。

>>> r = requests.get('https://api.github.com/user', auth=('user', 'pass'))
>>> r.status_code
200
>>> r.headers['content-type']
'application/json; charset=utf8'
>>> r.encoding
'utf-8'
>>> r.text
u'{"type":"User"...'
>>> r.json()
{u'private_gists': 419, u'total_private_repos': 77, ...}

参见未使用Requests的相似代码实现。

urllib2

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import urllib2

gh_url = 'https://api.github.com'
req = urllib2.Request(gh_url)
password_manager = urllib2.HTTPPasswordMgrWithDefaultRealm()
password_manager.add_password(None, gh_url, 'user', 'pass')

auth_manager = urllib2.HTTPBasicAuthHandler(password_manager)
opener = urllib2.build_opener(auth_manager)

urllib2.install_opener(opener)

handler = urllib2.urlopen(req)

print handler.getcode()
print handler.headers.getheader('content-type')

# ------
# 200
# 'application/json'

对比requests

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import requests

r = requests.get('https://api.github.com', auth=('user', 'pass'))

print r.status_code
print r.headers['content-type']

# ------
# 200
# 'application/json'

Requests使用的是urllib3，因此继承了它的所有特性。Requests支持http链接保持和连接池，支持使用cookie保持会话， 支持文件上传，支持自动确定响应内容的编码，支持国际化的URL和POST数据自动编码。现代、国际化、人性化。

安装

这部分包含了Requests的安装过程，使用任何软件的第一步就是合适的安装它。

Distribute&Pip

使用pip安装Requests非常简单

$ pip install requests

或者使用easy_install安装

$ easy_install requests

快速上手

首先确认一下：

Requests已安装

Requests是最新的

让我们从一些简单的示例开始吧。

1、发送请求

使用requests发送网络请求非常简单。

一开始要导入requests模块：

>>> import requests

然后，尝试获取某个网页。本例子中，我们来获取Github的公共时间线：

>>> r = requests.get('https://github.com/timeline.json')

现在，我们有一个名为r的Response对象。可以从这个对象中获取所有我们想要的信息。

Requests简便的API意味着所有http请求类型都是显而易见的。例如，你可以这样发送一个http post请求。

>>> r = requests.post("http://httpbin.org/post")

其他http类型：PUT, DELETE, HEAD以及OPTIONS都是一样的简单：

>>> r = requests.put("http://httpbin.org/put")
>>> r = requests.delete("http://httpbin.org/delete")
>>> r = requests.head("http://httpbin.org/get")
>>> r = requests.options("http://httpbin.org/get")

2、为URL传递参数

你也许经常想为URL的查询字符串（query string）传递各种数据。如果你是手工构建URL，那么数据会以键/值对的形式置于URL中， 跟在一个问号的后面。例如，httpbin.org/get?key=val。Requests允许你使用params关键字参数， 以一个字典来提供这些参数。举例来说，如果你想传递key1=val1和key2=val2到httpbin.org/get,那么你可以使用如下代码：

>>> payload = {'key1': 'value1', 'key2': 'value2'}
>>> r = requests.get("http://httpbin.org/get", params=payload)

>>> print(r.url)
http://httpbin.org/get?key2=value2&key1=value1

注意字典里值为None的键都不会被添加到URL的查询字符串中。

3、响应内容

我们能读取服务器响应的内容。再次以Github时间线为例。

>>> import requests
>>> r = requests.get('https://github.com/timeline.json')
>>> r.text
u'[{"repository":{"open_issues":0,"url":"https://github.com/...

Requests会自动解码来自服务器的内容。大多数unicode字符集都能被无缝地解码。

请求发出后，Requests会基于http头部对响应的编码做出有根据的推测。当你访问r.text时，Requests会使用其推测的文本编码。你可以找出Requests使用了什么编码，并且能够使用r.encoding属性来改变它：

>>> r.encoding
'utf-8'
>>> r.encoding = 'ISO-8859-1'

如果你改变了编码，每当你访问r.text，Requests都将会使用r.encoding的新值。你可能希望使用特殊逻辑计算出文本的编码的情况下来修改编码。比如http和xml自身可以指定编码。这样的话，你应该使用r.content来找到编码，然后设置r.encoding为相应的编码。这样就能使用正确的编码来解析r.text了。

在你需要的情况下，Requests可以使用定制的编码。如果你创建了自己的编码， 并使用codecs模块进行注册，你就可以轻松地使用这个解码器名称作为r.encoding的值，然后由Requests来为你处理编码。

4、二进制响应内容

 你也能以字节的方式访问请求响应体，对于非文本请求：

>>> r.content
b'[{"repository":{"open_issues":0,"url":"https://github.com/...

Requests会自动为你解码gzip和deflate传输编码的响应数据。

例如，以请求返回的二进制数据创建一张图片，你可以使用以下代码：

>>> from PIL import Image
>>> from StringIO import StringIO
>>> i = Image.open(StringIO(r.content))

5、JSON响应内容

Requests中也有一个内置的json解码器，帮助你处理json数据：

>>> import requests
>>> r = requests.get('https://github.com/timeline.json')
>>> r.json()
[{u'repository': {u'open_issues': 0, u'url': 'https://github.com/...

如果json解码失败，r.json就会抛出一个异常。例如，响应内容是401（Unauthorized），尝试访问r.json将会抛出ValueError:No JSON object could be decoded异常。

6、原始响应内容

在罕见的情况下你可能希望获取来自服务器的原始套接字响应， 那么你可以访问r.raw。如果你确实想这么干，那请你确保在初始请求中设置了stream=True。具体的你可以这么做：

>>> r = requests.get('https://github.com/timeline.json', stream=True)
>>> r.raw
<requests.packages.urllib3.response.HTTPResponse object at 0x101194810>
>>> r.raw.read(10)
'\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03'

但在一般情况下，你应该以下面的模式将文本流保存到文件：

with open(filename, 'wb') as fd:
    for chunk in r.iter_content(chunk_size):
        fd.write(chunk)

使用Response.iter_content将会处理大量你直接使用Response.raw时不得不处理的东西。当流下载时，上面是优先推荐的获取内容方式。

7、定制请求头

如果你想为请求添加http头部，只要简单地传递一个dict给headers参数就可以了。

例如，在前一个示例中我们没有指定content-type:

>>> import json
>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}
>>> headers = {'content-type': 'application/json'}

>>> r = requests.post(url, data=json.dumps(payload), headers=headers)

8、更加复杂的POST请求

通常，你想要发送一些编码为表单形式的数据-非常像一个html表单。要实现这个，只需简单地传递一个字典给data参数。你的数据字典在发出请求时会自动编码为表单形式：

>>> payload = {'key1': 'value1', 'key2': 'value2'}
>>> r = requests.post("http://httpbin.org/post", data=payload)
>>> print r.text
{
  ...
  "form": {
    "key2": "value2",
    "key1": "value1"
  },
  ...
}

很多时候你想要发送的数据并非编码为表单形式的。如果你传递一个string而不是一个dict，那么数据会被直接发布出去。

例如，Github API v3接受编码为json的post/patch数据：

>>> import json
>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}

>>> r = requests.post(url, data=json.dumps(payload))

9、post一个multipart-encoded的文件

Requests使得上传多部分编码文件变得很简单：

>>> url = 'http://httpbin.org/post'
>>> files = {'file': open('report.xls', 'rb')}

>>> r = requests.post(url, files=files)
>>> r.text
{
  ...
  "files": {
    "file": "<censored...binary...data>"
  },
  ...
}

你可以显示地设置文件名、文件类型和请求头：

>>> url = 'http://httpbin.org/post'
>>> files = {'file': ('report.xls', open('report.xls', 'rb'), 'application/vnd.ms-excel', {'Expires': '0'})}

>>> r = requests.post(url, files=files)
>>> r.text
{
  ...
  "files": {
    "file": "<censored...binary...data>"
  },
  ...
}

如果你想，你也可以发送作为文件来接收的字符串：

>>> url = 'http://httpbin.org/post'
>>> files = {'file': ('report.csv', 'some,data,to,send\nanother,row,to,send\n')}

>>> r = requests.post(url, files=files)
>>> r.text
{
  ...
  "files": {
    "file": "some,data,to,send\\nanother,row,to,send\\n"
  },
  ...
}

如果你发送一个非常大的文件作为multipart/form-data请求，你可能希望流请求，默认情况下requests不支持，但有个第三方包支持requests-toolbelt。

10、响应状态码

我们可以检测响应状态码：

>>> r = requests.get('http://httpbin.org/get')
>>> r.status_code
200

为了方便引用，Requests还附带了一个内置的状态码查询对象：

>>> r.status_code == requests.codes.ok
True

如果发送一个失败请求（非200响应），我们可以通过Response.raise_for_status()来抛出异常：

>>> bad_r = requests.get('http://httpbin.org/status/404')
>>> bad_r.status_code
404

>>> bad_r.raise_for_status()
Traceback (most recent call last):
  File "requests/models.py", line 832, in raise_for_status
    raise http_error
requests.exceptions.HTTPError: 404 Client Error

但是，由于我们的例子中r的status_code是200，当我们调用raise_for_status()时，得到的是：

>>> r.raise_for_status()
None

11、响应头

我们可以查看以一个python字典形式展示的服务器响应头：

>>> r.headers
{
    'content-encoding': 'gzip',
    'transfer-encoding': 'chunked',
    'connection': 'close',
    'server': 'nginx/1.0.4',
    'x-runtime': '148ms',
    'etag': '"e1ca502697e5c9317743dc078f67693f"',
    'content-type': 'application/json'
}

但是这个字典比较特殊：它是仅为http头部而生的。根据rfc2616，http头部是大小写不敏感的。

因此，我们可以使用任意大写形式来访问这些响应头字段：

>>> r.headers['Content-Type']
'application/json'

>>> r.headers.get('content-type')
'application/json'

12、Cookies

如果某个响应中包含一些cookie，你可以快速访问它们：

>>> url = 'http://example.com/some/cookie/setting/url'
>>> r = requests.get(url)

>>> r.cookies['example_cookie_name']
'example_cookie_value'

要想发送你的cookies到服务器，可以使用cookies参数：

>>> url = 'http://httpbin.org/cookies'
>>> cookies = dict(cookies_are='working')

>>> r = requests.get(url, cookies=cookies)
>>> r.text
'{"cookies": {"cookies_are": "working"}}'

13、重定向和请求历史

默认情况下，除了HEAD，Requests会自动处理所有重定向。

可以使用响应对象的history方法来追踪重定向。

Response.history是一个:class:Response<requests.Response>对象的列表，为了完成请求而创建了这些对象。这个对象列表按照从最老到最近的请求进行排序。

例如，Github将所有的http请求重定向到https。

>>> r = requests.get('http://github.com')
>>> r.url
'https://github.com/'
>>> r.status_code
200
>>> r.history
[<Response [301]>]

如果你使用的是GET,OPTIONS,POST, PUT, PATCH或者DELETE,那么你可以通过allow_redirects参数禁用重定向处理：

>>> r = requests.get('http://github.com', allow_redirects=False)
>>> r.status_code
301
>>> r.history
[]

如果你使用的是HEAD，你也可以启动重定向：

>>> r = requests.head('http://github.com', allow_redirects=True)
>>> r.url
'https://github.com/'
>>> r.history
[<Response [301]>]

14、超时

你可以告诉requests在经过以timeout参数设定的秒数时间之后停止等待响应：

>>> requests.get('http://github.com', timeout=0.001)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
requests.exceptions.Timeout: HTTPConnectionPool(host='github.com', port=80): Request timed out. (timeout=0.001)

注:

timeout 仅对连接过程有效，与响应体的下载无关。 timeout is not a time limit on the entire response download; rather, an exception is raised if the server has not issued a response fortimeout seconds (more precisely, if no bytes have been received on the underlying socket fortimeout seconds).

15、错误和异常

遇到网络问题（如：dns查询失败、拒绝连接等）时，Requests会抛出一个ConnectionError异常。

遇见罕见的无效http响应时，Requests则会抛出一个HTTPError异常。

所有Requests显示抛出的异常都继承自requests.exceptions.RequestException.

英文原址：http://www.python-requests.org/en/latest/user/quickstart/#raw-response-content