Пересмотр упаковки Python с помощью Pipenv

обзор

Python — один из самых дружественных, но самых мощных языков. Новичкам легко его освоить, но он обладает сильным ударом и широко используется в различных областях, таких как научное программирование, программирование веб-приложений и DevOps. Но одним из слабых мест Python была его поддержка упаковки сложных приложений и их зависимостей.

За эти годы было много усилий, чтобы улучшить ситуацию. В августе 2017 года я написал учебник о современном состоянии упаковки Python: как писать, упаковывать и распространять библиотеку в Python .

Прошло всего четыре месяца, и в городе появился новый игрок. Pipenv теперь официально рекомендованный инструмент для упаковки от PyPA (Python Packaging Authority). Из этого руководства вы узнаете, почему Pipenv значительно улучшает состояние упаковки и общий процесс разработки для разработчиков на Python и как эффективно его использовать.

Python Dev Workflow для людей

Цель Pipenv — улучшить рабочий процесс разработчиков Python, когда дело доходит до управления зависимостями и виртуальными средами. Это еще одна замечательная библиотека от трудолюбивого Кеннета Рейтца , который известен в основном пакетом запросов (HTTP для людей), но написал несколько других превосходных пакетов.

Нужен ли нам еще один упаковочный инструмент?

Да! Pipenv берет страницу из современных методов управления пакетами и импортирует их в мир Python.

Установка Pipenv

Вы можете установить Pipenv с помощью pip install pipenv . Вы получите хороший результат с Emojis:

Тебе придется сделать это только один раз. Если у вас не установлен pip, вы можете использовать эту команду начальной загрузки: $ curl https://github.com/pypa/pipenv/blob/master/get-pipenv.py | python | python

Pipfile и Pipfile.lock

Pipenv может создать пустую виртуальную среду для вас. Вот быстрое демо:

Это создаст пустой Pip-файл без зависимостей. Но поскольку вы, вероятно, захотите установить несколько пакетов для своего проекта, вы можете просто использовать pipenv для установки пакета, и он автоматически создаст виртуальную среду. Например:

Уровень детализации отличный, и в нем тоже используются приятные цвета. Вот полученный Pipfile:

Pipfile отслеживает зависимости верхнего уровня вашего проекта — здесь просто requests = "*" . Он использует TOML в качестве формата, который в наши дни является популярным выбором для файлов конфигурации (Rust’s Cargo, Python’s PEP-518).

Файл Pipefile.lock, с другой стороны, представляет собой файл JSON, в котором указаны некоторые метаданные и точные версии (включая хэши) всех рекурсивных зависимостей (зависимостей верхнего уровня и их зависимостей). Вот файл Pipfile.lock:

Если вы хотите увидеть график всех ваших зависимостей, введите: pipenv graph

Использование установленных пакетов с Pipenv

После установки пакета с помощью Pipenv он становится доступным в вашей виртуальной среде, как и стандартный пакет (так же, как если бы вы установили его с помощью pip). Единственная мера предосторожности заключается в том, что вы должны использовать интерпретатор виртуальной среды. Pipenv предоставляет две полезные команды: run и shell .

Вы используете pipenv run python <your program>.py , и вы используете pipenv shell для запуска новой оболочки с вашим интерпретатором Python виртуальной среды. Вот как можно использовать команду оболочки для запуска интерактивного сеанса Python, который использует пакет установленных запросов, чтобы получить смету дня из REST API. Виртуальная среда активируется, и при запуске Python используется правильный интерпретатор, где доступны requests .

Импортирование из требований .txt

Если вы хотите перенести существующий проект в файл require.txt, Pipenv поможет вам. Просто: pipenv install -r <path/to/requirements.txt> .

Все ваши зависимости будут импортированы в Pipfile. Чтобы фактически установить зависимости и сгенерировать Pipfile.lock, вам нужно pipenv install . После того, как вы убедились, что все работает должным образом, вы можете удалить свой файл needs.txt.

Если ваш файл require.txt существует в том же каталоге, в котором вы создаете виртуальную среду, тогда Pipenv автоматически сгенерирует Pip-файл. Но имейте в виду, что если ваш файл require.txt содержит закрепленные версии, они также будут закреплены в Pipfile. В мире Pipenv закрепление должно происходить в файле Pipfile.lock. Pipenv даст дружеское напоминание. См. ниже:

Вот закрепленная версия в Pipfile, которую рекомендуется изменить на «*»:

Давайте установим зависимости сейчас:

Редактируемые зависимости

Вы можете указать Pipenv установить путь как редактируемый. Это полезно, когда вы зависите от разрабатываемых вами пакетов и хотите зависеть от исходного пакета, фактически не устанавливая их каждый раз, когда вы вносите изменения. В частности, это полезно для текущего каталога, когда вы активно работаете в нем. Для этого используйте флаги -e и --dev :

У вас должен быть правильный файл setup.py.

Управление вашей средой с Pipenv

Вы уже видели многое из того, что Pipenv может сделать для вас. Давайте углубимся в некоторые дополнительные команды и опции.

Установка пакетов

Команда pipenv install поддерживает несколько параметров:

• --dev : Установить как --dev разработки, так и пакеты по умолчанию из Pipfile.lock.
• --system : используйте команду system pip, а не команду вашего virtualenv.
• --ignore-pipfile : игнорировать Pipfile и установить его из Pipfile.lock.
• --skip-lock : игнорировать файл Pipfile.lock и установить его из файла Pipfile. Кроме того, не записывайте файл Pipfile.lock, отражающий изменения в файле Pipfile.

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

Деинсталляция пакетов

Чтобы удалить зависимость, введите: pipenv uninstall <package name> . Например:

Обратите внимание, что мне не нужно было указывать «запросы == 2.8.14» при удалении, хотя это было закреплено в Pipfile.

Блокировка зависимостей

Если вы хотите создать моментальный снимок ваших текущих зависимостей (например, перед выпуском), используйте команду блокировки. Это ключ к детерминированным и повторяемым сборкам: pipenv lock --pre .

Удаление виртуальной среды

Pipenv великолепен, но вы можете время от времени очищать некоторые из ваших виртуальных сред. Это так же просто, как pipenv --rm .

Безопасность

Pipfile.lock использует некоторые новые улучшения безопасности в pip. По умолчанию файл Pipfile.lock будет создан с хэшем sha256 каждого загруженного пакета. Это позволит pip гарантировать, что вы устанавливаете то, что намереваетесь, когда находитесь в скомпрометированной сети, или загружаете зависимости из ненадежной конечной точки PyPI.

Кроме того, Pipenv предоставляет команду check , которая проверяет соответствие PEP 508 — Спецификация зависимостей для пакетов программного обеспечения Python, а также безопасность пакетов:

Вывод

Pipenv наконец-то выводит упаковку Python на передний край современной разработки программного обеспечения. Это черпает вдохновение из других успешных систем управления зависимостями, таких как Rust’s Cargo и Javascript’s Yarn.

Он сочетает в себе виртуальные среды и управление пакетами и обеспечивает превосходное взаимодействие с красивыми и красочными информационными сообщениями и неявными лучшими практиками! Я настоятельно рекомендую вам начать использовать Pipenv для управления проектами Python.

Кроме того, не стесняйтесь посмотреть, что у нас есть в наличии для продажи и для изучения на рынке Envato , и не стесняйтесь задавать любые вопросы и предоставлять ценные отзывы, используя канал ниже.