百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程字典 > 正文

Requests官方文档翻译——快速开始部分(1)

toyiye 2024-09-07 20:37 5 浏览 0 评论

Python Requests 库是一个非常优雅而且简单的 HTTP 工具库,但在官网中只有英文文档,相关的教程也只对核心功能做了说明,并没对 Requests 本身做一些全量的说明,基于此,本文将翻译后的 Requests 文档整理于此,用于各位学习参考,如有不正确的地方请评论区指出。此翻译版本为 2.31.0


Quickstart (快速开始)

首先,请确保:

  • 已正确的安装了 Requests
  • Requests 已经是最新的
pip install requests

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

发起一个请求

使用 Requests 发起一个请求是非常简单的。

首先导入 Requests 模块:

import requests

现在,来尝试获取一个网页。在此示例中,我们来获取 github 的发布时间线。

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

现在我们获取到了一个被命名到 r 的一个 Response 对象。至此,我们可以从这个对象中获取我们想要的所有信息。

Requests 的简单 API 意味着所有形式的 HTTP 请求都是非常明显易懂的。如下,是一个 POST 请求:

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

非常给力是吧,其他 HTTP 请求同样如此:PUT、DELETE、HEAD 和 OPTIONS.

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

这一切看着都非常棒,但这只是 Requests 所能做的开始。

Passing Parameters In URLs (在 URL 中传递参数)

通常我们希望在 URL 中发送一些短数据。如果你使用手动创建这样的 URL,则需要将数据作为 key=value 键值对形式附着在 url 的 后边,例如 httpbin.org/get?key=val 。而 Requests 中则允许你将这些参数作为字符串字典提供给 params 这个关键字参数。例如,你想添加 key1=value1key2=value2 httpbin.org/get 请求中,你就可以使用以下代码:

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

此时,可以通过打印 URL 来查看拼接是否正确:

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

Response Content(响应内容)

我们可以读取服务器响应的内容,依然以 github 时间线为例:

import requests

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

请求将自动解码来自服务器的内容,大多数 Unicode 字符集都是无缝解码的。

当你发送请求时,Requests 会基于HTTP响应数据头中编码方式来猜测对应的编码格式(Requests makes educated guesses about the encoding of the response based on the HTTP headers)。则在访问 t.text 属性的时候,文本就会使用上边猜测的编码格式解码。你可以使用 r.encoding 来获取当前的编码格式,也可以通过它来修改其值。

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

如果你修改了编码,则在你使用 r.text 时,Requests 将始终使用r.encoding 指定的新的编码方式。你可能希望在任何有特殊逻辑处理的情况下执行此操作。例如,HTML 和 XML 有能力在其自身数据中指定其编码格式。在这种情况下,你应该使用 r.content 来查找对应的编码格式,并且设置相应的编码 r.encoding,只有这样才能使你通过 r.text 来获取到正确的编码格式。

Requests 也同样适用用户自定义的情况,如果你已经创建了属于自己的编码方式并将其注册到 codecs 模块中,就可以容易地使用自定义的编码名称作为 r.enncoding 的值, 剩下的交给 Requests 来对应的编码问题。

Binary Response Content(二进制响应内容)

对于非文本内容请求,你可以使用以字节形式保存的响应体。

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

gzip 和 defalte,transfer-encodings 会自动为您解码。

如果你安装了像 Brotli 或 Brotlicffi 这样的 Brotli 库,它们则会自动为你解码。例如,要从请求返回的二进制中创建一张图片,就可以使用如下代码:

from PIL import Image
from io import BytesIO

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

JSON Response Content(JSON 响应内容)

在 Requests 中内置了一个 JSON 解码器,用于你处理 JSON 数据。

import requests

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

如果 JSON 解码失败, r.json 方法会抛出一个异常,例如,如果相应获取一个 204 响应(无内容),或者响应包含了无效的 JSON 就会抛出(requests.exceptions.JSONDecodeError)。此包装异常为可能由不同python版本和json序列化库引发的多个异常。

应该注意的是,成功调用 r.json 方法不意味着响应也是成功的,某些服务器可能会返回一个 JSON 对象在请求失败后(例如:HTTP500 的错误),这种 JSON 将会被解码和返回。因此可以使用 r.raise_for_status() 或 r.status_code来检测请求是否符合你的预期。

Raw Response Content(原始响应内容)

在极少数情况下, 你可能希望从服务器获取原生的通讯内容,这时,你就可以使用 r.raw 来获取。与此同时,你还需要在请求的时候设置 stream=True

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

