Schritt für Schritt: Erstellen Sie Ihre erste Python-Bibliothek mit Poetry (Teil I)

Erfahren Sie, wie Sie Ihre erste Python-Bibliothek erstellen! In dieser Beitragsreihe führen wir Sie durch den Prozess der Erstellung und Veröffentlichung einer Python-Bibliothek mit Poetry. Beginnen wir mit der Erstellung einer kleinen Taschenrechneranwendung, die alles von der Erstkonfiguration bis zur Implementierung und dem Testen grundlegender Funktionen abdeckt. Am Ende dieser Serie haben Sie Ihre Bibliothek bereit, um sie mit der Welt auf PyPI zu teilen.

Was ist Poesie?

Poetry ist ein Abhängigkeitsmanagement- und Paketierungstool für Python-Projekte. Es vereinfacht den Prozess der Erstellung und Pflege von Bibliotheken und Anwendungen durch die Automatisierung vieler Aufgaben, für die traditionell mehrere Tools erforderlich sind. Poetry enthält alle Tools, die Sie für die deterministische Verwaltung Ihrer Projekte benötigen. Hier sind einige der Hauptvorteile der Poesie:

• Projekte erstellen: Erstellen und verpacken Sie Ihre Projekte ganz einfach mit einem einzigen Befehl.
• Teilen Sie Ihre Arbeit: Machen Sie Ihre Arbeit bekannt, indem Sie sie auf PyPI veröffentlichen.
• Überprüfen Sie den Status Ihrer Abhängigkeiten: Erhalten Sie mit nur einem Befehl einen Überblick über die Abhängigkeiten Ihres Projekts.
• Abhängigkeitsauflösung: Poetry verfügt über einen umfassenden Abhängigkeitslöser, der immer eine Lösung findet, falls vorhanden.
• Isolation: Poetry nutzt konfigurierte virtuelle Umgebungen oder erstellt eigene, um immer von Ihrem System isoliert zu sein.
• Intuitive CLI: Poetry-Befehle sind intuitiv und einfach zu verwenden, mit sinnvollen Standardeinstellungen und dennoch konfigurierbar.

Mit diesen Vorteilen zeichnet sich Poetry als leistungsstarkes und effizientes Werkzeug für die Entwicklung von Python-Projekten aus.

Was brauchen wir, bevor wir unsere Python-Bibliothek starten?

Bevor wir mit dem Schreiben von Code beginnen, müssen wir unsere Entwicklungsumgebung einrichten. Hier sind die Schritte, um sicherzustellen, dass Sie alles bereit haben:

Überprüfen Sie die Python-Version

Zuerst müssen wir sicherstellen, dass Sie die neueste Version von Python installiert haben. Um die auf Ihrem System installierte Python-Version zu überprüfen, führen Sie den folgenden Befehl im Terminal aus:

python --version

Wenn Sie Python noch nicht installiert haben oder es aktualisieren müssen, können Sie es von der offiziellen Python-Website herunterladen und installieren.

Poesie installieren

Nachdem Sie sichergestellt haben, dass Sie die neueste Version von Python installiert haben, besteht der nächste Schritt darin, Poetry zu installieren. Sie können Poetry installieren, indem Sie den Anweisungen in der offiziellen Dokumentation folgen. Hier ist ein schneller Befehl zur Installation:

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

Starten Sie Ihre Bibliothek: Die ersten Schritte

Schritt 1: Erstellen des Projekts mit Poetry

Da wir nun Python und Poetry installiert haben, ist es an der Zeit, unser Rechnerprojekt zu starten. Poetry macht es einfach, mit einem einfachen Befehl ein neues Projekt zu erstellen.

Navigieren Sie zu dem Verzeichnis, in dem Sie Ihr Projekt erstellen möchten, und führen Sie den folgenden Befehl im Terminal aus:

poetry new calculator
cd calculator

Dieser Befehl erstellt für Sie eine neue Projektstruktur, die wichtige Ordner und Dateien enthält.

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

