Python http post files

How to Upload Files with Python’s requests Library

Python is supported by many libraries which simplify data transfer over HTTP. The requests library is one of the most popular Python packages as it’s heavily used in web scraping. It’s also popular for interacting with servers! The library makes it easy to upload data in a popular format like JSON, but also makes it easy to upload files as well.

In this tutorial, we will take a look at how to upload files using Python’s requests library. The article will start by covering the requests library and the post() function signature. Next, we will cover how to upload a single file using the requests package. Last but not least, we upload multiple files in one request.

Uploading a Single File with Python’s Requests Library

This tutorial covers how to send the files, we’re not concerned about how they’re created. To follow along, create three files called my_file.txt , my_file_2.txt and my_file_3.txt .

The first thing we need to do is install our the request library in our workspace. While not necessary, it’s recommended that you install libraries in a virtual environment:

Activate the virtual environment so that we would no longer impact the global Python installation:

Now let’s install the requests library with pip :

Create a new file called single_uploader.py which will store our code. In that file, let’s begin by importing the requests library:

Now we’re set up to upload a file! When uploading a file, we need to open the file and stream the content. After all, we can’t upload a file we don’t have access to. We’ll do this with the open() function.

The open() function accepts two parameters: the path of the file and the mode. The path of the file can be an absolute path or a relative path to where the script is being run. If you’re uploading a file in the same directory, you can just use the file’s name.

The second argument, mode, will take the «read binary» value which is represented by rb . This argument tells the computer that we want to open the file in the read mode, and we wish to consume the data of the file in a binary format:

test_file = open("my_file.txt", "rb") 

Note: it’s important to read the file in binary mode. The requests library typically determines the Content-Length header, which is a value in bytes. If the file is not read in bytes mode, the library may get an incorrect value for Content-Length , which would cause errors during file submission.

For this tutorial, we’ll make requests to the free httpbin service. This API allows developers to test their HTTP requests. Let’s create a variable that stores the URL we’ll post our files to:

test_url = "http://httpbin.org/post" 

We now have everything to make the request. We’ll use the post() method of the requests library to upload the file. We need two arguments to make this work: the URL of the server and files property. We’ll also save the response in a variable, write the following code:

test_response = requests.post(test_url, files = "form_field_name": test_file>) 

The files property takes a dictionary. The key is the name of the form field that accepts the file. The value is the bytes of the opened file you want to upload.

Normally to check if your post() method was successful we check the HTTP status code of the response. We can use the ok property of the response object, test_url . If it’s true, we’ll print out the response from the HTTP server, in this case, it will echo the request:

Free eBook: Git Essentials

Check out our hands-on, practical guide to learning Git, with best-practices, industry-accepted standards, and included cheat sheet. Stop Googling Git commands and actually learn it!

if test_response.ok: print("Upload completed successfully!") print(test_response.text) else: print("Something went wrong!") 

Let’s try it out! In the terminal, execute your script with the python command:

Your output would be similar to this:

Upload completed successfully! < "args": <>, "data": "", "files": < "form_field_name": "This is my file\nI like my file\n" >, "form": <>, "headers": < "Accept": "*/*", "Accept-Encoding": "gzip, deflate", "Content-Length": "189", "Content-Type": "multipart/form-data; boundary=53bb41eb09d784cedc62d521121269f8", "Host": "httpbin.org", "User-Agent": "python-requests/2.25.0", "X-Amzn-Trace-Id": "Root=1-5fc3c190-5dea2c7633a02bcf5e654c2b" >, "json": null, "origin": "102.5.105.200", "url": "http://httpbin.org/post" > 

As a sanity check, you can verify the form_field_name value matches what’s in your file.

Uploading Multiple Files with Python’s requests Library

Uploading multiple files using requests is quite similar to a single file, with the major difference being our use of lists. Create a new file called multi_uploader.py and the following setup code:

import requests test_url = "http://httpbin.org/post" 

Now create a variable called test_files that’s a dictionary with multiple names and files:

test_files = < "test_file_1": open("my_file.txt", "rb"), "test_file_2": open("my_file_2.txt", "rb"), "test_file_3": open("my_file_3.txt", "rb") > 

