¿Cómo enviar un "multipart/form-data" con solicitudes en python?

Question

¿Cómo enviar un multipart/form-data con solicitudes en python? Cómo entiendo cómo enviar un archivo, pero no puedo entender cómo enviar los datos del formulario mediante este método.

Answer 1

Básicamente, si especifica un parámetro files (un diccionario), entonces requests enviará un POST multipart/form-data en lugar de un POST application/x-www-form-urlencoded. No está limitado a la utilización de los archivos reales en ese diccionario, sin embargo:

>>> import requests 
>>> response = requests.post('http://httpbin.org/post', files=dict(foo='bar')) 
>>> response.status_code 
200 

y httpbin.org le permite saber lo que los ficheros de encabezado informado con; en response.json() tenemos:

>>> from pprint import pprint 
>>> pprint(response.json()['headers']) 
{u'Accept': u'*/*', 
u'Accept-Encoding': u'gzip, deflate, compress', 
u'Connection': u'close', 
u'Content-Length': u'141', 
u'Content-Type': u'multipart/form-data; boundary=33b4531a79be4b278de5f5688fab7701', 
u'Host': u'httpbin.org', 
u'User-Agent': u'python-requests/2.2.1 CPython/2.7.6 Darwin/13.2.0', 
u'X-Request-Id': u'eaf6baf8-fc3d-456b-b17d-e8219ccef1b1'} 

files también puede ser una lista de tuplas de dos valores, si es necesario ordenar y/o múltiples campos con el mismo nombre:

requests.post('http://requestb.in/xucj9exu', files=(('foo', 'bar'), ('spam', 'eggs'))) 

Si especifica files y data, entonces depende del valor de data lo que se usará para crear el cuerpo POST. Si data es una cadena, solo se usará; de lo contrario, se usan data y files, con los elementos en data listados primero.

Answer 2

Como se escribieron las respuestas anteriores, las solicitudes han cambiado. Eche un vistazo a bug thread at Github para más detalles y this comment para un ejemplo.

En resumen, el parámetro de archivos toma dict con la clave que es el nombre del campo de formulario y el valor es una cadena o una tupla de 2, 3 o 4 longitudes, como se describe en la sección POST a Multipart-Encoded File en las solicitudes Inicio rápido:

>>> url = 'http://httpbin.org/post' 
>>> files = {'file': ('report.xls', open('report.xls', 'rb'), 'application/vnd.ms-excel', {'Expires': '0'})} 

en lo anterior, la tupla se compone de la siguiente manera:

(filename, data, content_type, headers) 

Si el valor es sólo una cadena, el nombre del archivo será la misma que la clave, como en el siguiente:

>>> files = {'obvius_session_id': '72c2b6f406cdabd578c5fd7598557c52'} 

Content-Disposition: form-data; name="obvius_session_id"; filename="obvius_session_id" 
Content-Type: application/octet-stream 

72c2b6f406cdabd578c5fd7598557c52 

Si el valor es una tupla y la primera entrada es None la propiedad nombre de archivo no se incluirá:

>>> files = {'obvius_session_id': (None, '72c2b6f406cdabd578c5fd7598557c52')} 

Content-Disposition: form-data; name="obvius_session_id" 
Content-Type: application/octet-stream 

72c2b6f406cdabd578c5fd7598557c52 

Answer 3

Es necesario utilizar el parámetro files para enviar una solicitud POST de formulario de varias partes, incluso cuando no es necesario cargar ningún archivo.

Desde el original requests fuente:

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. 

La solicitud impreso de varias copias más simple que incluye tanto los datos para cargar y campos de formulario se vería así:

multipart_form_data = { 
    'file1': open('myfile.zip', 'rb'), 
    'file2': ('custom_file_name.zip', open('myfile.zip', 'rb')), 
    'action': ('', 'store'), 
    'path': ('', '/path1') 
} 

response = requests.post('https://httpbin.org/post', files=multipart_form_data) 

print(response.content) 

☝ Nota la cadena vacía como el primer elemento en la tupla para campos de texto plano: este es un marcador de posición para el campo de nombre de archivo que solo se usa para cargar archivos, pero para el campo de texto, el marcador de posición vacío debe estar presente en orden para los datos que se enviarán

---

Si esta API no es suficiente Pythonic para usted, o si usted necesita para enviar múltiples campos con el mismo nombre, y luego considerar el uso de requests toolbelt ( pip install requests_toolbelt) que es una extensión del módulo core requests que proporciona soporte para archivos cargar la transmisión, así como MultipartEncoder que se puede utilizar en lugar de files, y que acepta parámetros como diccionarios y tuplas.

MultipartEncoder puede utilizarse tanto para solicitudes de varias partes con o sin campos de carga reales. Debe asignarse al parámetro data.

import requests 
from requests_toolbelt.multipart.encoder import MultipartEncoder 

multipart_data = MultipartEncoder(
    fields={ 
      # a file upload field 
      'file': ('file.py', open('file.py', '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}) 

Si necesita enviar varios campos con el mismo nombre, o si el orden de los campos del formulario es importante, entonces una tupla o una lista se puede utilizar en lugar de un diccionario, es decir:

multipart_data = MultipartEncoder(
    fields=(
      ('action', 'store'), 
      ('path', '/path1'), 
      ('path', '/path2'), 
      ('path', '/path3'), 
      ) 
    )