快速上手
迫不及待了嗎？本頁內容為如何入門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 u'http://httpbin.org/get?key2=value2&key1=value1'
響應內容
我們能讀取服務器響應的內容。再次以Github時間線為例:
>>> import requests >>> r = requests.get('https://github.com/timeline.json') >>> r.text '[{"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 的新值。
在你需要的情況下，Requests也可以使用定制的編碼。如果你創建了自己的編碼，並使用codecs 模塊進行注冊，你就可以輕松地使用這個解碼器名稱作為 r.encoding 的值， 然后由Requests來為你處理編碼。
二進制響應內容
你也能以字節的方式訪問請求響應體，對於非文本請求:
>>> r.content b'[{"repository":{"open_issues":0,"url":"https://github.com/...
Requests會自動為你解碼 gzip 和 deflate 傳輸編碼的響應數據。
例如，以請求返回的二進制數據創建一張圖片，你可以使用如下代碼:
>>> from PIL import Image >>> from StringIO import StringIO >>> i = Image.open(StringIO(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 就會拋出一個異常。
原始響應內容
在罕見的情況下你可能想獲取來自服務器的原始套接字響應，那么你可以訪問 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) '\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03'
定制請求頭
如果你想為請求添加HTTP頭部，只要簡單地傳遞一個 dict 給 headers 參數就可以了。
例如，在前一個示例中我們沒有指定content-type:
>>> import json >>> url = 'https://api.github.com/some/endpoint' >>> payload = {'some': 'data'} >>> headers = {'content-type': 'application/json'} >>> r = requests.post(url, data=json.dumps(payload), headers=headers)
更加復雜的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" }, ... }
很多時候你想要發送的數據並非編碼為表單形式的。如果你傳遞一個 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))
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'))} >>> 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
如果發送了一個失敗請求(非200響應)，我們可以通過 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 { 'status': '200 OK', 'content-encoding': 'gzip', 'transfer-encoding': 'chunked', 'connection': 'close', 'server': 'nginx/1.0.4', 'x-runtime': '148ms', 'etag': '"e1ca502697e5c9317743dc078f67693f"', 'content-type': 'application/json; charset=utf-8' }
但是這個字典比較特殊：它是僅為HTTP頭部而生的。根據 RFC 2616 ， HTTP頭部是大小寫不敏感的。
因此，我們可以使用任意大寫形式來訪問這些響應頭字段:
>>> r.headers['Content-Type'] 'application/json; charset=utf-8' >>> r.headers.get('content-type') 'application/json; charset=utf-8'
如果某個響應頭字段不存在，那么它的默認值為 None
>>> r.headers['X-Random'] None
重定向與請求歷史
使用GET或OPTIONS時，Requests會自動處理位置重定向。
Github將所有的HTTP請求重定向到HTTPS。可以使用響應對象的 history 方法來追蹤重定向。 我們來看看Github做了什么:
>>> r = requests.get('http://github.com') >>> r.url 'https://github.com/' >>> r.status_code 200 >>> r.history [<Response [301]>]
Response.history 是一個:class:Request 對象的列表，為了完成請求而創建了這些對象。這個對象列表按照從最老到最近的請求進行排序。
如果你使用的是GET或OPTIONS，那么你可以通過 allow_redirects 參數禁用重定向處理:
>>> r = requests.get('http://github.com', allow_redirects=False) >>> r.status_code 301 >>> r.history []
如果你使用的是POST，PUT，PATCH，DELETE或HEAD，你也可以啟用重定向:
>>> r = requests.post('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='github.com', port=80): Request timed out. (timeout=0.001)
注:
timeout 僅對連接過程有效，與響應體的下載無關。