Requests从入门到精通 on 重定向学院

如何安装requests?

Wed, 22 Nov 2017 03:23:57 +0800

官方给出的安装方式是使用pipenv

pipenv install requests

当然也可以直接使用pip安装

pip install requests

还可以从源码安装

git clone git://github.com/requests/requests.git
cd requests
pip install .

原始封面

requests如何发送get请求?

Wed, 22 Nov 2017 03:23:57 +0800

官方文档

使用requests发送请求其实非常简单。

首先导入Requests模块

>>> import requests

下面试着去发送具体的请求，比如获取github的timeline信息

r = requests.get('https://api.github.com/events')

r是requests的响应(Response)对象，我们可以从r里面获取各种信息，比如获取响应的内容print(r.text)

原始封面

requests如何发送post请求?

Wed, 22 Nov 2017 03:23:57 +0800

官方文档

发送post请求跟发送get请求类似，使用requests.post方法就可以了，如果需要传post data的话，直接将data以dict的格式传递就好。

>>> import requests
>>> r = requests.post('http://httpbin.org/post', data = {'key':'value'})

requests如何发送其他请求

Wed, 22 Nov 2017 03:23:57 +0800

官方文档

delete,options,put等类型的请求在requests中均有对应的方法

>>> r = requests.put('http://httpbin.org/put', data = {'key':'value'})
>>> r = requests.delete('http://httpbin.org/delete')
>>> r = requests.head('http://httpbin.org/get')
>>> r = requests.options('http://httpbin.org/get')

也可以使用requests统一的request方法来发送各种请求

r = requests.request('get', 'https://api.github.com/events')
>>> r = requests.request('post', 'http://httpbin.org/post', data = {'key':'value'})
>>> r = requests.request('put', 'http://httpbin.org/put', data = {'key':'value'})
>>> r = requests.request('delete', 'http://httpbin.org/delete')
>>> r = requests.request('head', 'http://httpbin.org/get')
>>> r = requests.request('options', 'http://httpbin.org/get')

原始封面

requests如何自定义请求的headers?

Wed, 22 Nov 2017 03:23:57 +0800

官方文档

有时候我们需要自定义一些请求的headers，比如我们可能需要将jwt的token放到headers里以完成鉴权。

>>> url = 'https://api.github.com/some/endpoint'
>>> headers = {'user-agent': 'my-app/0.0.1'}

>>> r = requests.get(url, headers=headers)

原始封面

requests如何构造复杂的post请求?

Wed, 22 Nov 2017 03:23:57 +0800

默认情况下，在post方法中使用 data 关键字参数，Requests的行为会表现的像是在发送一个html表单，比如

>>> payload = {'key1': 'value1', 'key2': 'value2'}

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

如果需要为多个元素使用同一key的话，可以在data中传入元组，比如

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

如果 data 中传的是string而不是dict的话，那么字符串将会被直接发送出去

>>> import json

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

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

因为现在很多api接受json字符串格式的post data，Requests为这种方式提供了更简单的写法

requests如何在url中传递参数?

Wed, 22 Nov 2017 03:23:57 +0800

官方文档

我们经常需要在请求中加参数，比如一些分页信息，每页返回的资源数量等。

如果我们手工去构造这些参数的话，我们会在url后面接?，然后传入key/value对，比如httpbin.org/get?key=val。多个key/value对以&分隔。

在Requests里，我们一般使用params关键字参数的方式，传入dict来传递url参数。比如，假设我们想传递key1=value1和key2=value2这2个参数，我们可以用下面的代码

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

可以通过url方法来查看requests帮我们构造的编码后的url

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

我们还可以为同一个key传递一组数据，比如

>>> payload = {'key1': 'value1', 'key2': ['value2', 'value3']}

>>> r = requests.get('http://httpbin.org/get', params=payload)
>>> print(r.url)
http://httpbin.org/get?key1=value1&key2=value2&key2=value3

原始封面

requests如何获取响应的状态码?

Wed, 22 Nov 2017 03:23:57 +0800

