Étape par étape : créer votre première bibliothèque Python avec de la poésie (partie I)

Apprenez à créer votre première bibliothèque Python ! Dans cette série d'articles, nous vous guiderons tout au long du processus de création et de publication d'une bibliothèque Python à l'aide de Poetry. Commençons par créer une petite application de calcul, couvrant tout, de la configuration initiale à la mise en œuvre et au test des fonctions de base. À la fin de cette série, votre bibliothèque sera prête à être partagée avec le monde sur PyPI.

Qu’est-ce que la poésie ?

Poetry est un outil de gestion des dépendances et de packaging pour les projets Python. Il simplifie le processus de création et de maintenance des bibliothèques et des applications en automatisant de nombreuses tâches qui nécessitent traditionnellement plusieurs outils. La poésie est livrée avec tous les outils dont vous pourriez avoir besoin pour gérer vos projets de manière déterministe. Voici quelques-uns des principaux avantages de la poésie :

• Construire des projets : Créez et emballez facilement vos projets avec une seule commande.
• Partagez votre travail : Faites connaître votre travail en le publiant sur PyPI.
• Vérifiez l'état de vos dépendances : obtenez une vue des dépendances de votre projet avec une seule commande.
• Résolution des dépendances : La poésie est livrée avec un résolveur de dépendances exhaustif, qui trouvera toujours une solution si elle existe.
• Isolement : La poésie utilise des environnements virtuels configurés ou crée les siens pour toujours être isolée de votre système.
• CLI intuitive : les commandes de poésie sont intuitives et faciles à utiliser, avec des valeurs par défaut sensibles, mais configurables.

Avec ces avantages, Poetry s'impose comme un outil puissant et efficace pour développer des projets Python.

De quoi avons-nous besoin avant de démarrer notre bibliothèque Python ?

Avant de commencer à écrire du code, nous devons configurer notre environnement de développement. Voici les étapes pour vous assurer que tout est prêt :

Vérifier la version de Python

Tout d’abord, nous devons nous assurer que vous disposez de la dernière version de Python installée. Pour vérifier la version de Python installée sur votre système, exécutez la commande suivante dans le terminal :

python --version

Si Python n'est pas déjà installé ou si vous avez besoin de le mettre à jour, vous pouvez le télécharger et l'installer à partir du site Web officiel de Python.

Installer la poésie

Après vous être assuré que la dernière version de Python est installée, l'étape suivante consiste à installer Poetry. Vous pouvez installer Poetry en suivant les instructions détaillées dans la documentation officielle. Voici une commande rapide pour l'installation :

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

Démarrer votre bibliothèque : les premières étapes

Étape 1 : Créer le projet avec Poésie

Maintenant que Python et Poetry sont installés, il est temps de démarrer notre projet de calculatrice. La poésie facilite la création d'un nouveau projet avec une simple commande.

Naviguez jusqu'au répertoire dans lequel vous souhaitez créer votre projet et exécutez la commande suivante dans le terminal :

poetry new calculator
cd calculator

Cette commande crée pour vous une nouvelle structure de projet, qui comprend les dossiers et fichiers essentiels.

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

Comprenons la structure générée :

• README.md : Un fichier de documentation pour décrire votre projet.
• calculatrice/ : Un dossier qui contient le code source de votre application.
• tests/ : Un dossier pour vos tests unitaires.
• pyproject.toml : Le fichier de configuration principal de Poetry.

Étape 2 : Implémentation des fonctions de la calculatrice

Créons maintenant les fonctions de calculatrice dans le fichier calculator/calculator.py.

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

Ouvrez le fichier calculator.py et implémentez les fonctions de base de la calculatrice :

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

Étape 3 : tester les fonctions de la calculatrice

Les tests sont essentiels pour garantir la qualité des logiciels, garantissant la fiabilité des corrections de bugs et de l'évolution du code. Dans cet exemple, nous utiliserons des tests unitaires pour valider les fonctions de notre calculatrice. Configurons l'environnement de test et écrivons quelques cas de test pour nous assurer que les opérations mathématiques fonctionnent correctement.

Configuration de l'environnement de test

Commencez par ajouter pytest comme dépendance de développement :

poetry add --dev pytest

Maintenant, créez un fichier appelé test_calculator.py dans le dossier tests :

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

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!