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

Что такое поэзия?

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

• Создавайте проекты: легко создавайте и упаковывайте свои проекты с помощью одной команды.
• Поделитесь своей работой: сделайте свою работу известной, опубликовав ее на PyPI.
• Проверьте статус ваших зависимостей: получите представление о зависимостях вашего проекта с помощью всего одной команды.
• Разрешение зависимостей: Poetry поставляется с исчерпывающим средством разрешения зависимостей, которое всегда найдет решение, если оно существует.
• Изоляция: Poetry использует настроенные виртуальные среды или создает свои собственные, чтобы всегда быть изолированными от вашей системы.
• Интуитивный интерфейс командной строки: команды Poetry интуитивно понятны и просты в использовании, чувствительны к умолчанию, но их можно настроить.

Благодаря этим преимуществам Poetry выделяется как мощный и эффективный инструмент для разработки проектов Python.

Что нам нужно перед запуском нашей библиотеки Python?

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

Проверьте версию Python

Во-первых, нам нужно убедиться, что у вас установлена ​​последняя версия Python. Чтобы проверить версию Python, установленную в вашей системе, выполните в терминале следующую команду:

python --version

Если у вас еще не установлен Python или вам необходимо его обновить, вы можете загрузить и установить его с официального сайта Python.

Установка поэзии

Убедившись, что у вас установлена ​​последняя версия Python, следующим шагом будет установка Poetry. Вы можете установить Poetry, следуя инструкциям, подробно описанным в официальной документации. Вот быстрая команда для установки:

curl -sSL https://install.python-poetry.org | python3 -

Создание библиотеки: первые шаги

Шаг 1. Создание проекта с помощью Poetry

Теперь, когда у нас установлены Python и Poetry, пришло время начать наш проект калькулятора. Poetry позволяет легко создать новый проект с помощью простой команды.

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

poetry new calculator
cd calculator

Эта команда создает для вас новую структуру проекта, которая включает в себя необходимые папки и файлы.

calculator/
├── README.md
├── calculator
│   └── __init__.py
├── pyproject.toml
└── tests
    └── __init__.py

Давайте разберемся в сгенерированной структуре:

• README.md: файл документации для описания вашего проекта.
• калькулятор/: папка, содержащая исходный код вашего приложения.
• tests/: папка для ваших модульных тестов.
• pyproject.toml: основной файл конфигурации Poetry.

Шаг 2: Реализация функций калькулятора

Теперь давайте создадим функции калькулятора в файле Calculator/calculator.py.

calculator/
├── calculator.py
├── __init__.py

Откройте файл Calculator.py и реализуйте основные функции калькулятора:

def add(a, b):
    return a   b

def subtract(a, b):
    return a - b

def multiply(a, b):
    return a * b

def divide(a, b):
    if b == 0:
        raise ValueError("Não é possível dividir por zero")
    return a / b

Шаг 3. Тестирование функций калькулятора

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

Настройка среды тестирования

Начните добавлять pytest в качестве зависимости разработки:

poetry add --dev pytest

Теперь создайте файл с именем test_calculator.py внутри папки тестов:

import pytest
from calculator.calculator import add, subtract, multiply, divide

def test_add():
    assert add(2, 3) == 5
    assert add(-1, 1) == 0
    assert add(0, 0) == 0
    assert add(-1, -1) == -2

def test_subtract():
    assert subtract(5, 2) == 3
    assert subtract(0, 0) == 0
    assert subtract(-1, 1) == -2
    assert subtract(-1, -1) == 0

def test_multiply():
    assert multiply(2, 3) == 6
    assert multiply(5, 0) == 0
    assert multiply(-1, 1) == -1
    assert multiply(-2, -3) == 6

def test_divide():
    assert divide(6, 2) == 3
    assert divide(5, 2) == 2.5
    assert divide(-10, 2) == -5
    with pytest.raises(ValueError):
        divide(4, 0)

Наконец, просто запустите тесты с помощью следующей команды:

poetry run pytest

Шаг 4. Публикация на GitHub

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

1. Создайте репозиторий на GitHub: перейдите на GitHub и создайте новый репозиторий для вашего калькулятора.

2. Добавьте свой проект в репозиторий:

• Инициализируйте репозиторий Git внутри каталога вашего проекта, если он еще не инициализирован:

git init

• Добавьте все файлы в Git и сделайте первый коммит:

git add .
git commit -m "Initial commit"

• Подключите локальный репозиторий к удаленному репозиторию на GitHub:

git remote add origin 

• Загрузите файлы на GitHub:

git push -u origin main

Теперь ваш проект размещен на GitHub и готов к совместному использованию и совместной работе с другими разработчиками.

Шаг 5. Установка через Pip или Poetry

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

• Через Пип:

pip install git https://github.com/seu_usuario/seu_repositorio.git

• Через поэзию:

poetry add git https://github.com/seu_usuario/seu_repositorio.git

Что будет дальше?

В этой первой части руководства мы рассмотрим основные основы создания библиотеки Python с использованием Poetry. Мы начали с настройки среды разработки, реализовали базовый калькулятор с модульными тестами с помощью pytest и поделились проектом на GitHub для совместной работы.

В следующей части этого руководства мы рассмотрим, как опубликовать вашу библиотеку в PyPI, стандартном репозитории пакетов Python, и узнаем, как установить ее с помощью Poetry или pip непосредственно из PyPI. Это не только облегчит использование вашей библиотеки другим разработчикам, но также поможет интегрировать вас в сообщество Python.

Поздравляем с тем, что вы зашли так далеко! Надеюсь, вам нравится создавать свою библиотеку Python. Не стесняйтесь делиться вопросами или предложениями в комментариях. Давайте теперь перейдем ко второй части и продолжим наш путь сотрудничества с сообществом Python.

Рекомендации

• Канал Эдуардо Мендес (@Dunossauro) Создание пакета Python с нуля: от требований к развертыванию
• Поэтическая документация
• Поэзия: простой способ создания пакетов Python