3、requests之不同型別的傳參

2020-11-13 12:00:44

上一篇,我們介紹了幾種種帶引數的請求型別劃分。這篇,通過github上的API,來一個個的引數介面的演示。
1、不帶引數的get請求

# 匯入requests包
import requests 

# 1. 組裝請求
url = "https://api.github.com"  # 這裡只有url,字串格式
# 2. 傳送請求,獲取響應
res = requests.get(url) # res即返回的響應物件
# 3. 解析響應
print(res.json)  # 輸出響應的文字

res.json()方法實際上是使用了json.loads(res.text)將響應文字嘗試以JSON格式轉為字典。由於該方法存在異常(比如正常情況下返回JSON格式,500報錯時則會返回非JSON格式的報錯資訊),建議使用try…except處理,修改如下。

import requests
url = 'https://api.github.com'
url_params = {'name': '浩浩', 'age': '18'}
res = requests.get(url, params=url_params)
try:
    print('響應文字轉為字典', res.json())
except:
    print('響應文字', res.text)

2、帶引數的get請求

import requests 

url = "https://api.github.com/openapi/api?key=ec961279f453459b9248f0aeb6600bbe&info=你好"  # 引數可以寫到url裡
res = requests.get(url=url) # 第一個url指get方法的引數,第二個url指上一行我們定義的介面地址
print(res.text)  

URL只支援ASCII(美國標準碼),在實際的傳輸過程中,中文及一些特殊字元需要經過urlencode(URL編碼)。如上例中的介面地址會被編碼成:
https://api.github.com/get?name=%E4%B8%B4%E6%B8%8A&age=18