Lassen Sie uns die generierte Struktur verstehen:

• README.md: Eine Dokumentationsdatei zur Beschreibung Ihres Projekts.
• Rechner/: Ein Ordner, der den Quellcode Ihrer Anwendung enthält.
• tests/: Ein Ordner für Ihre Unit-Tests.
• pyproject.toml: Die Hauptkonfigurationsdatei für Poetry.

Schritt 2: Implementierung der Rechnerfunktionen

Jetzt erstellen wir die Taschenrechnerfunktionen in der Datei Calculator/calculator.py.

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

Öffnen Sie die Datei „calculator.py“ und implementieren Sie die grundlegenden Taschenrechnerfunktionen:

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

Schritt 3: Testen der Rechnerfunktionen

Tests sind unerlässlich, um die Softwarequalität zu gewährleisten und Zuverlässigkeit bei der Fehlerbehebung und Codeentwicklung zu gewährleisten. In diesem Beispiel verwenden wir Unit-Tests, um unsere Taschenrechnerfunktionen zu validieren. Lassen Sie uns die Testumgebung einrichten und einige Testfälle schreiben, um sicherzustellen, dass die mathematischen Operationen korrekt funktionieren.

Konfigurieren der Testumgebung

Fügen Sie zunächst Pytest als Entwicklungsabhängigkeit hinzu:

poetry add --dev pytest

Erstellen Sie nun eine Datei namens test_calculator.py im Testordner:

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)

Por fim, basta executar os testes com o seguinte comando:

poetry run pytest

Passo 4: Publicando no GitHub

Agora que nossa aplicação já está coberta com testes, vamos prepará-la para ser compartilhada no GitHub. Siga os passos abaixo para adicionar seu projeto ao GitHub:

1. Crie um repositório no GitHub: Vá para o GitHub e crie um novo repositório para sua calculadora.

2. Adicione seu projeto ao repositório:

• Inicialize o repositório Git dentro do diretório do seu projeto se ainda não estiver inicializado:

git init

• Adicione todos os arquivos ao Git e faça o primeiro commit:

git add .
git commit -m "Initial commit"

• Conecte seu repositório local ao repositório remoto no GitHub:

git remote add origin <URL_DO_SEU_REPOSITORIO_GITHUB>

• Envie seus arquivos para o GitHub:

git push -u origin main

Agora seu projeto está no GitHub e pronto para ser compartilhado e colaborado com outros desenvolvedores.

Passo 5: Instalando via Pip ou Poetry

Para instalar sua biblioteca diretamente basta usar os seguintes comandos:

• Via Pip:

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

• Via Poetry:

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

O que vem a seguir?

Nesta primeira parte do tutorial, cobrimos os fundamentos essenciais para criar uma biblioteca Python utilizando o Poetry. Começamos configurando o ambiente de desenvolvimento, implementamos uma calculadora básica com testes unitários usando pytest, e compartilhamos o projeto no GitHub para colaboração.

Na próxima parte deste tutorial, exploraremos como publicar sua biblioteca no PyPI, o repositório padrão de pacotes Python, e aprenderemos como instalá-la usando o Poetry ou pip diretamente do PyPI. Isso não apenas facilitará o uso da sua biblioteca por outros desenvolvedores, mas também ajudará a integrá-la com a comunidade Python.

Parabéns por chegar até aqui! Espero que esteja aproveitando a criação da sua biblioteca Python. Fique à vontade para compartilhar dúvidas ou sugestões nos comentários. Vamos agora para a Parte II e continuar nossa jornada de colaboração com a comunidade Python.

Referências

• Canal Eduardo Mendes (@Dunossauro) Criando um pacote python do zero: dos requisitos ao deploy
• Documentação Poetry
• Poetry: construindo pacotes Python de uma forma fácil

Das obige ist der detaillierte Inhalt vonSchritt für Schritt: Erstellen Sie Ihre erste Python-Bibliothek mit Poetry (Teil I). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!