python 之 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(" 
>>> r = requests.delete(" 
>>> r = requests.head(" 
>>> 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.urlu'http://httpbin.org/get?key2=value2&key1=value1'

響應內容

咱們能讀取服務器響應的內容。再次以Github時間線爲例:

>>> import requests
>>> r = requests.get(' 
>>> 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.contentb'[{"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(' 
>>> 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 = ' 
>>> 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 = ' 
>>> payload = {'some': 'data'}
>>> r = requests.post(url, data=json.dumps(payload))

POST一個多部分編碼(Multipart-Encoded)的文件

Requests使得上傳多部分編碼文件變得很簡單:

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

你能夠顯式地設置文件名:

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

若是你想，你也能夠發送做爲文件來接收的字符串:

>>> url = ' 
>>> 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(' 
>>> r.status_code200

爲方便引用，Requests還附帶了一個內置的狀態碼查詢對象:

>>> r.status_code == requests.codes.okTrue

若是發送了一個失敗請求(非200響應)，咱們能夠經過 Response.raise_for_status() 來拋出異常:

>>> bad_r = requests.get(' 
>>> bad_r.status_code404>>> bad_r.raise_for_status()Traceback (most recent call last):
  File "requests/models.py", line 832, in raise_for_status
    raise http_errorrequests.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

Cookies

若是某個響應中包含一些Cookie，你能夠快速訪問它們:

>>> url = ' 
>>> r = requests.get(url)
>>> r.cookies['example_cookie_name']'example_cookie_value'

要想發送你的cookies到服務器，可使用 cookies 參數:

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

重定向與請求歷史

使用GET或OPTIONS時，Requests會自動處理位置重定向。

Github將全部的HTTP請求重定向到HTTPS。可使用響應對象的 history 方法來追蹤重定向。 咱們來看看Github作了什麼:

>>> r = requests.get(' 
>>> r.url' 
>>> r.status_code200
>>> r.history[<Response [301]>]

Response.history 是一個:class:Request 對象的列表，爲了完成請求而建立了這些對象。這個對象列表按照從最老到最近的請求進行排序。

若是你使用的是GET或OPTIONS，那麼你能夠經過 allow_redirects 參數禁用重定向處理:

>>> r = requests.get('http://github.com', allow_redirects=False)
>>> r.status_code301>>> 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 僅對鏈接過程有效，與響應體的下載無關。

錯誤與異常

遇到網絡問題（如：DNS查詢失敗、拒絕鏈接等）時，Requests會拋出一個ConnectionError 異常。

遇到罕見的無效HTTP響應時，Requests則會拋出一個 HTTPError 異常。

若請求超時，則拋出一個 Timeout 異常。

若請求超過了設定的最大重定向次數，則會拋出一個 TooManyRedirects 異常。

全部Requests顯式拋出的異常都繼承自 requests.exceptions.RequestException 。