Requests：Python HTTP 请求库指南

需积分: 10 127 浏览量更新于2024-07-18 收藏 13.03MB PDF 举报

"Requests是Python的一个HTTP客户端库，用于发送HTTP/1.1请求，简化了网络请求的处理。它自动处理如连接保持、HTTP连接池等细节，并且与urllib3库紧密集成。Requests库无需手动添加查询字符串或编码POST数据，使得HTTP请求变得更加便捷。" Requests文档详细介绍了这个库的各个方面，包括用户评价、特色功能、用户指南、社区指南和API文档。以下是这些部分的关键知识点： 1. **用户评价(User Testimonials)**：这部分可能包含用户对Requests库的反馈和评价，展示了其在实际应用中的性能和易用性。 2. **备受喜爱的功能(Beloved Features)**：这里可能列出Requests库的一些核心特性，如自动化处理HTTP连接、支持各种HTTP方法（GET, POST等）、自动处理编码和解码、易于理解的API设计等。 3. **用户指南(The User Guide)**： - **介绍(Introduction)**：解释Requests库的基本概念和使用目的，引导用户开始使用。 - **安装(Installation of Requests)**：指导用户如何在Python环境中安装Requests库，通常涉及pip命令。 - **快速入门(Quickstart)**：提供一个简单的示例，展示如何发送第一个HTTP请求，包括导入模块、发送GET请求和解析响应。 - **高级使用(Advanced Usage)**：深入讲解更多高级特性，如文件上传、自定义头部、超时设置、会话对象（Session）以及错误处理等。 - **认证(Authentication)**：涵盖基本的HTTP认证机制，如Basic Auth和Digest Auth，以及OAuth等更复杂的认证方式。 4. **社区指南(The Community Guide)**： - **社区赞助者(Community Sponsors)**：列出对Requests项目提供支持的个人或组织。 - **推荐的包和扩展(Recommended Packages and Extensions)**：推荐与Requests库配合使用的其他Python库，以增强功能。 - **常见问题(Frequently Asked Questions, FAQ)**：解答用户在使用过程中遇到的常见问题。 - **集成(Integrations)**：介绍如何将Requests与其他工具或框架（如Django, Flask等）结合使用。 - **文章和演讲(Articles & Talks)**：列出有关Requests的教程、博客文章和演讲资源。 - **支持(Support)**：提供获取帮助的途径，如邮件列表、GitHub issues等。 - **漏洞披露(Vulnerability Disclosure)**：说明如何报告安全问题和漏洞。 - **社区更新(Community Updates)**：发布社区的最新动态和版本更新信息。 - **版本历史(Release and Version History)**：记录Requests库的历史版本和变更记录。 - **发布流程和规则(Release Process and Rules)**：描述版本发布的流程和准则。 5. **API文档/指南(The API Documentation/Guide)**： - **开发者接口(Developer Interface)**：详细说明Requests库提供的所有类、方法和函数，供开发者参考和调用。 6. **贡献者指南(The Contributor Guide)**： - **贡献者指南(Contributor’s Guide)**：为想要贡献代码或文档的用户提供指南，包括开发环境设置、代码风格指南和提交流程。 - **开发哲学(Development Philosophy)**：阐述Requests库的设计原则和开发理念。 - **如何帮忙(How to Help)**：鼓励并指导用户如何参与项目，包括报告问题、提交修复或建议新功能。 - **作者(Authors)**：列出Requests库的主要开发者和贡献者。 Requests库是Python中广泛使用的HTTP客户端库，它极大地简化了HTTP请求的编写，使开发者可以更加专注于应用程序的业务逻辑，而不是底层网络通信的细节。通过阅读其文档，用户不仅可以学会如何使用Requests库，还能了解到更广泛的HTTP和网络编程知识。

Requests Documentation, Release 2.18.4

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

Nice, right? What about the other HTTP request types: PUT, DELETE, HEAD and OPTIONS? These are all just as

simple:

>>> 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')

That’s all well and good, but it’s also only the start of what Requests can do.

3.3.2 Passing Parameters In URLs

You often want to send some sort of data in the URL’s query string. If you were constructing the URL by hand, this

data would be given as key/value pairs in the URL after a question mark, e.g. httpbin.org/get?key=val.

Requests allows you to provide these arguments as a dictionary of strings, using the params keyword argument. As

an example, if you wanted to pass key1=value1 and key2=value2 to httpbin.org/get, you would use the

following code:

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

>>> r = requests.get('http://httpbin.org/get', params=payload)

You can see that the URL has been correctly encoded by printing the URL:

>>> print(r.url)

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

Note that any dictionary key whose value is None will not be added to the URL’s query string.

You can also pass a list of items as a value:

>>> 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

3.3.3 Response Content

We can read the content of the server’s response. Consider the GitHub timeline again:

>>> import requests

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

>>> r.text

u'[{"repository":{"open_issues":0,"url":"https://github.com/...

