我们接着上一篇的内容,继续讲如何使用Python中的Requests库进行HTTP接口测试吧。
定制请求头
如果你想为请求添加 HTTP 头部,只要简单地传递一个 dict 给 headers 参数就可以了。例如,在上一篇的示例中我们指定下 content-type:
url ='https://api.github.com/some/endpoint'
headers = {'user-agent':'my-app/0.0.1'}
r = requests.get(url, headers=headers)
注意: 定制 header 的优先级低于某些特定的信息源,例如:
·如果在 .netrc 中设置了用户认证信息,使用 headers= 设置的授权就不会生效。而如果设置了auth= 参数,.netrc 的设置就无效了。
·如果被重定向到别的主机,授权 header 就会被删除。
·代理授权 header 会被 URL 中提供的代理身份覆盖掉。
·在我们能判断内容长度的情况下,header 的 Content-Length 会被改写。
更进一步讲,Requests 不会基于定制 header 的具体情况改变自己的行为。只不过在最后的请求中,所有的 header 信息都会被传递进去。
注意: 所有的 header 值必须是 string、bytestring 或者 unicode。尽管传递 unicode header 也是允许的,但不建议这样做。
更加复杂的 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"
},
...
}
你还可以为 data 参数传入一个元组列表。在表单中多个元素使用同一 key 的时候,这种方式尤其有效:
payload = (('key1','value1'), ('key1','value2'))
r = requests.post('http://httpbin.org/post', data=payload)
>>> print(r.text)
{
...
"form": {
"key1": [
"value1",
"value2"
]
},
...
}
很多时候你想要发送的数据并非编码为表单形式的。如果你传递一个 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))
此处除了可以自行对 dict 进行编码,你还可以使用 json 参数直接传递,然后它就会被自动编码。这是 2.4.2 版的新加功能:
url ='https://api.github.com/some/endpoint'
payload = {'some':'data'}
r = requests.post(url, json=payload)
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)
如果你想,你也可以发送作为文件来接收的字符串:
files = {'file': ('report.csv', 'some,data,to,send\nanother,row,to,send\n')}
如果你发送一个非常大的文件作为 multipart/form-data 请求,你可能希望将请求做成数据流。默认下 requests 不支持, 但有个第三方包 requests-toolbelt 是支持的。你可以阅读 toolbelt 文档 来了解使用方法。
警告:我们强烈建议你用二进制模式(binary mode)打开文件。这是因为 Requests 可能会试图为你提供 Content-Lengthheader,在它这样做的时候,这个值会被设为文件的字节数(bytes)。如果用文本模式(text mode)打开文件,就可能会发生错误。
响应状态码
我们可以检测响应状态码:
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,inraise_for_status
raise http_error
requests.exceptions.HTTPError:404 Client Error
但是,由于status_code 是 200 ,当我们调用 raise_for_status() 时,返回的是:None
响应头
我们可以查看以一个 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'
它还有一个特殊点,那就是服务器可以多次接受同一 header,每次都使用不同的值。但 Requests 会将它们合并,这样它们就可以用一个映射来表示出来。
网友评论