Файл requirements.txt — что это и зачем? Разбираемся, как управлять зависимостями в Python

• 19.03.2023
• 657
• Основы Python
• Виртуальное окружение

В Python важную роль играет управление зависимостями — библиотеками и пакетами, которые используются в проекте. Чтобы облегчить этот процесс, в Python существует файл requirements.txt. Этот файл содержит список всех пакетов, необходимых для работы проекта, а также их версии.

Requirements.txt — это текстовый файл, который содержит список всех зависимостей, необходимых для работы вашего проекта. Каждая строка в файле обычно содержит имя пакета и его версию, разделенные символом ==.

Пример файла requirements.txt:

Django==3.2.10
psycopg2-binary==2.9.1

Этот файл указывает, что для работы проекта требуется установить библиотеку Django версии 3.2.10 и библиотеку psycopg2-binary версии 2.9.1.

Как использовать requirements.txt

Когда вы работаете над проектом в Python, часто бывает необходимо установить большое количество зависимостей. Для установки всех этих зависимостей можно воспользоваться командой pip install. Однако это может занять много времени и требует много усилий, особенно если зависимости будут устанавливаться на другом компьютере или на сервере.

Чтобы упростить этот процесс, можно использовать файл requirements.txt. Для установки всех зависимостей, перечисленных в этом файле, можно воспользоваться следующей командой:

pip install -r requirements.txt

Эта команда установит все зависимости, указанные в файле requirements.txt, и их соответствующие версии.

Как создать requirements.txt

Чтобы создать файл requirements.txt, можно воспользоваться командой pip freeze. Эта команда создаст список всех установленных пакетов в вашей виртуальной среде и их версий. Этот список можно сохранить в файле requirements.txt следующим образом:

pip freeze > requirements.txt

Эта команда создаст файл requirements.txt в текущем каталоге и запишет в него список всех установленных пакетов и их версий.

Также можно создать файл requirements.txt вручную, просто перечислив все требуемые зависимости и их версии вручную.

Пример:

requests==2.26.0
numpy==1.21.2

Что еще нужно знать о requirements.txt

Когда вы работаете над проектом в Python, может возникнуть ситуация, когда необходимо установить зависимости из другого источника, например, из внутреннего хранилища или из локального каталога. В таких случаях можно указать путь к файлу или каталогу с зависимостями в файле requirements.txt.

Например, для установки зависимости из локального каталога, можно указать путь к этому каталогу в файле requirements.txt следующим образом:

./my_package

Это указывает на каталог my_package в текущем каталоге. Зависимости из этого каталога будут установлены при использовании команды pip install -r requirements.txt.

Также можно указать путь к архиву или файлу с зависимостями, используя префикс file://. Например:

file:///path/to/my_package.tar.gz

Это указывает на архив my_package.tar.gz, расположенный в каталоге /path/to/. Зависимости из этого архива будут установлены при использовании команды pip install -r requirements.txt.

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

Заключение

Файл requirements.txt — это важный элемент управления зависимостями в Python. Он упрощает процесс установки и обновления зависимостей, позволяет легко переносить проект на другие компьютеры и убедиться, что все зависимости установлены и работают правильно.