Как установить Poetry для управления зависимостями Python в Ubuntu 22.04

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

В этом руководстве вы установите Poetry с помощью официального сценария установки, настроите проект Poetry с виртуальной средой, а затем добавите и установите зависимости вашего проекта. 

Предпосылки:

1. Сервер Ubuntu 22.04, настроенный в соответствии с нашим первоначальным руководством по настройке сервера для Ubuntu 22.04, с пользователем, не являющимся root, с привилегиями sudo и включенным брандмауэром.
2. Последняя версия Python 3 установлена на вашем компьютере после выполнения шага 1 инструкции по установке Python 3 и настройке среды программирования на сервере Ubuntu 22.04.

Шаг 1: Установка Poetry

Poetry устанавливается с помощью официального установочного скрипта, представленного на веб-сайте Poetry.  Эта команда загрузит сценарий установки, а затем запустит установку Poetry в вашей системе. Хотя это руководство предназначено для сервера Ubuntu 22.04, этот сценарий установки мозно запустить в Linux, macOS и Windows с WSL (подсистема Windows для Linux), которую можно установить с помощью этого руководства. ВВедите следующую команду:

После завершения установки Poetry предложит вам добавить папку bin в ваш PATH, чтобы включить использование poetry в командной строке. В Ubuntu с Bash это можно сделать, открыв файл ~/.bashrc с помощью nano или другого текстового редактора

Добавьте следующую строку в конец файла:

Сохраниет файл и выйлите из него, с nano это можно сделать, нажав CTRL+X - чтобы выйти, и Y - чтобы сохранить любые изменения.

Затем примените изменения к вашему текущему сеансу: 

Чтобы убедиться, что команда poetry теперь доступна, введите следующее, чтобы отобразить текущую версию Poetry: 

Теперь у нас установлен работающий Poetry, и вы можете приступать к настройке проекта Poetry.

Шаг 2: Создание проекта Poetry

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

Затем перейдите в каталог вашего нового проекта:

Теперь ваш новый проект Poetry с необходимыми шаблонными файлами создан. Чтобы посмотреть недавно созданные файлы проекта, используйте команду  ls

Шаг 3: Добавление зависимостей

Прежде чем вы начнете добавление зависимостей в свой проект, вы начнете с проверки и понимания файла, который Poetry использует для хранения ваших зависимостей. В каталоге вашего проекта Poetry находится автоматически сгенерированный файл   pyproject.toml, содержащих список ваших зависимостей. Откройте и осмотрите его с помощью следующих действий:

Наряду с вашими зависимостями, которые перечислены в tool.poetry.dependencies, также есть метаданные в tool.poetry. Не стесняйтесь настраивать эти метаданные, добавляя свою собственную информацию, такую как имя, адрес электронной почты и описание проекта. Блок build-system в настоящее время содержит спецификации того, как Poetry будет собирать ваши пакеты, и пока его можно оставить не тронутым. 

Следует отметить, что Python 3.10, хотя и является последней версией, может быть требовательным к ресурсам и может быть проблемой в зависимости от системы. Большинству библиотек Python требуется как минимум версия 3.8. Если вы хотите изменить версию Python, используемую вашим проектом в качестве зависимости, закрепление зависимостей версий будет рассмотрено на шаге 4 этого руководства.

В текущем состоянии наш проект не имеет никаких зависимостей, кроме самого Python. Poetry может добавлять новые зависимости в ваш проект прямо из командной строки. Используя команду Poetry add, Poetry одновременно добавит строку зависимости в ваш блок tool.poetry.dependencies и установит зависимость.

После проверки вашего файла pyproject.toml выйдите из редактора. В качестве примера вы добавите популярную HTTP-библиотеку Python, requests, в зависимости вашего проекта вместе с ее установкой с помощью команды add. Эта библиотека позволяет отправлять HTTP-запросы с минимальным шаблонным кодом и полезна для приложений взаимодействующих через HTTP, хотя для целей этой демонстрации будет достаточно любого пакета. Введите следующую команду:

Наряду с  добавлением в ваш файл pyproject.toml и установкой requests, команда add также выполняет инициализацию виртуальной среды. Кроме того, requests имеют свои собственные зависимости. Poetry автоматически устанавливает все эти зависимости, перед самой установкой requests.

Ваш файл pyproject.toml будет обновлен следующим образом:

Это гарантирует, что requests всегда будет установлен. Символ ^ означает, что это будет минимально допустимая версия для установки, а также будут приемлемы более поздние версии. 

Шаг 4: Удаление и закрепление зависимостей

Чтобы обеспечить согласованность между вашими текущими установленными зависимостями и зависимостями, которые вы указали в файле pyproject.toml, Poetry использует lock file.  Poetry читает непосредственно из этого файла во время процесса установки, а это означает, что непосредственное редактирование файла pyproject.toml для изменения ваших зависимостей может вызвать некоторые ошибки или предупреждение, такие как это: 

Таким образом, если вам нужно удалить зависимость или отредактировать ее версию, вы должны использовать команду poetry remove. Хотя ручное редактирование файла   pyproject.toml возможно, вам придется учитывать lock file и вручную активировать виртуальную среду. Итак, в случае, если вы хотите изменить версию requests, сначала удалите ее с помощью команды:

Теперь, когда requests удален. вы можете добавить его снова в качестве закрепленной зависимости. Что касается зависимостей, вы часто хотите сохранить библиотеку в определенной версии для вашего проекта. Это часто происходит из-за проблем с совместимостью, поскольку библиотеки меняются с течением времени, и может быть полезно и может быть полезно для обеспечения согласованности вашего проекта. Это называется закреплением зависимостей.

В качестве примера вы будете привязывать requests к версии, отличной от последней, которая используется по умолчанию при выполнении команды add. Вместо этого вы прикрепите его к версии 2.26.0, которая является более ранней действительной версией, найденной в истории PyPI из requests:

Теперь в вашем файле pyproject.toml вы найдете:

Это указывает на то, что requests всегда будут устанавливаться как версия 2.26.0.

Заключение

В этом руководстве вы установили Poetry, и создали проект Poetry, либо с нуля, либо в рамках существующего проекта. Вы также добавили к нему зависимости, а затем установили эти зависимости в виртуальной среде. Кроме того, вы удалили зависимость перед добавлением ее в качестве закрепленной зависимости в свой проект. Далее вы можете изучить дополнительные возможности Poetry с помощью этого руководства.