快速启动¶

渴望开始？本页介绍如何开始处理请求。

首先，确保：

请求是 installed
请求是 up-to-date

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

提出请求¶

通过请求发出请求非常简单。

首先导入请求模块：：

>>> import requests

现在，让我们尝试获取一个网页。对于这个例子，让我们获取Github的公共时间线：

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

现在，我们有一个 Response 对象调用 r . 我们可以从这个对象中获得我们需要的所有信息。

请求的简单API意味着所有形式的HTTP请求都是显而易见的。例如，这是您发出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')

这一切都很好，但这也只是请求可以做什么的开始。

在URL中传递参数¶

You often want to send some sort of data in the URL's query string. 如果您是手工构造URL，那么这些数据将在URL中问号后作为键/值对给出，例如。 httpbin.org/get?key=val . 请求允许您使用 params 关键字参数。举个例子，如果你想通过 key1=value1 和 key2=value2 到 httpbin.org/get ，您将使用以下代码：：

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

您可以通过打印URL看到该URL已正确编码：：

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

注意任何值为 None 不会添加到URL的查询字符串中。

还可以将项列表作为值传递：

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

>>> r = requests.get('https://httpbin.org/get', params=payload)
>>> print(r.url)
https://httpbin.org/get?key1=value1&key2=value2&key2=value3

响应内容¶

我们可以读取服务器响应的内容。再次考虑Github时间表：

>>> import requests

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

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

当您发出请求时，请求根据HTTP头对响应的编码进行有根据的猜测。访问时使用请求猜测的文本编码 r.text . 您可以找到正在使用的编码请求，并使用 r.encoding 属性：

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

如果更改编码，请求将使用 r.encoding 无论你什么时候调用 r.text . 您可能希望在任何情况下都这样做，在这种情况下，您可以应用特殊的逻辑来计算出内容的编码是什么。例如，HTML和XML能够在其主体中指定其编码。在这种情况下，您应该使用 r.content 找到编码，然后设置 r.encoding . 这会让你用 r.text 使用正确的编码。

请求还将在需要时使用自定义编码。如果您创建了自己的编码并在 codecs 模块中，只需使用编解码器名称作为 r.encoding 请求将为您处理解码。

二进制响应内容¶

对于非文本请求，您还可以字节形式访问响应正文：

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

这个 gzip 和 deflate 传输编码会自动为您解码。

这个 br 如果Brotli库像这样，传输编码会自动解码 brotli 或 brotlicffi 已安装。

例如，要从请求返回的二进制数据创建图像，可以使用以下代码：

>>> from PIL import Image
>>> from io import BytesIO

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

JSON响应内容¶

还有一个内置的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，则尝试 r.json() 加薪 requests.exceptions.JSONDecodeError 。该包装器异常为不同的Python版本和JSON序列化库可能引发的多个异常提供了互操作性。

应该注意的是，呼叫成功 r.json() 做 not 表示响应成功。有些服务器可能会在失败的响应中返回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
<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 .

自定义标题¶

如果要向请求添加HTTP头，只需传入 dict 到 headers 参数。

例如，在前面的示例中，我们没有指定用户代理：

>>> url = 'https://api.github.com/some/endpoint'
>>> headers = {'user-agent': 'my-app/0.0.1'}

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

注意：与更具体的信息源相比，自定义头的优先级更低。例如：

授权头设置为 headers= 中指定凭据，则将被重写 .netrc ，而该属性又将被 auth= 参数。请求将在以下位置搜索netrc文件 ~/.netrc ， ~/_netrc ，或位于 NETRC 环境变量。
如果从主机上重定向，将删除授权头。
代理授权头将被URL中提供的代理凭据覆盖。
当我们可以确定内容的长度时，内容长度标题将被重写。

此外，请求根本不会根据指定的自定义头更改其行为。这些头只是简单地传递到最终请求中。

注意：所有标题值必须是 string ，bytestring或unicode。在允许的情况下，建议避免传递unicode头值。

更复杂的POST请求¶

通常，您希望发送一些表单编码的数据——很像HTML表单。为此，只需将字典传递给 data 参数。发出请求时，您的数据字典将自动进行格式编码：：

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

>>> r = requests.post('https://httpbin.org/post', data=payload)
>>> print(r.text)
{
  ...
  "form": {
    "key2": "value2",
    "key1": "value1"
  },
  ...
}

这个 data 参数也可以为每个键具有多个值。这可以通过 data 以列表为值的元组列表或字典。当表单中有多个元素使用同一个键时，这尤其有用：