r.raw
# <urllib3.response.HTTPResponse object at 0x101194810>

r.raw.read(10)
# b'\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03'

一般情况,都是使用这样的方式来将流式数据保存到一个文件中。

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 和 Response.raw 差异对比

Response.iter_content 会自动解码 gzip 和 deflate 的传输编码。

Response.raw 是一个原生的字节流,它没有解码响应中的内容。

如果你确实需要获取响应的原生字节数据,则使用Response.raw。

相关推荐

# Python 3 # Python 3字典Dictionary(1)

Python3字典字典是另一种可变容器模型,且可存储任意类型对象。字典的每个键值(key=>value)对用冒号(:)分割,每个对之间用逗号(,)分割,整个字典包括在花括号({})中,格式如...

Python第八课:数据类型中的字典及其函数与方法

Python3字典字典是另一种可变容器模型,且可存储任意类型对象。字典的每个键值...

Python中字典详解(python 中字典)

字典是Python中使用键进行索引的重要数据结构。它们是无序的项序列(键值对),这意味着顺序不被保留。键是不可变的。与列表一样,字典的值可以保存异构数据,即整数、浮点、字符串、NaN、布尔值、列表、数...

Python3.9又更新了:dict内置新功能,正式版十月见面

机器之心报道参与:一鸣、JaminPython3.8的热乎劲还没过去,Python就又双叒叕要更新了。近日,3.9版本的第四个alpha版已经开源。从文档中,我们可以看到官方透露的对dic...

Python3 基本数据类型详解(python三种基本数据类型)

文章来源:加米谷大数据Python中的变量不需要声明。每个变量在使用前都必须赋值,变量赋值以后该变量才会被创建。在Python中,变量就是变量,它没有类型,我们所说的"类型"是变...

一文掌握Python的字典(python字典用法大全)

字典是Python中最强大、最灵活的内置数据结构之一。它们允许存储键值对,从而实现高效的数据检索、操作和组织。本文深入探讨了字典,涵盖了它们的创建、操作和高级用法,以帮助中级Python开发...

超级完整|Python字典详解(python字典的方法或操作)

一、字典概述01字典的格式Python字典是一种可变容器模型,且可存储任意类型对象,如字符串、数字、元组等其他容器模型。字典的每个键值key=>value对用冒号:分割,每个对之间用逗号,...

Python3.9版本新特性:字典合并操作的详细解读

处于测试阶段的Python3.9版本中有一个新特性:我们在使用Python字典时,将能够编写出更可读、更紧凑的代码啦!Python版本你现在使用哪种版本的Python?3.7分?3.5分?还是2.7...

python 自学,字典3(一些例子)(python字典有哪些基本操作)

例子11;如何批量复制字典里的内容2;如何批量修改字典的内容3;如何批量修改字典里某些指定的内容...

Python3.9中的字典合并和更新,几乎影响了所有Python程序员

全文共2837字,预计学习时长9分钟Python3.9正在积极开发,并计划于今年10月发布。2月26日,开发团队发布了alpha4版本。该版本引入了新的合并(|)和更新(|=)运算符,这个新特性几乎...

Python3大字典:《Python3自学速查手册.pdf》限时下载中

最近有人会想了,2022了,想学Python晚不晚,学习python有前途吗?IT行业行业薪资高,发展前景好,是很多求职群里严重的香饽饽,而要进入这个高薪行业,也不是那么轻而易举的,拿信工专业的大学生...

python学习——字典(python字典基本操作)

字典Python的字典数据类型是基于hash散列算法实现的,采用键值对(key:value)的形式,根据key的值计算value的地址,具有非常快的查取和插入速度。但它是无序的,包含的元素个数不限,值...

324页清华教授撰写【Python 3 菜鸟查询手册】火了,小白入门字典

如何入门学习python...

Python3.9中的字典合并和更新,了解一下

全文共2837字,预计学习时长9分钟Python3.9正在积极开发,并计划于今年10月发布。2月26日,开发团队发布了alpha4版本。该版本引入了新的合并(|)和更新(|=)运算符,这个新特性几乎...

python3基础之字典(python中字典的基本操作)

字典和列表一样,也是python内置的一种数据结构。字典的结构如下图:列表用中括号[]把元素包起来,而字典是用大括号{}把元素包起来,只不过字典的每一个元素都包含键和值两部分。键和值是一一对应的...

取消回复欢迎 发表评论:

请填写验证码