python requests快速入門介紹

這篇文章主要介紹了python requests 使用快速入門教程,使用Requests 發送網絡請求非常簡單，具體操作方法，大家參考下本文吧

##快速上手

迫不及待了嗎？本頁內容為如何入門 Requests 提供了很好的指引。其假設你已經安裝了 Requests。如果還沒有，就去安裝一節看看吧。

首先，確認一下：

Requests已安裝

Requests 是最新的

讓我們從一些簡單的範例開始。

發送請求

使用 Requests 發送網路請求非常簡單。

一開始要匯入 Requests 模組：

>>> import requests

然後，試著取得某個網頁。在本範例中，我們來取得 Github 的公共時間線：

>>> r = requests.get('https://github.com/timeline.json')

現在，我們有一個名為 r 的 Response 物件。我們可以從這個物件中獲取所有我們想要的資訊。

Requests 簡單的 API 意味著所有 HTTP 請求類型都是顯而易見的。例如，你可以這樣傳送 HTTP POST 請求：

>>> r = requests.post(http://httpbin.org/post)

漂亮，對吧？那麼其他 HTTP 請求類型：PUT，DELETE，HEAD 以及 OPTIONS 又是如何的呢？都是一樣的簡單：

>>> r = requests.put("http://httpbin.org/put")
>>> 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://github.com/timeline.json')
>>> 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://github.com/timeline.json')
>>> 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://github.com/timeline.json', stream=True)
>>> r.raw
<requests.packages.urllib3.response.HTTPResponse object at 0x101194810>
>>> r.raw.read(10)
&#39;\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03&#39;

但一般情况下，你应该以下面的模式将文本流保存到文件：

with open(filename, 'wb') as fd:
 for chunk in r.iter_content(chunk_size):
  fd.write(chunk)

使用 Response.iter_content 将会处理大量你直接使用 Response.raw 不得不处理的。 当流下载时，上面是优先推荐的获取内容方式。 Note that chunk_size can be freely adjusted to a number that may better fit your use cases.

定制请求头

如果你想为请求添加 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": "29a1523db4da14c32d48e307909783a5"
  },
  ...
}

你可以显式地设置文件名，文件类型和请求头：

>>> 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": "29a1523db4da14c32d48e307909783a5 "
  },
  ...
}

如果你想，你也可以傳送作為文件來接收的字串：

>>> url = 'http://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 是支援的。你可以閱讀 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
>>>；
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',
    'server': 'nginx/1.0.4',
    'x-runtime': '148ms',
    'x-runtime': '148ms',
    'etag': '"e1ca502697e5c9317743dc078f67693f"',
  #  'content-type':#dli/1son這個字典比較特殊：它是僅為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" 配對，將每個後續的欄位值依序追加到合併的欄位值中，用逗號隔開即可，這樣做不會改變訊息的語意。

Cookie

如果某個回應中包含一些 cookie，你可以快速存取它們：

>>> url = 'http://example.com/some/cookie/setting/url'
>>> r = requests.get(url)
>>> r.cookies['example_cookie_name']
'example_cookie_value'
要想发送你的cookies到服务器，可以使用 cookies 参数：

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

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

Cookie 的返回对象为 RequestsCookieJar，它的行为和字典类似，但界面更为完整，适合跨域名跨路径使用。你还可以把 Cookie Jar 传到 Requests 中：

>>> 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 = 'http://httpbin.org/cookies'
>>> r = requests.get(url, cookies=jar)
>>> r.text
'{"cookies": {"tasty_cookie": "yum"}}'

重定向与请求历史

默认情况下，除了 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=&#39;github.com&#39;, port=80): Request timed out. (timeout=0.001)

注意

timeout 仅对连接过程有效，与响应体的下载无关。 timeout 并不是整个下载响应的时间限制，而是如果服务器在 timeout 秒内没有应答，将会引发一个异常（更精确地说，是在timeout 秒内没有从基础套接字上接收到任何字节的数据时）If no timeout is specified explicitly, requests do not time out.

错误与异常

遇到网络问题（如：DNS 查询失败、拒绝连接等）时，Requests 会抛出一个 ConnectionError 异常。

如果 HTTP 请求返回了不成功的状态码， Response.raise_for_status() 会抛出一个 HTTPError 异常。

若请求超时，则抛出一个 Timeout 异常。

若请求超过了设定的最大重定向次数，则会抛出一个 TooManyRedirects 异常。

所有Requests显式抛出的异常都继承自 requests.exceptions.RequestException 。

以上是python requests快速入門介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！