テストが面倒だと感じてテストの作成を避けてきた場合は、この pytest チュートリアル を読んで考えを変える必要があります。 Pytest は儀式の大部分を削除します。継承するクラスや覚えておくべき特別なアサーション メソッドはありません。テストはわずか 2 行で済みます。

小さなショッピング カートを作成し、段階的にテストします。すべてを Python 3.13 と pytest 9.2 で実行しました。表示されている出力は実際のものですが、お使いのマシンでは異なるファイル パスとタイミングの詳細はトリミングされています。

なぜpytestなのか?

Python には unittest が同梱されており、これでうまく機能しますが、通常は pytest の方が便利です。それぞれの同じチェックを次に示します。

Pytest は既存の unittest テストも実行できるため、段階的に切り替えることができます。また、カバレッジ用の pytest-cov や並列実行用の pytest-xdist など、大規模なプラグイン エコシステムもあります。

pytestをインストールする

Python 仮想環境チュートリアル で説明されているように、まず仮想環境を作成してからインストールします。

pip install pytest
pytest --version

# pytest 9.2.0

cart.pyとtest_cart.pyの2つのファイルを含むプロジェクトフォルダーを作成します。 Pytest は、test_*.py または *_test.py という名前のファイル、test で始まる関数、Test で始まるクラスという命名規則に従ってテストを自動的に検索します。テストが選択されない場合は、最初に名前の不一致を確認する必要があります。

テストするコード

# cart.py
class Cart:
    def __init__(self):
        self.items = []

    def add(self, name, price, qty=1):
        if qty < 1:
            raise ValueError("qty must be at least 1")
        self.items.append((name, price, qty))

    def total(self, discount=0):
        subtotal = sum(price * qty for _, price, qty in self.items)
        return round(subtotal * (1 - discount / 100), 2)

最初のテスト

# test_cart.py
from cart import Cart

def test_empty_cart_is_free():
    assert Cart().total() == 0

それは完全なテストです。プロジェクト フォルダーから pytest を実行すると、1 つのテストに合格したことが報告されます。インポート エラーが発生した場合は、python -m pytest として実行すると、現在のフォルダーがインポート パスに追加されます。

読み取り失敗

ここが pytest の真価を発揮するところです。以下は、意図的に間違った期待値を使用したテストです。

def test_wrong_total():
    c = Cart()
    c.add("Keyboard", 1500)
    assert c.total() == 1400

そして、これを実行すると次のように出力されました。

    def test_wrong_total():
        c = Cart()
        c.add("Keyboard", 1500)
>       assert c.total() == 1400
E       assert 1500.0 == 1400
E        +  where 1500.0 = total()

FAILED fail_example.py::test_wrong_total - assert 1500.0 == 1400
============================== 1 failed in 0.12s ==============================

> は失敗した行を示し、E の行は実際の値を示します。 pytest は assert ステートメントを書き換えて、比較内容をレポートできるようにするため、カスタム メッセージを追加する必要はありません。リストや辞書に対しても同様のことが行われ、どの項目が異なるかを正確に指摘します。

テストの例外

エラー処理も動作であるため、テストする価値があります。 pytest.raises は、ブロックが予想される例外を発生させた場合にのみ合格します。

import pytest

def test_rejects_zero_qty():
    with pytest.raises(ValueError, match="at least 1"):
        Cart().add("Pen", 10, qty=0)

オプションの match 引数は正規表現を使用してメッセージをチェックするため、別の ValueError が誤って渡されることはありません。このようなエラーを発生させて処理する方法については、Python 例外処理 のガイドをご覧ください。

備品: 再利用可能なセットアップ

ほとんどのテストでは、最初に何かを準備する必要があります。 フィクスチャはそれを提供する関数です。これを @pytest.fixture で修飾すると、それを引数として指定するテストは結果を受け取ります。

@pytest.fixture
def cart():
    c = Cart()
    c.add("Keyboard", 1500)
    c.add("Mouse", 500, qty=2)
    return c

def test_total(cart):
    assert cart.total() == 2500

各テストはデフォルトで新しいカートを取得するため、テストが相互に影響を与えることはありません。 Pytest は引数名をフィクスチャの名前と照合します。また、フィクスチャを自分で呼び出すことはありません。 @pytest.fixture はデコレータであり、Python デコレータの説明で説明します。

収量を伴うクリーンアップ

後片付けが必要な場合は、return の代わりに yield を使用してください。 yield 以降のコードは、テストが失敗した場合でも、テスト終了時に実行されます。

@pytest.fixture
def temp_db():
    print("\nopen db")
    yield {"users": []}
    print("close db")

def test_db(temp_db):
    assert temp_db["users"] == []