或者這樣寫`

import requests 

url = "https://api.github.com/openapi/api"
params = {"key":"ec961279f453459b9248f0aeb6600bbe","info":"你好"} # 字典格式,單獨提出來,方便引數的新增修改等操作
res = requests.get(url=url, params=params) 
print(res.text)  

需要注意的是,requests.get()方法中,引數params後面跟著是一個字典,requests會自動幫我們把這個引數拼接在介面請求地址中
3、傳統表單類POST請求(x-www-form-urlencoded)

import requests 

url = "https://api.github.com"
data = {"name": "浩浩", "age": 18} # Post請求傳送的資料,字典格式
res = requests.post(url=url, data=data) # 這裡使用post方法,引數和get方法一樣
print(res.text)  

4、JSON型別的POST請求(application/json)

import requests 

url = "https://api.github.com"
data = '''{
        "name": "浩浩",
        "age": 18
        }''' # 多行文字, 字串格式,也可以單行(注意外層有引號,為字串) data = '{"name": "浩浩", "age": 18}'
res = requests.post(url=url, data=data) #  data支援字典或字串
print(res.text)  

data引數支援字典格式也支援字串格式,如果是字典格式,requests方法會將其按照預設表單urlencoded格式轉換為字串,如果是字串則不轉化
如果data以字串格式傳輸需要遵循以下幾點:

必須是嚴格的JSON格式字串,裡面必須用雙引號,k-v之間必須有逗號,布林值必須是小寫的true/false等等
不能有中文,直接傳字串不會自動編碼
一般來說,建議將data宣告為字典格式(方便資料新增修改),然後再用json.dumps()方法把data轉換為合法的JSON字串格式

import requests 
import json # 使用到JSON中的方法,需要提前匯入

url = "https://api.github.com"
data = {
        "name": "浩浩",
        "age": 18
        }  # 字典格式,方便新增
headers = {"Content-Type":"application/json"} # 嚴格來說,我們需要在請求頭裡宣告我們傳送的格式
res = requests.post(url=url, data=json.dumps(data), headers=headers) #  將字典格式的data變數轉換為合法的JSON字串傳給post的data引數
print(res.text)  

或直接將字典格式的data資料賦給post方法的JSON引數(會自動將字典格式轉為合法的JSON文字並新增headers)

import requests 

url = "https://api.github.com/openapi/api/v2"
data = {
	"reqType":0,
    "perception": {
        "inputText": {
            "text": "哈哈哈"
        },
        "inputImage": {
            "url": "imageUrl"
        },
        "selfInfo": {
            "location": {
                "city": "北京",
                "province": "北京",
                "street": "古城南街"
            }
        }
    },
    "userInfo": {
        "apiKey": "ec961279f453459b9248f0aeb6600bbe",
        "userId": "206379"
    }
} 
res = requests.post(url=url, json=data) # JSON格式的請求,將資料賦給json引數
print(res.text)  

5、傳送XML格式的資料
上例提到XML和JSON都屬於Raw格式的資料,XML和JSON在Python中實際都是不同格式的文字字串。我們將字串傳遞給請求方法的data引數即可原樣傳送,即data引數有以下3重作用:

1)data = {} 或 [(,), (,)]:接受一個字典或巢狀列表格式的資料,會按表單Url編碼格式
2)data = ‘’:接受一個字串或bytes二進位制字串,會原樣傳送(需要手動新增請求頭,如果存在中文需要手動編碼)
3)data = open(’…’, ‘rb’):接受一個檔案物件,按binary格式流式上傳。
傳送XML格式的資料只要將XML格式的多行字串傳遞給請求方法的data引數即可,範例如下。

import requests
url = 'https://api.github.com/post'
xml_data = '''
<xml>
    <name>浩浩</name>
    <age>18</name>
</xml>
'''
headers = {'Content-Type': 'application/xml'}

res = requests.post(url, data=xml_data.encode('utf-8'), headers=headers)
print(res.text)

由於xml_data資料中存在非ASCII碼,需要將資料按utf-8格式編碼為bytes二進位制字串傳送。由於使用Raw格式傳送資料時不會自動新增請求頭,因此一般要手動在請求頭中新增內容型別宣告,並將構造的字典型別的請求頭變數,傳遞給請求方法的關鍵字引數headers。
6、傳送Multipart/form-data請求(檔案上傳)
網頁上的表單有兩種,一種是不包含檔案上傳,所有使用者輸入或選擇的資料都可以使用字串格式表示,這種稱為普通表單或純文字表單,對應MIME型別為application/x-www-form-urlencoded。

另一種即包括普通輸入框等,也包含一個或多個檔案上傳框。普通輸入框中的變數值可以已字串格式編碼,而上傳的檔案(如圖片檔案)則不一定能直接轉為字串,要使用二進位制格式。因此要使用多部分的混合格式,筆者稱之為混合表單,對應MIME型別為multipart/form-data。在表單中,每個需要上傳的檔案和普通輸入框一樣對應一個指定的變數。因此同樣可以使用字典格式組裝混合表單的請求資料傳遞給請求方法的files引數即可,範例如下。

import requests
url = 'https://api.github.com/post'
multi_form_data = {
    'name': '浩浩',
    'age': '18',  # 不能使用int型別
    'avatar': open('/Users/apple/Pictures/robot.png', 'rb'),
    'avatar2': open('/Users/apple/Pictures/robot.jpg', 'rb'),
}

res = requests.post(url, files=multi_form_data)
print(res.text)

表單資料中的數位要使用字串格式的數位,檔案要以rb二進位制格式開啟傳輸,支援多個變數以及多個檔案。

檔案型別的資料avatar可以只穿一個開啟的檔案物件open(’/Users/apple/Pictures/robot.png’, ‘rb’),也可以傳遞三個引數:要儲存的檔名,開啟的檔案及檔案MIME型別,即

‘avatar’: (‘robot.png’, open(’/Users/apple/Pictures/robot.png’, ‘rb’), ‘image/png’),

比如有些介面上傳Excel檔案時必須宣告檔名和MIME型別,如:

res = request.post(url, files={'upload_file': 
        ('data.xlsx', 
        open('data.xlsx', 'rb'),
        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
    })

7、傳送Binary格式資料(單檔案/流式上傳)

import requests
url = 'https://api.github.com/post'

res = requests.post(url, data=open('/Users/apple/Pictures/robot.jpg', 'rb'))
print(res.text)

這種很少見,瞭解一下就行。

有什麼不明白的可以私我加vx:18547673653 或者qq:1270059901