ステップバイステップ: 詩を使った最初の Python ライブラリの作成 (パート I)

初めての Python ライブラリを作成する方法を学びましょう!この一連の投稿では、Poetry を使用して Python ライブラリを作成および公開するプロセスについて説明します。まずは小さな電卓アプリケーションの構築から始めましょう。初期構成から実装、基本機能のテストまですべてをカバーします。このシリーズの最後には、PyPI で世界と共有できるライブラリが完成します。

詩とは何ですか？

Poetry は、Python プロジェクトの依存関係管理およびパッケージ化ツールです。従来は複数のツールが必要だった多くのタスクを自動化することで、ライブラリとアプリケーションの作成と保守のプロセスを簡素化します。 Poetry には、プロジェクトを決定的に管理するために必要なすべてのツールが付属しています。詩の主な利点をいくつか紹介します:

• プロジェクトのビルド: 1 つのコマンドでプロジェクトを簡単にビルドしてパッケージ化します。
• 作品を共有する: PyPI で公開して自分の作品を知らせます。
• 依存関係のステータスを確認する: 1 つのコマンドでプロジェクトの依存関係を表示します。
• 依存関係解決: Poetry には徹底的な依存関係解決機能が付属しており、解決策が存在する場合は常に解決策を見つけます。
• 分離: Poetry は、構成された仮想環境を使用するか、独自の仮想環境を作成してシステムから常に隔離されます。
• 直感的な CLI: Poetry コマンドは直感的で使いやすく、適切なデフォルト設定があり、さらに構成可能です。

これらの利点により、Poetry は Python プロジェクトを開発するための強力かつ効率的なツールとして際立っています。

Python ライブラリを開始する前に何が必要ですか?

コードを書き始める前に、開発環境をセットアップする必要があります。すべての準備が整っていることを確認する手順は次のとおりです:

Pythonのバージョンを確認する

まず、最新バージョンの Python がインストールされていることを確認する必要があります。システムにインストールされている Python のバージョンを確認するには、ターミナルで次のコマンドを実行します。

python --version

Python をまだインストールしていない場合、または更新する必要がある場合は、Python の公式 Web サイトからダウンロードしてインストールできます。

詩をインストールする

最新バージョンの Python がインストールされていることを確認したら、次のステップは Poetry をインストールすることです。公式ドキュメントに詳しく記載されている手順に従って、Poetry をインストールできます。インストール用の簡単なコマンドは次のとおりです:

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

ライブラリの開始: 最初のステップ

ステップ 1: 詩を使用したプロジェクトの作成

Python と Poetry がインストールされたので、電卓プロジェクトを開始します。 Poetry を使用すると、簡単なコマンドで新しいプロジェクトを簡単に作成できます。

プロジェクトを作成するディレクトリに移動し、ターミナルで次のコマンドを実行します。

poetry new calculator
cd calculator

このコマンドは、必須のフォルダーとファイルを含む新しいプロジェクト構造を作成します。

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

生成された構造を理解しましょう:

• README.md: プロジェクトについて説明するドキュメント ファイル。
• calculator/: アプリケーションのソース コードが含まれるフォルダー。
• 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

次に、tests フォルダー内に 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)

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

以上がステップバイステップ: 詩を使った最初の Python ライブラリの作成 (パート I)の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。