Управление зависимостями Python с помощью requirements.txt

Расширенные примеры работы с requirements.txt

Как экспортировать только прямые зависимости?

Команда pip freeze выводит все установленные пакеты, включая транзитивные. Для получения только тех пакетов, которые явно добавлены в проект, можно использовать pip list --format=freeze | grep -v "-" (на Linux) или более надежный метод – установить pip-tools:

pip install pip-tools
# создаём requirements.in с прямыми зависимостями
# компилируем в requirements.txt
pip-compile requirements.in

$ cat requirements.in
flask
numpy
$ pip-compile requirements.in
# файл requirements.txt будет сгенерирован со всеми зависимостями и подверсиями

Как обновить все зависимости до последних версий, сохраняя ограничения?

Для обновления пакетов в requirements.txt до последних совместимых версий (с учетом заданных диапазонов) используется pip install --upgrade -r requirements.txt. Но эта команда обновит только те пакеты, версия которых явно не зафиксирована. Если нужно обновить всё, следует сначала снять фиксацию (package>=x вместо package==x), выполнить обновление и затем снова зафиксировать.

# исходный файл с фиксацией
numpy==1.24.3
pandas==2.0.3
# замена на >=
pip install --upgrade -r requirements.txt  # обновит до последней версии
pip freeze > requirements.txt              # обновлённый финал

Как проверить наличие конфликтов до установки?

Инструмент pip check проверяет, все ли зависимости удовлетворены. Если есть конфликт, он сообщит о несовместимых версиях.

pip check

$ pip check
No broken requirements found.

Для более глубокого анализа можно использовать pipdeptree:

pip install pipdeptree
pipdeptree

pipdeptree
numpy==1.24.3
pandas==2.0.3
  - numpy [required: >=1.20.3, installed: 1.24.3]
  - python-dateutil [required: >=2.8.1, installed: 2.8.2]
    - six [required: >=1.5, installed: 1.16.0]
requests==2.31.0
...

Как интегрировать requirements.txt с Docker?

В Dockerfile часто копируют requirements.txt и устанавливают зависимости отдельно для кеширования слоя:

# Dockerfile
FROM python:3.11-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY . .
CMD ["python", "app.py"]

Преимущество: при изменении кода приложения, но не зависимостей, слой с установкой кешируется, что ускоряет сборку.

Как использовать requirements.txt с проектами на базе setuptools?

Файл requirements.txt не является частью стандартной упаковки Python, но его можно указать в setup.py или setup.cfg. Однако удобнее использовать install_requires в setup.py для долгосрочных проектов, а requirements.txt – для временного воспроизведения окружения. Например:

# setup.py
from setuptools import setup
setup(
    name="mypackage",
    install_requires=[
        "numpy>=1.20",
        "pandas",
    ],
    extras_require={
        "dev": ["pytest", "sphinx"]
    },
)

Для установки с dev-зависимостями: pip install -e .[dev]

Как зашифровать пароль для частного репозитория в requirements.txt?

Не рекомендуется хранить пароли в файле. Вместо этого используется --extra-index-url с переменными окружения или конфигурация pip в pip.conf/~/.netrc.

# .netrc
machine private.pypi.org login user password secret
# затем в requirements.txt:
--extra-index-url https://private.pypi.org/simple/
my-private-package==1.0

Эти примеры покрывают большинство сценариев повседневного использования requirements.txt в реальных проектах.