【转】使用Python的Requests库进行web接口测试

时间：2021-11-19 19:56:45

原文地址：使用Python的Requests库进行web接口测试

1、Requests简介

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

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

总之，大家以后对urllib2库敬而远之就行了。来拥抱Requests吧。

Requests的官方文档：http://cn.python-requests.org/zh_CN/latest/

通过下面方法安装requests

  1. pip install requests

2、Requests如何发送HTTP请求

非常简单，先导入requests，

  1. import requests

然后，按照下面的方法发送http的各种请求:

  1. r = requests.get('https://github.com/timeline.json')
  2. r = requests.post("http://httpbin.org/post")
  3. r = requests.put("http://httpbin.org/put")
  4. r = requests.delete("http://httpbin.org/delete")
  5. r = requests.head("http://httpbin.org/get")
  6. r = requests.options("http://httpbin.org/get")

3、为URL传递参数

如果http请求需要带URL参数（注意是URL参数不是body参数），那么需要将参数附带到payload字典里头，按照下面的方法发送请求：

  1. import requests
  2. payload = {'key1': 'value1', 'key2': 'value2'}
  3. r = requests.get("http://httpbin.org/get",params=payload)
  4. print r.url

通过print(r.url)能看到URL已被正确编码:

  1. http://httpbin.org/get?key2=value2&key1=value1

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

4、unicode响应内容

  1. import requests
  2. r = requests.get('https://github.com/timeline.json')
  3. r.text

响应结果是：

