Python Requests文檔閱讀筆記
學習庫還是得從文檔下手,Python Requests Library
以下內容均摘錄總結於該文檔,所以具體部分可以參考文檔。
快速上手
- 使用前別忘記導入
Requests
模塊
import requests
發送請求
本部分即告知你本庫能夠完成各種HTTP請求類型,畢。
此處涉及HTTP協議的一些知識,我走馬觀花式搜索了一些資料,大致瞭解一下,瞭解一下
GET
和POST
,搜索引擎能找到資料很多,比如HTTP協議詳解Requests
庫能夠實現各種HTTP請求類型,如下:
r = requests.get('https://github.com/timeline.json')
r = requests.post("http://httpbin.org/post")
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")
傳遞URL參數
首先說一下
URL
的查詢字符串的含義,查詢字符串置於地址後,以?
分隔,例如httpbin.org/get?key = val
,?
後便是查詢字符串,可以這麼理解它:比如說該位置是用來獲取資源的,但是我們如果想對資源有選擇的獲取,那麼緊跟後的查詢字符串就是限制條件,我們獲取key
值爲val
的資源。Requests
庫允許你使用param
關鍵字參數,以一個字符串字典來提供這些參數,舉例來說,如果你想傳遞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
- 字典裏
value
爲None的不會被添加到其中,另外你還可以將一個列表作爲值傳入:
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
響應內容
- 通過
GET
方法我們可以讀取服務器相應的內容,如
import requests
r = requests.get('https://github.com/timeline.json')
r.text
u'[{"repository":{"open_issues":0,"url":"https://github.com/...
Requests
會自動解碼來自服務器的內容,但你使用r.text
後,它會使用其推測的文本編碼,你可以找出他的編碼,並能夠使用r.encoding =
來改變:
r.encoding
'utf-8'
r.encoding = 'ISO-8859-1'
二進制相應內容\JSON響應內容\原始相應內容
- 以字節(二進制)的方式請求響應體,
r.content
- JSON相應內容,
r.json()
- 原始響應內容,
r.raw
,並且在get方法中設置了stream = True
,如
r = requests.get('https://github.com/timeline.json', stream=True)
r.raw
r.raw.read(10)
'\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03'
定製請求頭
- 如果你想爲請求添加
HTTP
頭部,只要簡單地傳遞一個dict
給headers
參數就可以了。
url = 'https://api.github.com/some/endpoint'
h = {'user-agent':'my-app/0.0.1'}
r = requests.get(url,headers = h)
更加複雜的POST請求
- 如果你想要發送一些編碼爲表單形式的數據——非常像一個HTML表單。要實現這個,只需簡單地傳遞一個字典給
data
參數,你的數據字典在發出請求時會自動編碼爲表單形式:
payload = {'key1':value,'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"
]
},
...
}
- 也可以用
json
參數直接傳遞,然後它就會被自動編碼
url = 'https://api.github.com/some/endpoint'
payload = {'some': 'data'}
r = requests.post(url, json=payload)
響應頭
- 我們可以查看以一個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頭部而生的,因此是大小寫不敏感的,在python中這部分也變得不敏感了,因此我們可以使用任意大小寫形式來訪問這些響應頭字段:
r.headers['Content-Type']
'application/json'
r.headers.get('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'
- 要想發送你的
cookie
到服務器,可以使用cookie
參數:
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
對象的列表,爲了完成請求而創建了這些對象。這個對象列表按照從最老到最近的請求進行排序。
r = requests.get('http://github.com')
r.url
'https://github.com/'
r.status_code
200
r.history
[<Response [301]>]
- 如果你使用了
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='github.com', port=80): Request timed out. (timeout=0.001)
timeout
僅對連接過程有效,與響應體的下載無關,timeout
並不是整個下載相應的時間限制,而是如果服務器在timeout
秒內沒有應答,將會引發一個異常。
錯誤與異常
- 遇到網絡問題(DNS查詢失敗等),Requests會拋出一個
ConnectionError
異常。 - 如果HTTP請求返回了不成功的狀態碼,
Response.raise_for_status()
會拋出一個HTTPError
異常。 - 如果請求超時,則會拋出一個
Timeout
異常。 - 如果請求超過了設定最大重定向次數,則會拋出一個
TooManyRedirects
異常。