Make a Request
一开始要导入 Requests 模块:
>>> import requests
然后,尝试获取某个网页。本例子中,我们来获取 Github 的公共时间线:
>>> r = requests.get('https://api.github.com/events')
现在,我们有一个名为 r
的 Response
对象。我们可以从这个对象中获取所有我们想要的信息。
Requests 简便的 API 意味着所有 HTTP 请求类型都是显而易见的。例如,你可以这样发送一个 HTTP POST 请求:
>>> r = requests.post('http://httpbin.org/post', data = {'key':'value'})
漂亮,对吧?那么其他 HTTP 请求类型:PUT,DELETE,HEAD 以及 OPTIONS 又是如何的呢?都是一样的简单:
>>> 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 的冰山一角呢。
传递 URL 参数
你也许经常想为 URL 的查询字符串(query string)传递某种数据。如果你是手工构建 URL,那么数据会以键/值对的形式置于 URL 中,跟在一个问号的后面。例如, httpbin.org/get?key=val
。 Requests 允许你使用 params
关键字参数,以一个字符串字典来提供这些参数。举例来说,如果你想传递 key1=value1
和 key2=value2
到 httpbin.org/get
,那么你可以使用如下代码:
>>> payload = {'key1': 'value1', 'key2': 'value2'} >>> r = requests.get("http://httpbin.org/get", params=payload)
通过打印输出该 URL,你能看到 URL 已被正确编码:
>>> print(r.url) http://httpbin.org/get?key2=value2&key1=value1
注意字典里值为 None
的键都不会被添加到 URL 的查询字符串里。
你还可以将一个列表作为值传入:
>>> 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
响应内容
我们能读取服务器响应的内容。再次以 GitHub 时间线为例:
>>> import requests >>> r = requests.get('https://api.github.com/events') >>> 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
,Request 都将会使用 r.encoding
的新值。你可能希望在使用特殊逻辑计算出文本的编码的情况下来修改编码。比如 HTTP 和 XML 自身可以指定编码。这样的话,你应该使用 r.content
来找到编码,然后设置 r.encoding
为相应的编码。这样就能使用正确的编码解析 r.text
了。
在你需要的情况下,Requests 也可以使用定制的编码。如果你创建了自己的编码,并使用 codecs
模块进行注册,你就可以轻松地使用这个解码器名称作为 r.encoding
的值, 然后由 Requests 来为你处理编码。
二进制响应内容
你也能以字节的方式访问请求响应体,对于非文本请求:
>>> r.content b'[{"repository":{"open_issues":0,"url":"https://github.com/...
Requests 会自动为你解码 gzip
和 deflate
传输编码的响应数据。
例如,以请求返回的二进制数据创建一张图片,你可以使用如下代码:
>>> from PIL import Image >>> from io import BytesIO >>> i = Image.open(BytesIO(r.content))
JSON 响应内容
Requests 中也有一个内置的 JSON 解码器,助你处理 JSON 数据:
>>> 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()
就会抛出一个异常。例如,响应内容是 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
。 如果你确实想这么干,那请你确保在初始请求中设置了 stream=True
。具体你可以这么做:
>>> r = requests.get('https://api.github.com/events', stream=True) >>> r.raw <requests.packages.urllib3.response.HTTPResponse object at 0x101194810> >>> r.raw.read(10) 'x1fx8bx08x00x00x00x00x00x00x03'
但一般情况下,你应该以下面的模式将文本流保存到文件:
with open(filename, 'wb') as fd: for chunk in r.iter_content(chunk_size=128): fd.write(chunk)
使用Response.iter_content
将处理很多您Response.raw
直接使用时要处理的内容。流式下载时,以上是检索内容的首选和推荐方法。请注意,chunk_size
可以随意调整为更适合您的用例的数字。
注意:
有关使用Response.iter_content
vs的重要说明Response.raw
。 Response.iter_content
将自动解码gzip
和deflate
传输编码。 Response.raw
是原始的字节流–它不会转换响应内容。如果您确实需要访问返回的字节,请使用Response.raw
。
自定义请求头
如果您想向请求中添加HTTP标头,只需将参数传递给dict
即可 headers
。
例如,在上一个示例中,我们没有指定用户代理:
>>> url = 'https://api.github.com/some/endpoint' >>> headers = {'user-agent': 'my-app/0.0.1'} >>> r = requests.get(url, headers=headers)
注意:自定义标头的优先级低于更具体的信息源。例如:
- 如果.netrc中指定了凭据,则设置为headers=的授权头将被覆盖,而auth=参数又将覆盖该凭据。请求将在~/.netrc、~/_netrc或netrc环境变量指定的路径中搜索netrc文件。
- 如果被重定向到别的主机,授权 header 就会被删除。
- URL中提供的代理凭据将覆盖代理授权头Proxy-Authorization。
- 当我们可以确定内容的长度时,Content-Length标头将被覆盖。
此外,“请求”根本不会根据指定的自定义标头更改其行为。标头只是传递到最终请求中。
注意:所有头值必须是字符串,字节字符串,或unicode。在允许的情况下,建议避免传递unicode头值。
更加复杂的 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_tuples = [('key1', 'value1'), ('key1', 'value2')] >>> r1 = requests.post('https://httpbin.org/post', data=payload_tuples) # 2.18版本&2.25版本 >>> payload_dict = {'key1': ['value1', 'value2']} >>> r2 = requests.post('https://httpbin.org/post', data=payload_dict) # 2.25版本 >>> print(r1.text) { ... "form": { "key1": [ "value1", "value2" ] }, ... } >>> r1.text == r2.text True # 2.18版本False
很多时候你想要发送的数据并非编码为表单形式的。如果你传递一个 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)
注意,如果传递了数据或文件,json参数将被忽略。
在请求中使用json参数将把header中的Content-Type更改为application/json。
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 another,row,to,send ')} >>> 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
是支持的。你可以阅读 toolbelt 文档 来了解使用方法。
在一个请求中发送多文件参考 高级用法 一节。
警告
我们强烈建议你用二进制模式(binary mode)打开文件。这是因为 Requests 可能会试图为你提供 Content-Length
header,在它这样做的时候,这个值会被设为文件的字节数(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, 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
一切都挺和谐哈。
响应头
我们可以查看以一个 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 会将它们合并,这样它们就可以用一个映射来表示出来,参见 RFC 7230:
A recipient MAY combine multiple header fields with the same field name into one "field-name: field-value" pair, without changing the semantics of the message, by appending each subsequent field value to the combined field value in order, separated by a comma.
接收者可以合并多个相同名称的 header 栏位,把它们合为一个 "field-name: field-value" 配对,将每个后续的栏位值依次追加到合并的栏位值中,用逗号隔开即可,这样做不会改变信息的语义。
重定向与请求历史
默认情况下,除了 HEAD, Requests 会自动处理所有重定向。
可以使用响应对象的 history
方法来追踪重定向。
Response.history
是一个 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]>]
超时
你可以告诉 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
几秒钟未发出响应(更确切地说,如果几秒钟内未在基础套接字上接收到任何字节),则会引发异常timeout
。如果未明确指定超时,则请求不会超时。
错误与异常
遇到网络问题(如:DNS 查询失败、拒绝连接等)时,Requests 会抛出一个 ConnectionError
异常。
如果 HTTP 请求返回了不成功的状态码, Response.raise_for_status()
会抛出一个 HTTPError
异常。
若请求超时,则抛出一个 Timeout
异常。
若请求超过了设定的最大重定向次数,则会抛出一个 TooManyRedirects
异常。
所有Requests显式抛出的异常都继承自 requests.exceptions.RequestException
。
添加请求头
req = requests.get(url, headers=range_header)
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # @Time: 2020/12/16 10:42 # @Author:zhangmingda # @File: requests_multi_download.py # @Software: PyCharm # Description: 使用requests 模块 实现多线程下载某个文件测试 from concurrent.futures import ThreadPoolExecutor, as_completed import requests import json import math import os import requests class DownLoader(object): def __init__(self): self.part_size = 1024 * 1024 * 10 # 分块下载大小 self.part_thread_num = 10 self.BUFFER_SIZE = 64 * 1024 def download_part(self, url, part_filename, offset, end_bytes): """ :param encode_url:经过URL编码的网络地址 :param part_filename: 文件块儿名字 :param offset: 下载字节起始点(包含) :param end_bytes: 下载字节结束点(包含) :return: (下载结果) """ # 构造请求头 range_header = { 'Range': 'bytes=%s-%s' % (offset, end_bytes) } print(range_header) cur_task_ret = False expected_file_size = end_bytes - offset + 1 part_req = requests.get(url, headers=range_header) with open(part_filename, 'wb') as local_part_fd: local_part_fd.write(part_req.content) if expected_file_size == os.stat(part_filename).st_size: print('%s 与预期块儿文件大小相符' % part_filename) cur_task_ret = True # break else: print('%s 与预期块儿文件大小 不符,预期%s字节,实际得到%s 字节' % ( part_filename, expected_file_size, os.stat(part_filename).st_size)) return {part_filename: cur_task_ret} def download(self, url): finally_filename = os.path.basename(url) # 发起请求并且获取内容长度 with requests.get(url, stream=True) as r: length = r.headers.get("Content-Length") length = int(length) print(type(length)) print('length:', length) # 分块任务列表 thread_list = [] # 每个块儿下载的结果 multi_chunk_download_result = {} chunk_size = self.part_size # 计算需要下载的块儿个数 chunk_count = int(math.ceil(length / float(chunk_size))) pool_args_list = [] # 计算每个块儿请求的字节范围 for i in range(chunk_count): offset = chunk_size * i end_bytes = min(chunk_size * (i + 1), length) - 1 # 将一个文件划分的所有块儿任务,添加到任务列表 part_num = i + 1 part_filename = finally_filename + '.' + str(part_num) # 每个块儿请求的范围,块儿名字,加到线程参数列表 # pool_args_list.append((encode_url, part_filename, offset, end_bytes)) pool_args_list.append((url, part_filename, offset, end_bytes)) # ********开始多线程下载数据,并获取下载结果************** # 构建线程池实例 tp = ThreadPoolExecutor(max_workers=self.part_thread_num) # 全部添加到任务队列开始处理 [thread_list.append(tp.submit(self.download_part, *args)) for args in pool_args_list] # 等待所有线程结束,获取全部线程的执行结果 [multi_chunk_download_result.update(part_thread.result()) for part_thread in as_completed(thread_list)] # 下载总结 print('下载总结') # 如果任务数和块儿数对不上,报一下出入 if len(multi_chunk_download_result) != chunk_count: raise RuntimeError( "%s part miss,expect=%d,actual=%d" % (finally_filename, chunk_count, len(multi_chunk_download_result))) # 如果任务都完毕,检查是否有失败的块儿 for item in multi_chunk_download_result.keys(): if not multi_chunk_download_result[item]: raise RuntimeError("%s part upload has fail" % item) # 都OK 整合文件 with open(finally_filename, 'wb') as local_fd: for i in range(chunk_count): part_filename = finally_filename + '.' + str(i + 1) with open(part_filename, 'rb') as part_fd: while True: bytes_data = part_fd.read(self.BUFFER_SIZE) if not bytes_data: break local_fd.write(bytes_data) if length == os.stat(finally_filename).st_size: print('%s 下载完成,文件大小相符' % finally_filename) for part_filename in multi_chunk_download_result.keys(): os.remove(part_filename) else: print('%s 下载完成,但大小不符,content_length:%s 下载后大小 %s' % (finally_filename, length,os.stat(finally_filename).st_size )) if __name__ == '__main__': downloader = DownLoader() url = 'https://xxxxxxxxxxxxx.mp4' print(url) downloader.download(url)
流式下载
req = requests.get(url, stream=True, headers=range_header)
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # @Time: 2020/12/16 10:42 # @Author:zhangmingda # @File: requests_multi_download.py # @Software: PyCharm # Description: 使用requests 模块 实现多线程下载某个文件测试 from concurrent.futures import ThreadPoolExecutor, as_completed import requests import json import math import os import requests class DownLoader(object): def __init__(self): self.part_size = 1024 * 1024 * 10 # 分块下载大小 self.part_thread_num = 10 self.BUFFER_SIZE = 64 * 1024 def download_part(self, url, part_filename, offset, end_bytes): """ :param encode_url:经过URL编码的网络地址 :param part_filename: 文件块儿名字 :param offset: 下载字节起始点(包含) :param end_bytes: 下载字节结束点(包含) :return: (下载结果) """ # 构造请求头 range_header = { 'Range': 'bytes=%s-%s' % (offset, end_bytes) } print(range_header) cur_task_ret = False expected_file_size = end_bytes - offset + 1 part_req = requests.get(url, stream=True, headers=range_header) with open(part_filename, 'wb') as local_part_fd: for data in part_req.iter_content(chunk_size=32): local_part_fd.write(data) if expected_file_size == os.stat(part_filename).st_size: print('%s 与预期块儿文件大小相符' % part_filename) cur_task_ret = True # break else: print('%s 与预期块儿文件大小 不符,预期%s字节,实际得到%s 字节' % ( part_filename, expected_file_size, os.stat(part_filename).st_size)) return {part_filename: cur_task_ret} def download(self, url): finally_filename = os.path.basename(url) # 发起请求并且获取内容长度 with requests.get(url, stream=True) as r: length = r.headers.get("Content-Length") length = int(length) print(type(length)) print('length:', length) # 分块任务列表 thread_list = [] # 每个块儿下载的结果 multi_chunk_download_result = {} chunk_size = self.part_size # 计算需要下载的块儿个数 chunk_count = int(math.ceil(length / float(chunk_size))) pool_args_list = [] # 计算每个块儿请求的字节范围 for i in range(chunk_count): offset = chunk_size * i end_bytes = min(chunk_size * (i + 1), length) - 1 # 将一个文件划分的所有块儿任务,添加到任务列表 part_num = i + 1 part_filename = finally_filename + '.' + str(part_num) # 每个块儿请求的范围,块儿名字,加到线程参数列表 # pool_args_list.append((encode_url, part_filename, offset, end_bytes)) pool_args_list.append((url, part_filename, offset, end_bytes)) # ********开始多线程下载数据,并获取下载结果************** # 构建线程池实例 tp = ThreadPoolExecutor(max_workers=self.part_thread_num) # 全部添加到任务队列开始处理 [thread_list.append(tp.submit(self.download_part, *args)) for args in pool_args_list] # 等待所有线程结束,获取全部线程的执行结果 [multi_chunk_download_result.update(part_thread.result()) for part_thread in as_completed(thread_list)] # 下载总结 print('下载总结') # 如果任务数和块儿数对不上,报一下出入 if len(multi_chunk_download_result) != chunk_count: raise RuntimeError( "%s part miss,expect=%d,actual=%d" % (finally_filename, chunk_count, len(multi_chunk_download_result))) # 如果任务都完毕,检查是否有失败的块儿 for item in multi_chunk_download_result.keys(): if not multi_chunk_download_result[item]: raise RuntimeError("%s part upload has fail" % item) # 都OK 整合文件 with open(finally_filename, 'wb') as local_fd: for i in range(chunk_count): part_filename = finally_filename + '.' + str(i + 1) with open(part_filename, 'rb') as part_fd: while True: bytes_data = part_fd.read(self.BUFFER_SIZE) if not bytes_data: break local_fd.write(bytes_data) if length == os.stat(finally_filename).st_size: print('%s 下载完成,文件大小相符' % finally_filename) for part_filename in multi_chunk_download_result.keys(): os.remove(part_filename) else: print('%s 下载完成,但大小不符,content_length:%s 下载后大小 %s' % (finally_filename, length,os.stat(finally_filename).st_size )) if __name__ == '__main__': downloader = DownLoader() url = 'https://XXXXXXXXXXXXXX.mp4' print(url) downloader.download(url)