{"message":"Hello there, wayfaring stranger. If you're reading this
then you probably didn't see our blog post a couple of years back
announcing that this API would Go away: http://Git.io/17AROg Fear not, you should be able to get what you need from the
shiny new Events API instead.","documentation_url":"https://developer.github.com/v3/activity/events/#list-public-events"}
Requests会自动解码来自服务器的内容。大多数unicode字符集都能被无缝地解码。请求发出后，Requests会基于HTTP头部对响应的编码作出有根据的推测。当你访问r.text之时，Requests会使用其推测的文本编码。你可以找出Requests使用了什么编码，并且能够使用r.encoding
属性来改变它

>>> r.encoding

'utf-8'

5、二进制响应内容

如果请求返回的是二进制的图片，你可以使用r.content访问请求响应体。

  1. import requests
  2. from PIL import Image
  3. from StringIO import StringIO
  4. r = requests.get('http://cn.python-requests.org/zh_CN/latest/_static/requests-sidebar.png')
  5. i = Image.open(StringIO(r.content))
  6. i.show()

6、JSON响应内容

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

  1. import requests
  2. r = requests.get('https://github.com/timeline.json')
  3. print r.json()

r.json将返回的json格式字符串解码成python字典。r.text返回的utf-8的文本。

7、定制请求头

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

  1. import requests
  2. import  json
  3. payload = {'some': 'data'}
  4. headers = {'content-type': 'application/json'}
  5. r = requests.get('https://github.com/timeline.json', data=json.dumps(payload), headers=headers)
  6. print r.json()

注意，这里的payload是放到body里面的，所以params参数要使用json数据。

8、POST请求

就像上面‘定制请求头’中的例子，将payload序列化为json格式数据，传递给data参数。

9、POST提交文件

先制作一个text文件，名为‘report.txt’，内容是‘this is a file’。Requests使得上传多部分编码文件变得很简单：

  1. import requests
  2. url = 'http://httpbin.org/post'
  3. files = {'file': open('report.txt', 'rb')}
  4. r = requests.post(url, files=files)
  5. print r.text

返回结果是：

  1. C:\Python27\python.exe C:/Users/Administrator/PycharmProjects/flaskexample/postfile.py
  2. {
  3. "args": {},
  4. "data": "",
  5. "files": {
  6. <strong>"file": "this is a file"</strong>
  7. },
  8. "form": {},
  9. "headers": {
  10. "Accept": "*/*",
  11. "Accept-Encoding": "gzip, deflate",
  12. "Content-Length": "160",
  13. "Content-Type": "multipart/form-data; boundary=a3b41a6300214ffdb55ddbc23dfc0d91",
  14. "Host": "httpbin.org",
  15. "User-Agent": "python-requests/2.7.0 CPython/2.7.9 Windows/2012Server"
  16. },
  17. "json": null,
  18. "origin": "202.108.92.226",
  19. "url": "http://httpbin.org/post"
  20. }
  21. Process finished with exit code 0

10、POST提交表单

传递一个字典给 data 参数就可以了。数据字典在发出请求时会自动编码为表单形式:

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

查看响应内容：

>>> print r.text
{
  "args": {},
  "data": "",
  "files": {},
  "form": {
    "key1": "value1",
    "key2": "value2"
  },
  "headers": {
    "Accept": "*/*",
    "Accept-Encoding": "gzip, deflate",
    "Content-Length": "23",
    "Content-Type": "application/x-www-form-urlencoded",
    "Host": "httpbin.org",
    "User-Agent": "python-requests/2.6.0 CPython/2.7.10 Windows/7"
  },
  "json": null,
  "origin": "124.251.251.2",
  "url": "http://httpbin.org/post"
}

11、响应状态码

使用r.status_code返回响应的状态码。

  1. import requests
  2. r = requests.get('http://httpbin.org/get')
  3. print r.status_code

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

  1. print r.status_code == requests.codes.ok

12、失败请求抛出异常

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

  1. import requests
  2. bad_r = requests.get('http://httpbin.org/status/404')
  3. print bad_r.status_code
  4. bad_r.raise_for_status()

返回结果是：

  1. C:\Python27\python.exe C:/Users/Administrator/PycharmProjects/flaskexample/postfile.py
  2. 404
  3. Traceback (most recent call last):
  4. File "C:/Users/Administrator/PycharmProjects/flaskexample/postfile.py", line 5, in <module>
  5. bad_r.raise_for_status()
  6. File "C:\Python27\lib\site-packages\requests\models.py", line 851, in raise_for_status
  7. raise HTTPError(http_error_msg, response=self)
  8. <strong>requests.exceptions.HTTPError: 404 Client Error: NOT FOUND</strong>
  9. Process finished with exit code 1

如果返回码是200，则不会抛出异常，即：

  1. import requests
  2. bad_r = requests.get('http://httpbin.org/get')
  3. print bad_r.status_code
  4. bad_r.raise_for_status()

的返回结果是：

  1. C:\Python27\python.exe C:/Users/Administrator/PycharmProjects/flaskexample/postfile.py
  2. 200
  3. Process finished with exit code 0

13、响应头

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

读取全部头部：

  1. r.headers

返回：

{

    'content-encoding': 'gzip',

    'transfer-encoding': 'chunked',

    'connection': 'close',

    'server': 'nginx/1.0.4',

    'x-runtime': '148ms',

    'etag': '"e1ca502697e5c9317743dc078f67693f"',

    'content-type': 'application/json'

}

读取某一个头部字段：

  1. r.headers['Content-Type']
  2. r.headers.get('content-type')

14、Cookies

得到响应中包含的一些Cookie:

  1. >>> url = 'http://example.com/some/cookie/setting/url'
  2. >>> r = requests.get(url)
  3. >>> r.cookies['example_cookie_name']
  4. 'example_cookie_value'

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

  1. >>> url = 'http://httpbin.org/cookies'
  2. >>> cookies = dict(cookies_are='working')
  3. >>> r = requests.get(url, cookies=cookies)
  4. >>> r.text

返回结果：

u'{\n  "cookies": {\n    "cookies_are": "working"\n  }\n}\n'

15、重定向与请求历史

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

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

  1. >>> r = requests.get('http://github.com')
  2. >>> r.url
  3. 'https://github.com/'
  4. >>> r.status_code
  5. 200
  6. >>> r.history
  7. [<Response [301]>]

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

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

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

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

相关文章