-s を実行して印刷出力を表示すると、注文がオープン、テスト、そしてクローズされたことが確認されました。

フィクスチャスコープとconftest.py

デフォルトでは、フィクスチャはテストごとに 1 回実行されます。データベースやブラウザなどの高価なセットアップの場合は、scope を使用してその有効期間を変更します。

複数のファイルで使用されるフィクスチャを conftest.py というファイルに置きます。 Pytest はそれを自動的にロードするため、テストはインポートせずにそのフィクスチャを使用できます。ただし、あるテストで行われた変更が次のテストに漏洩する可能性があるため、共有スコープには注意してください。

パラメータ化: 1 つのテスト、多数の入力

各値のテストをコピーするのではなく、ケースをリストします。

@pytest.mark.parametrize("discount, expected", [
    (0, 2500),
    (10, 2250),
    (100, 0),
])
def test_discount(cart, discount, expected):
    assert cart.total(discount) == expected

各行は独自のテストとなり、完全なファイルを実行したときの詳細な出力でこれを確認できます。

test_cart.py::test_total PASSED                        [ 16%]
test_cart.py::test_discount[0-2500] PASSED             [ 33%]
test_cart.py::test_discount[10-2250] PASSED            [ 50%]
test_cart.py::test_discount[100-0] PASSED              [ 66%]
test_cart.py::test_rejects_zero_qty PASSED             [ 83%]
test_cart.py::test_empty_cart_is_free PASSED           [100%]

============================== 6 passed in 0.05s ==============================

1 つの行が失敗しても、他の行は引き続き実行され、名前によって問題の原因となった値が正確にわかります。 parametrize と cart フィクスチャを組み合わせていることに注目してください。バグが見つかる可能性が高い値を選択するには、境界値分析を使用します。

便利な内蔵器具

Pytest には、既製のフィクスチャがいくつか含まれています。これら 2 つは特に便利で、今回の実行では両方とも合格しました。

def test_write_report(tmp_path):
    report = tmp_path / "report.txt"
    report.write_text("passed")
    assert report.read_text() == "passed"

def read_mode():
    return os.environ.get("APP_MODE", "dev")

def test_mode(monkeypatch):
    monkeypatch.setenv("APP_MODE", "staging")
    assert read_mode() == "staging"

tmp_path では、各テストに固有の一時フォルダーが与えられるため、テストが実際のファイルに触れることがありません。 monkeypatch 環境変数または属性を変更し、テスト終了時に変更を元に戻します。もう 1 つの便利な機能は capsys で、印刷出力をキャプチャして確認できるようにします。

マーカー: スキップおよび xfail

マーカーはテストにラベルと動作を追加します。

@pytest.mark.skip(reason="payment sandbox is down")
def test_payment():
    assert False

@pytest.mark.xfail(reason="floating point")
def test_rounding():
    assert 0.1 + 0.2 == 0.3

skip はテストをまったく実行しません。 xfail は実行しますが、失敗が予想されるため、既知の問題によってビルドが中断されることはありません。同じファイル内の他の追加のテストを使用して、実行結果を 3 passed, 1 skipped, 1 xfailed として要約します。ちなみに、この丸めテストは実際に失敗します。浮動小数点演算では、0.1 + 0.2 は正確に 0.3 にはなりません。小数を比較する場合は pytest.approx(0.3) を使用します。

@pytest.mark.slow などの独自のマーカーを作成し、pytest -m slow でマーカーのみを実行したり、-m "not slow" でマーカーを省略したりすることもできます。警告を回避するには、構成ファイルにカスタム マーカーを登録します。

便利なコマンドラインフラグ

CI で pytest を実行する

テストは、変更のたびに自動的に実行される場合に最も価値があります。最小限の GitHub Actions ジョブは次のようになります。

steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-python@v5
    with:
      python-version: "3.13"
  - run: pip install -r requirements.txt
  - run: python -m pytest

テストが失敗すると、Pytest はゼロ以外のコードで終了し、パイプラインが停止します。このワークフロー ファイルは実行しませんでしたので、プロジェクトに合わせて調整してください。 GitHub Actions CI/CD ガイドで詳細が説明されています。 Selenium Python チュートリアルとページ オブジェクト モデル チュートリアルが示すように、Pytest はブラウザ テストにも適しています。

まとめ

これで、ほとんどの Python テスト スイートに必要なものが手に入りました。プレーンなアサート、セットアップ用のフィクスチャ、バリエーション用のパラメータ化、および速度用のいくつかのフラグです。小さなことから始めましょう。最近バグを修正した関数を 1 つ選択し、最初にそのバグのテストを作成します。各レベルで何をテストすればよいかわからない場合は、単体テストと統合テストについてお読みください。

よくある質問

学び続ける