使用status_code 就可以了。

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

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

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

如果发送了一个错误请求(一个 4XX 客户端错误，或者 5XX 服务器错误响应)，我们可以通过 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

如果在测试用例中直接使用raise_for_status()方法，如果有异常抛出的话，用例会自动失败。

原始封面

requests如何查看响应内容?

Wed, 22 Nov 2017 03:23:57 +0800

text 方法会拿到请求的响应内容，比如以再github的timeline接口为例

>>> import requests

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

Requests会自动去解码server端返回的内容，大部分的unicode字符集都会被无缝解码。

当你发送请求的时候，Requests会根据HTTP headers来推断编码，并在r.text调用的时候使用。我们可以查看和修改Requests的编码，比如

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

原始封面

requests中如何查看响应的headers?

Wed, 22 Nov 2017 03:23:57 +0800

r.headers 可以拿到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 头部而生的。根据RFC 2616， HTTP 头部是大小写不敏感的。

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

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

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

原始封面

requests如何解析json响应?

Wed, 22 Nov 2017 03:23:57 +0800

官方文档

如果服务器返回json格式的数据，那么我们一般希望可以把json字符串转成python的dict数据类型。

>>> import requests

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

如果JSON解析失败，r.json()会抛异常。比如假设响应的返回状态码是204(No Content)，又或者响应的返回json字符串格式有错误，那么r.json()回抛出ValueError: No JSON object could be decoded.异常。

需要引起注意的是r.json()解析成功了并不代表请求是成功的。很多服务器在响应失败的时候也会返回json字符串，如果要判断响应的状态的话，建议使用r.raise_for_status() 或者使用check r.status_code来判断返回值是否符合预期。

原始封面

requests如何查看cookies和发送cookies?

Wed, 22 Nov 2017 03:23:57 +0800

如果某个响应中包含一些 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"}}'

Cookie 的返回对象为 RequestsCookieJar，它的行为和字典类似，但界面更为完整，适合跨域名跨路径使用。你还可以把 Cookie Jar 传到 Requests 中：

>>> jar = requests.cookies.RequestsCookieJar()
>>> jar.set('tasty_cookie', 'yum', domain='httpbin.org', path='/cookies')
>>> jar.set('gross_cookie', 'blech', domain='httpbin.org', path='/elsewhere')
>>> url = 'http://httpbin.org/cookies'
>>> r = requests.get(url, cookies=jar)
>>> r.text
'{"cookies": {"tasty_cookie": "yum"}}'

原始封面

requests如何处理url的重定向?

Wed, 22 Nov 2017 03:23:57 +0800

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

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

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

可以使用history方法来追踪重定向

>>> r = requests.get('http://github.com')

>>> r.url
'https://github.com/'

>>> r.status_code
200

>>> r.history
[<Response [301]>]

如果你使用了 HEAD 方法，你也可以启用重定向：

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

原始封面

requests如何处理二进制的响应内容？

Wed, 22 Nov 2017 03:23:57 +0800

官方文档

有时候服务器返回的数据不是文本的，而是二进制的，这时候我们就需要处理二进制的内容。

Requests中可以使用content方法来返回二进制的响应内容，比如

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

如果响应是gzip压缩过的，Requests会自动解压。

下面这个例子演示了如何从服务器返回的二进制内容创建图片。

>>> from PIL import Image
>>> from io import BytesIO

>>> i = Image.open(BytesIO(r.content))

原始封面

requests中如何设置请求的超时时间?

Wed, 22 Nov 2017 03:23:57 +0800

使用timeout 参数可以设定等待连接的秒数，如果等待超时，Requests会抛出异常

>>> 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 并不是整个下载响应的时间限制，而是如果服务器在 timeout 秒内没有应答，将会引发一个异常（更精确地说，是在 timeout 秒内没有从基础套接字上接收到任何字节的数据时)。

原始封面

requests中如何上传文件?

Wed, 22 Nov 2017 03:23:57 +0800

最简单的方式

>>> 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>"
 },
 ...
}

原始封面