Requests will automatically decode content from the server. Most unicode charsets are seamlessly decoded.

When you make a request, Requests makes educated guesses about the encoding of the response based on the HTTP

headers. The text encoding guessed by Requests is used when you access r.text. You can ﬁnd out what encoding

Requests is using, and change it, using the r.encoding property:

12 Chapter 3. The User Guide

Requests Documentation, Release 2.18.4

>>> r.encoding

'utf-8'

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

If you change the encoding, Requests will use the new value of r.encoding whenever you call r.text. You might

want to do this in any situation where you can apply special logic to work out what the encoding of the content will

be. For example, HTML and XML have the ability to specify their encoding in their body. In situations like this, you

should use r.content to ﬁnd the encoding, and then set r.encoding. This will let you use r.text with the

correct encoding.

Requests will also use custom encodings in the event that you need them. If you have created your own encoding

and registered it with the codecs module, you can simply use the codec name as the value of r.encoding and

Requests will handle the decoding for you.

3.3.4 Binary Response Content

You can also access the response body as bytes, for non-text requests:

>>> r.content

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

The gzip and deflate transfer-encodings are automatically decoded for you.

For example, to create an image from binary data returned by a request, you can use the following code:

>>> from PIL import Image

>>> from io import BytesIO

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

3.3.5 JSON Response Content

There’s also a builtin JSON decoder, in case you’re dealing with JSON data:

>>> import requests

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

>>> r.json()

[{u'repository': {u'open_issues': 0, u'url': 'https://github.com/...

In case the JSON decoding fails, r.json() raises an exception. For example, if the response gets a 204 (No Con-

tent), or if the response contains invalid JSON, attempting r.json() raises ValueError: No JSON object

could be decoded.

It should be noted that the success of the call to r.json() does not indicate the success of the response. Some

servers may return a JSON object in a failed response (e.g. error details with HTTP 500). Such JSON will be decoded

and returned. To check that a request is successful, use r.raise_for_status() or check r.status_code is

what you expect.

3.3.6 Raw Response Content

In the rare case that you’d like to get the raw socket response from the server, you can access r.raw. If you want to

do this, make sure you set stream=True in your initial request. Once you do, you can do this:

3.3. Quickstart 13

Requests Documentation, Release 2.18.4

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

>>> r.raw

<urllib3.response.HTTPResponse object at 0x101194810>

>>> r.raw.read(10)

'\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03'

In general, however, you should use a pattern like this to save what is being streamed to a ﬁle:

with open(filename, 'wb') as fd:

for chunk in r.iter_content(chunk_size=128):

fd.write(chunk)

Using Response.iter_content will handle a lot of what you would otherwise have to handle when using

Response.raw directly. When streaming a download, the above is the preferred and recommended way to retrieve

the content. Note that chunk_size can be freely adjusted to a number that may better ﬁt your use cases.

Note: An important note about using Response.iter_content versus Response.raw. Response.

iter_content will automatically decode the gzip and deflate transfer-encodings. Response.raw is a

raw stream of bytes – it does not transform the response content. If you really need access to the bytes as they were

returned, use Response.raw.

3.3.7 Custom Headers

If you’d like to add HTTP headers to a request, simply pass in a dict to the headers parameter.

For example, we didn’t specify our user-agent in the previous example:

>>> url = 'https://api.github.com/some/endpoint'

>>> headers = {'user-agent': 'my-app/0.0.1'}

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

Note: Custom headers are given less precedence than more speciﬁc sources of information. For instance:

• Authorization headers set with headers= will be overridden if credentials are speciﬁed in .netrc, which in

turn will be overridden by the auth= parameter.

• Authorization headers will be removed if you get redirected off-host.

• Proxy-Authorization headers will be overridden by proxy credentials provided in the URL.

• Content-Length headers will be overridden when we can determine the length of the content.

Furthermore, Requests does not change its behavior at all based on which custom headers are speciﬁed. The headers

are simply passed on into the ﬁnal request.

Note: All header values must be a string, bytestring, or unicode. While permitted, it’s advised to avoid passing

unicode header values.

3.3.8 More complicated POST requests

Typically, you want to send some form-encoded data — much like an HTML form. To do this, simply pass a dictionary

to the data argument. Your dictionary of data will automatically be form-encoded when the request is made:

14 Chapter 3. The User Guide

剩余122页未读，继续阅读

weixin_41598879

粉丝: 0
资源: 1

Requests：Python HTTP 请求库指南

requests 库中文文档电子书

REQUESTS库文档

python requests官方中文文档（ 高级用法 Requests 2.18.1 文档 ）

python requests 文档总结

requests中文文档

requests 中文文档

Requests 2.18.1 文档.pdf

Requests 2.9.1 API文档

requests模块文档

requests 的官方文档链接

最新资源

python requests官方中文文档（高级用法 Requests 2.18.1 文档）