Как написать, упаковать и распространить библиотеку в Python

Python — отличный язык программирования, но упаковка — один из его слабых мест. Это общеизвестный факт в обществе. Установка, импорт, использование и создание пакетов значительно улучшились за эти годы, но это все еще не на одном уровне с новыми языками, такими как Go и Rust, которые многому научились из борьбы Python и других зрелых языков.

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

Как написать библиотеку Python

Библиотека Python — это связная коллекция модулей Python, организованная в виде пакета Python. В общем, это означает, что все модули находятся в одном каталоге и этот каталог находится в пути поиска Python.

Давайте быстро напишем небольшой пакет Python 3 и проиллюстрируем все эти концепции.

Пакет патологии

Python 3 имеет отличный объект Path, который является огромным улучшением по сравнению с неуклюжим модулем Python 2 os.path. Но ему не хватает одной важной возможности — найти путь к текущему сценарию. Это очень важно, когда вы хотите найти файлы доступа относительно текущего скрипта.

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

Вот как вы делаете это в Python:

Для доступа к файлу с именем file.txt в подкаталоге data текущего каталога скрипта вы можете использовать следующий код: print(open(str(script_dir/'data/file.txt').read())

С пакетом pathology у вас есть встроенный метод script_dir , и вы используете его следующим образом:

Да, это полный рот. Пакет патологии очень прост. Он извлекает свой собственный класс Path из Pathlib’s Path и добавляет статический script_dir (), который всегда возвращает путь вызывающего скрипта.

Вот реализация:

Из-за кросс-платформенной реализации pathlib.Path , вы можете наследовать его напрямую и должны наследовать от определенного подкласса ( PosixPath или WindowsPath ). Разрешение dir скрипта использует модуль inspect для поиска вызывающего абонента, а затем его атрибута имени файла.

Тестирование пакета патологии

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

Путь Питона

Пакеты Python должны быть установлены где-то на пути поиска Python для импорта модулями Python. Путь поиска Python представляет собой список каталогов и всегда доступен в sys.path . Вот мой текущий sys.path:

Обратите внимание, что первая пустая строка вывода представляет текущий каталог, поэтому вы можете импортировать модули из текущего рабочего каталога, каким бы он ни был. Вы можете напрямую добавлять или удалять каталоги в / из sys.path.

Вы также можете определить переменную среды PYTHONPATH , и есть несколько других способов управления ею. Стандартные site-packages включены по умолчанию, и именно здесь вы устанавливаете пакеты с помощью pip go.

Как упаковать библиотеку Python

Теперь, когда у нас есть наш код и тесты, давайте упаковываем все это в правильную библиотеку. Python предоставляет простой способ через модуль установки. Вы создаете файл с именем setup.py в корневом каталоге вашего пакета. Затем, чтобы создать исходный дистрибутив, вы запускаете: python setup.py sdist

Чтобы создать бинарный дистрибутив, называемый колесом, вы запускаете: python setup.py bdist_wheel

Вот файл setup.py пакета патологии:

Он включает в себя множество метаданных в дополнение к элементу «packages», который использует find_packages() импортированную из setuptools для поиска find_packages() .

Давайте создадим исходный дистрибутив:

Предупреждение связано с тем, что я использовал нестандартный файл README.md. Это безопасно игнорировать. Результатом является tar-gzipped файл в каталоге dist:

А вот бинарный дистрибутив:

Пакет pathology содержит только чистые модули Python, поэтому можно создать универсальный пакет. Если ваш пакет включает расширения C, вам придется создать отдельное колесо для каждой платформы:

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

Как распространять пакет Python

Python имеет центральное хранилище пакетов, называемое PyPI (индекс пакетов Python). Когда вы устанавливаете пакет Python с помощью pip, он загружает пакет из PyPI (если вы не укажете другой репозиторий). Чтобы распространять наш пакет патологий, нам нужно загрузить его в PyPI и предоставить некоторые дополнительные метаданные, необходимые PyPI. Шаги:

• Создайте аккаунт на PyPI (только один раз).
• Зарегистрируйте свой пакет.
• Загрузите свой пакет.

Завести аккаунт

Вы можете создать учетную запись на сайте PyPI . Затем создайте файл .pypirc в вашем домашнем каталоге:

В целях тестирования вы можете добавить индексный сервер «pypitest» к вашему. файл pypirc :

Зарегистрируйте свой пакет

Если это первый выпуск вашего пакета, вам необходимо зарегистрировать его в PyPI. Используйте команду register из setup.py. Он попросит вас ввести пароль. Обратите внимание, что я указываю на тестовый репозиторий здесь:

Загрузить свой пакет

Теперь, когда пакет зарегистрирован, мы можем загрузить его. Я рекомендую использовать шпагат , который является более безопасным. Установите его, как обычно, используя pip install twine . Затем загрузите вашу посылку, используя шпагат, и введите свой пароль (отредактировано ниже):

Чтобы глубже погрузиться в тему распространения ваших пакетов, ознакомьтесь с разделом Как поделиться своими пакетами Python .

Вывод

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

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