Like before, the keys are the names of the form fields and the values are the files in bytes.

We can also create our files variables as a list of tuples. Each tuple contains the name of the form field accepting the file, followed by the file’s contents in bytes:

test_files = [("test_file_1", open("my_file.txt", "rb")), ("test_file_2", open("my_file_2.txt", "rb")), ("test_file_3", open("my_file_3.txt", "rb"))] 

Either works so choose whichever one you prefer!

Once the list of files is ready, you can send the request and check its response like before:

test_response = requests.post(test_url, files = test_files) if test_response.ok: print("Upload completed successfully!") print(test_response.text) else: print("Something went wrong!") 

Execute this script with the python command:

Upload completed successfully! < "args": <>, "data": "", "files": < "test_file_1": "This is my file\nI like my file\n", "test_file_2": "All your base are belong to us\n", "test_file_3": "It's-a me, Mario!\n" >, "form": <>, "headers": < "Accept": "*/*", "Accept-Encoding": "gzip, deflate", "Content-Length": "470", "Content-Type": "multipart/form-data; boundary=4111c551fb8c61fd14af07bd5df5bb76", "Host": "httpbin.org", "User-Agent": "python-requests/2.25.0", "X-Amzn-Trace-Id": "Root=1-5fc3c744-30404a8b186cf91c7d239034" >, "json": null, "origin": "102.5.105.200", "url": "http://httpbin.org/post" > 

Good job! You can upload single and multiple files with requests !

Conclusion

In this article, we learned how to upload files in Python using the requests library. Where it’s a single file or multiple files, only a few tweaks are needed with the post() method. We also verified our response to ensure that our uploads were successful.

Источник

Как загружать файлы с помощью библиотеки запросов Python

Python поддерживается многими библиотеками, которые упрощают передачу данных по HTTP. Библиотека requests является одним из наиболее популярных пакетов Python, и широко используется в веб — парсинге. Он также популярен для взаимодействия с серверами! Библиотека позволяет легко загружать данные в популярном формате, таком как JSON, но также упрощает загрузку файлов.

В этом руководстве мы рассмотрим, как загружать файлы с помощью библиотеки Python requests . Статья начнется с описания библиотеки и сигнатуры функции post() . Далее мы расскажем, как загрузить один файл с помощью пакета requests . И последнее, но не менее важное: мы загружаем несколько файлов за один запрос.

Загрузка одного файла с помощью библиотеки запросов Python

В этом руководстве рассказывается, как отправлять файлы, нас не волнует, как они создаются. Чтобы продолжить, создайте три файла с именами my_file.txt , my_file_2.txt и my_file_3.txt .

Первое, что нам нужно сделать, это установить нашу библиотеку request в нашу рабочую область. Хотя в этом нет необходимости, рекомендуется устанавливать библиотеки в виртуальной среде:

Активируйте виртуальную среду, чтобы мы больше не влияли на глобальную установку Python:

Теперь давайте установим библиотеку requests с помощью pip :

Создайте новый файл с именем single_uploader.py , в котором будет храниться наш код. В этом файле давайте начнем с импорта библиотеки requests :

Теперь мы готовы загрузить файл! При загрузке файла нам нужно открыть файл и выполнить потоковую передачу содержимого. В конце концов, мы не можем загрузить файл, к которому у нас нет доступа. Сделаем это с помощью функции open() .

Функция open() принимает два параметра: путь к файлу и режим. Путь к файлу может быть абсолютным или относительным путем к тому месту, где выполняется сценарий. Если вы загружаете файл в тот же каталог, вы можете просто использовать имя файла.

Второй аргумент, режим, будет принимать значение «read binary», которое представлено rb . Этот аргумент сообщает компьютеру, что мы хотим открыть файл в режиме чтения, и мы хотим использовать данные файла в двоичном формате:

test_file = open("my_file.txt", "rb") 

Примечание: важно читать файл в двоичном режиме. Библиотека requests обычно определяет заголовок Content-Length , который представляет собой значение в байтах. Если файл не читается в байтовом режиме, библиотека может получить неверное значение для Content-Length , что приведет к ошибкам при отправке файла.

