files
Этот параметр необходимо использовать для отправки POST-запроса из нескольких частей, даже если вам не нужно загружать какие-либо файлы.
Из исходного источника запросов :
def request(method, url, **kwargs):
"""Constructs and sends a :class:`Request <Request>`.
...
:param files: (optional) Dictionary of ``'name': file-like-objects``
(or ``{'name': file-tuple}``) for multipart encoding upload.
``file-tuple`` can be a 2-tuple ``('filename', fileobj)``,
3-tuple ``('filename', fileobj, 'content_type')``
or a 4-tuple ``('filename', fileobj, 'content_type', custom_headers)``,
where ``'content-type'`` is a string
defining the content type of the given file
and ``custom_headers`` a dict-like object
containing additional headers to add for the file.
Соответствующая часть: file-tuple can be a
2-tuple
, .3-tuple
or a
4-tuple
Исходя из вышеизложенного, простейший многочастный запрос формы, который включает в себя как файлы для загрузки, так и поля формы, будет выглядеть следующим образом:
multipart_form_data = {
'file2': ('custom_file_name.zip', open('myfile.zip', 'rb')),
'action': (None, 'store'),
'path': (None, '/path1')
}
response = requests.post('https://httpbin.org/post', files=multipart_form_data)
print(response.content)
☝ Обратите внимание на None
первый аргумент в кортеже для текстовых полей - это заполнитель для поля имени файла, которое используется только для загрузки файлов, но для текстовых полей, передаваемых None
в качестве первого параметра, требуется для представления данных ,
Несколько полей с одинаковым именем
Если вам нужно опубликовать несколько полей с одним и тем же именем, тогда вместо словаря вы можете определить свою полезную нагрузку в виде списка (или кортежа) кортежей:
multipart_form_data = (
('file2', ('custom_file_name.zip', open('myfile.zip', 'rb'))),
('action', (None, 'store')),
('path', (None, '/path1')),
('path', (None, '/path2')),
('path', (None, '/path3')),
)
API потоковых запросов
Если приведенный выше API не является достаточно питоническим для вас, рассмотрите возможность использования инструментального средства запросов ( pip install requests_toolbelt
), которое является расширением модуля основных запросов, который обеспечивает поддержку потоковой передачи файлов, а также MultipartEncoder, который можно использовать вместо files
, и который также позволяет Вы определяете полезную нагрузку как словарь, кортеж или список.
MultipartEncoder
может использоваться как для составных запросов с фактическими полями загрузки, так и без них. Он должен быть назначен data
параметру.
import requests
from requests_toolbelt.multipart.encoder import MultipartEncoder
multipart_data = MultipartEncoder(
fields={
# a file upload field
'file': ('file.zip', open('file.zip', 'rb'), 'text/plain')
# plain text fields
'field0': 'value0',
'field1': 'value1',
}
)
response = requests.post('http://httpbin.org/post', data=multipart_data,
headers={'Content-Type': multipart_data.content_type})
Если вам нужно отправить несколько полей с одним и тем же именем или если важен порядок полей формы, то вместо словаря можно использовать кортеж или список:
multipart_data = MultipartEncoder(
fields=(
('action', 'ingest'),
('item', 'spam'),
('item', 'sausage'),
('item', 'eggs'),
)
)