>>> payload_tuples = [('key1', 'value1'), ('key1', 'value2')]
>>> r1 = requests.post('https://httpbin.org/post', data=payload_tuples)
>>> payload_dict = {'key1': ['value1', 'value2']}
>>> r2 = requests.post('https://httpbin.org/post', data=payload_dict)
>>> print(r1.text)
{
  ...
  "form": {
    "key1": [
      "value1",
      "value2"
    ]
  },
  ...
}
>>> r1.text == r2.text
True

有时您可能希望发送非表单编码的数据。如果你通过 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))

请注意，上面的代码不会添加 Content-Type 标头(因此它特别不会将其设置为 application/json )。

如果您需要该标头集，并且不想对 dict ，您也可以直接使用 json 参数(2.4.2版新增)，自动编码：

>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}

>>> r = requests.post(url, json=payload)

注意， json 参数被忽略，如果 data 或 files 通过。

发布多部分编码文件¶

请求使上载多部分编码文件变得简单：

>>> url = 'https://httpbin.org/post'
>>> files = {'file': open('report.xls', 'rb')}

>>> r = requests.post(url, files=files)
>>> r.text
{
  ...
  "files": {
    "file": "<censored...binary...data>"
  },
  ...
}

可以显式设置文件名、内容类型和头：

>>> url = 'https://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 = 'https://httpbin.org/post'
>>> files = {'file': ('report.csv', 'some,data,to,send\nanother,row,to,send\n')}

>>> 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 . 你应该阅读 the toolbelt's documentation 有关如何使用它的详细信息。

要在一个请求中发送多个文件，请参阅 advanced 部分。

警告

强烈建议您在 binary mode . 这是因为请求可能试图提供 Content-Length 头，如果它这样做，这个值将被设置为 bytes 在文件中。如果在中打开文件，可能会发生错误。文本模式.

响应状态代码¶

我们可以检查响应状态代码：

>>> r = requests.get('https://httpbin.org/get')
>>> r.status_code
200

请求还附带一个内置的状态代码查找对象，以便于参考：

>>> r.status_code == requests.codes.ok
True

如果我们提出了一个错误的请求（4xx客户机错误或5xx服务器错误响应），我们可以使用 Response.raise_for_status() ：：

>>> bad_r = requests.get('https://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

但是，自从我们 status_code 对于 r 是 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 7230 ，HTTP头名称不区分大小写。

因此，我们可以使用所需的任何大小写访问标题：

>>> r.headers['Content-Type']
'application/json'

>>> r.headers.get('content-type')
'application/json'

服务器可以多次发送具有不同值的同一头文件，这一点也很特殊，但是请求将它们组合在一起，以便在一个映射中用字典表示，如 RFC 7230 ：

收件人可以将具有相同字段名的多个头字段组合成一对“字段名：字段值”，而不更改消息的语义，方法是将每个后续字段值依次附加到组合字段值上，用逗号分隔。

Cookies¶

如果响应包含一些cookie，您可以快速访问它们：

>>> url = 'http://example.com/some/cookie/setting/url'
>>> r = requests.get(url)

>>> r.cookies['example_cookie_name']
'example_cookie_value'

要将自己的cookie发送到服务器，可以使用 cookies 参数：：

>>> url = 'https://httpbin.org/cookies'
>>> cookies = dict(cookies_are='working')

>>> r = requests.get(url, cookies=cookies)
>>> r.text
'{"cookies": {"cookies_are": "working"}}'

cookies将在 RequestsCookieJar 就像一个 dict 但也提供了一个更完整的接口，适合在多个域或路径上使用。也可以将cookie jar传递到请求：

>>> jar = requests.cookies.RequestsCookieJar()
>>> jar.set('tasty_cookie', 'yum', domain='httpbin.org', path='/cookies')
>>> jar.set('gross_cookie', 'blech', domain='httpbin.org', path='/elsewhere')
>>> url = 'https://httpbin.org/cookies'
>>> r = requests.get(url, cookies=jar)
>>> r.text
'{"cookies": {"tasty_cookie": "yum"}}'

重定向和历史记录¶

默认情况下，请求将为除head以外的所有谓词执行位置重定向。

我们可以使用 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]>]

超时¶

您可以告诉请求在给定的秒数后停止等待响应 timeout 参数。几乎所有的生产代码都应该在几乎所有的请求中使用这个参数。不这样做会导致程序无限期挂起：

>>> requests.get('https://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故障、拒绝连接等），请求将引发 ConnectionError 例外。

Response.raise_for_status() 将提高 HTTPError 如果HTTP请求返回不成功的状态代码。

如果请求超时，则 Timeout 引发异常。

如果请求超过配置的最大重定向次数，则 TooManyRedirects 引发异常。

请求显式引发的所有异常都继承自 requests.exceptions.RequestException .

准备好了吗？退房 advanced 部分。