初めての 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)

最後に、次のコマンドを使用してテストを実行します:

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経由:

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

• 詩経由:

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

次はなにかな？

チュートリアルのこの最初の部分では、Poetry を使用して Python ライブラリを作成するための重要な基礎について説明します。私たちは開発環境をセットアップすることから始め、pytest を使用して単体テストを含む基本的な計算機を実装し、共同作業のために GitHub でプロジェクトを共有しました。

このチュートリアルの次のパートでは、標準の Python パッケージ リポジトリである PyPI にライブラリを公開する方法と、PyPI から直接 Poetry または pip を使用してライブラリをインストールする方法を学びます。これにより、他の開発者がライブラリを使いやすくなるだけでなく、Python コミュニティとの統合にも役立ちます。

ここまで到達おめでとうございます! Python ライブラリの作成を楽しんでいただければ幸いです。コメントで質問や提案をお気軽に共有してください。それではパート II に進み、Python コミュニティとのコラボレーションの旅を続けましょう。

参考文献

• Canal Eduardo Mendes (@Dunossauro) Python パッケージを最初から作成する: 要件からデプロイメントまで
• 詩のドキュメント
• 詩: Python パッケージを簡単に構築する