python使用requests.post方式send文件及參數的注意事項

大家在使用requests的post 方法提交數據時, 經常使用的方法如下:

1. 提交python字典格式的數據

>>> payload = {'key1': 'value1', 'key2': 'value2'}
>>> r = requests.post("http://httpbin.org/post", data=payload)

2. 提交Json格式數據

>>> import json
>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}
>>> r = requests.post(url, data=json.dumps(payload))

或者

>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}
>>> r = requests.post(url, json=payload)

3. 提交文件

>>> url = 'http://httpbin.org/post'
>>> files = {'file': open('report.xls', 'rb')}
>>> r = requests.post(url, files=files)

但如果遇到既需要提交文件又需要提交某些參數, 那麼一定會有人遇到這個坑:

>>> url = 'http://httpbin.org/post'
>>> files = {'file': ('report.csv', 'some,data,to,send\nanother,row,to,send\n')}
>>> payload = {'some': 'data'}
>>> r = requests.post(url, files=files, json=payload)

這樣操作看似沒有問題, 也可以正常提交. 但是實際json參數並沒有起作用, 在官網中有這樣一句話, 如果大家不注意可能發現不了: Note, the json parameter is ignored if either data or files is passed.(如果提交參數中使用data或files, 那麼json參數將被忽略)

那麼正確的操作是:

# files + dict參數提交方式
>>> url = 'http://httpbin.org/post'
>>> files = {'file': ('report.csv', 'some,data,to,send\nanother,row,to,send\n')}
>>> payload = {'some': 'data'}
>>> r = requests.post(url, files=files, data=payload)

print '---------------------------我是方法分割線---------------------------------'

# files + json參數提交方式
import json
>>> url = 'http://httpbin.org/post'
>>> files = {'file': ('report.csv', 'some,data,to,send\nanother,row,to,send\n')}
>>> payload = {'some': 'data'}
>>> r = requests.post(url, files=files, data=json.dumps(payload))

參考官方文檔

http://docs.python-requests.org/en/latest/user/quickstart/#post-a-multipart-encoded-file