В этом руководстве мы будем делать запросы к бесплатному сервису httpbin. Этот API позволяет разработчикам тестировать свои HTTP-запросы. Давайте создадим переменную, которая хранит URL-адрес, по которому мы будем размещать наши файлы:

test_url = "http://httpbin.org/post" 

Теперь у нас есть все, чтобы сделать запрос. Мы будем использовать метод post() библиотеки requests для загрузки файла. Чтобы это работало, нам нужны два аргумента: URL-адрес сервера и свойство files . Также сохраним ответ в переменной, напишем следующий код:

test_response = requests.post(test_url, files = ) 

Свойство files принимает словарь. Ключ — это имя поля формы, которое принимает файл. Значение — это байты открытого файла, который вы хотите загрузить.

Обычно, чтобы проверить, был ли ваш метод post() успешным, мы проверяем HTTP код статуса ответа. Мы можем использовать свойство ok объекта ответа test_url . Если он True , мы распечатаем ответ HTTP-сервера, в этом случае он отобразит запрос:

if test_response.ok: print("Upload completed successfully!") print(test_response.text) else: print("Something went wrong!") 

Давай попробуем! В терминале выполните свой скрипт с помощью команды python :

Ваш результат будет примерно таким:

Upload completed successfully! < "args": <>, "data": "", "files": < "form_field_name": "This is my file\nI like my file\n" >, "form": <>, "headers": < "Accept": "*/*", "Accept-Encoding": "gzip, deflate", "Content-Length": "189", "Content-Type": "multipart/form-data; boundary=53bb41eb09d784cedc62d521121269f8", "Host": "httpbin.org", "User-Agent": "python-requests/2.25.0", "X-Amzn-Trace-Id": "Root=1-5fc3c190-5dea2c7633a02bcf5e654c2b" >, "json": null, "origin": "102.5.105.200", "url": "http://httpbin.org/post" > 

В качестве проверки работоспособности вы можете убедиться, что значение form_field_name соответствует тому, что находится в вашем файле.

Загрузка нескольких файлов с помощью Python библиотеки requests

Загрузка нескольких файлов с помощью requests очень похожа на загрузку одного файла, с основным отличием в том, что мы используем списки. Создайте новый файл с именем multi_uploader.py и следующий код внутри:

import requests test_url = "http://httpbin.org/post" 

Теперь создайте переменную словарь под названием test_files с несколькими именами и файлами:

Как и раньше, ключи — это имена полей формы, а значения — файлы в байтах.

Мы также можем создавать переменные наших файлов в виде списка кортежей. Каждый кортеж содержит имя поля формы, принимающего файл, за которым следует содержимое файла в байтах:

test_files = [("test_file_1", open("my_file.txt", "rb")), ("test_file_2", open("my_file_2.txt", "rb")), ("test_file_3", open("my_file_3.txt", "rb"))] 

Любой вариант работает, поэтому выберите тот, который вам больше нравится!

Когда список файлов будет готов, вы можете отправить запрос и проверить его ответ, как и раньше:

test_response = requests.post(test_url, files = test_files) if test_response.ok: print("Upload completed successfully!") print(test_response.text) else: print("Something went wrong!") 

Выполните этот скрипт с помощью команды:

Upload completed successfully! < "args": <>, "data": "", "files": < "test_file_1": "This is my file\nI like my file\n", "test_file_2": "All your base are belong to us\n", "test_file_3": "It's-a me, Mario!\n" >, "form": <>, "headers": < "Accept": "*/*", "Accept-Encoding": "gzip, deflate", "Content-Length": "470", "Content-Type": "multipart/form-data; boundary=4111c551fb8c61fd14af07bd5df5bb76", "Host": "httpbin.org", "User-Agent": "python-requests/2.25.0", "X-Amzn-Trace-Id": "Root=1-5fc3c744-30404a8b186cf91c7d239034" >, "json": null, "origin": "102.5.105.200", "url": "http://httpbin.org/post" > 

Заключение

В этой статье мы узнали, как загружать файлы в Python с помощью библиотеки requests . Если это один файл или несколько файлов, требуется лишь несколько настроек метода post() . Мы также проверили наш ответ, чтобы убедиться, что загрузка прошла успешно.

Источник:

Источник