Python的Request函式用法
目錄
POST一個多部分編碼(Multipart-Encoded)的檔案
傳送請求
匯入 Requests 模組:
然後,嘗試獲取某個網頁。
import requests
r = requests.get('https://www.csdn.net/')
r
是 Response
物件。我們可以從這個物件中獲取所有我們想要的資訊。
POST 請求:
>>> r = requests.post('https://www.csdn.net/', data = {'key':'value'})
其他請求:
>>> r = requests.put('https://www.csdn.net/', data = {'key':'value'}) >>> r = requests.delete('https://www.csdn.net/') >>> r = requests.head('https://www.csdn.net/') >>> r = requests.options('https://www.csdn.net/')
傳遞 URL 引數
如果 URL 的查詢字串(query string)需要傳遞某種資料。如果你是手工構建 URL,那麼資料會以鍵/值對的形式置於 URL 中,跟在一個問號的後面。例如, httpbin.org/get?key=val
。 Requests 允許你使用 params
關鍵字引數,以一個字串字典來提供這些引數。
>>> payload = {'key1': 'value1', 'key2': 'value2'} >>> r = requests.get("http://*/*", params=payload) >>> print(r.url)
還可以將一個列表作為值傳入:
>>> payload = {'key1': 'value1', 'key2': ['value2', 'value3']}
>>> r = requests.get('http://*/*', params=payload)
>>> print(r.url)
響應內容
Requests 會自動解碼來自伺服器的內容。大多數 unicode 字符集都能被無縫地解碼。
請求發出後,Requests 會基於 HTTP 頭部對響應的編碼作出有根據的推測。當你訪問 r.text
之時,Requests 會使用其推測的文字編碼。你可以找出 Requests 使用了什麼編碼,並且能夠使用 r.encoding
屬性來改變它:
>>> r.encoding
'utf-8'
>>> r.encoding = 'ISO-8859-1'
如果你改變了編碼,每當你訪問 r.text
,Request 都將會使用 r.encoding
的新值。
二進位制響應內容
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()
如果 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)
'\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03'
定製請求頭
>>> url = 'https://api.github.com/some/endpoint'
>>> headers = {'user-agent': 'my-app/0.0.1'}
>>> r = requests.get(url, headers=headers)
更加複雜的 POST 請求
>>> 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": "<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\nanother,row,to,send\n')}
>>> r = requests.post(url, files=files)
>>> r.text
{
...
"files": {
"file": "some,data,to,send\\nanother,row,to,send\\n"
},
...
}
響應狀態碼
我們可以檢測響應狀態碼:
>>> 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'
}
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"}}'
重定向與請求歷史
預設情況下,除了 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]>]