pytest

このスキルを使う場面

ユーザーが次のことを希望する場合は、このスキルを使用してください。

• pytest で Python のユニットテストを作成して実行する
• テストのセットアップ、ティアダウン、依存性注入にフィクスチャを使用する
• テストをパラメーター化して、複数の入力セットで実行する
• pytest-mock または unittest.mock で依存関係をモックする
• pytest.ini、pyproject.toml、または conftest.py で pytest を設定する
• pytest-cov でカバレッジレポートを生成する
• pytest-xdist でテストを並列実行する

このスキルの使い方

ワークフロー

1. test_ プレフィックスを付けたテスト関数、または Test クラスを作成します
2. conftest.py のフィクスチャを使用して、共通のセットアップと依存性注入を行います
3. 必要に応じてマーカーやフィルターを適用し、pytest CLI でテストを実行します
4. カバレッジプラグインとレポートプラグインで結果を分析します

1. 基本的なテスト

def test_addition():
    assert 1 + 1 == 2

def test_string_upper():
    assert "hello".upper() == "HELLO"

2. フィクスチャ

import pytest

@pytest.fixture
def sample_user():
    return {"name": "Alice", "email": "[email protected]"}

def test_user_name(sample_user):
    assert sample_user["name"] == "Alice"

@pytest.fixture(autouse=True)
def reset_database(db):
    db.clear()
    yield
    db.clear()

3. パラメーター化

import pytest

@pytest.mark.parametrize("input,expected", [
    ("hello", 5),
    ("", 0),
    ("pytest", 6),
])
def test_string_length(input, expected):
    assert len(input) == expected

4. モック

def test_api_call(mocker):
    mock_get = mocker.patch("requests.get")
    mock_get.return_value.json.return_value = {"status": "ok"}

    result = fetch_status()
    assert result == "ok"
    mock_get.assert_called_once()

5. テストの実行

# Run all tests
pytest

# Verbose with pattern filter
pytest -v -k "test_user"

# With coverage
pytest --cov=mypackage --cov-report=html

# Parallel execution
pytest -n auto

ベストプラクティス

• テスト間で変更可能な状態を共有せず、フィクスチャを使ってセットアップとティアダウンを行い、テストを独立させます
• 期待される動作が伝わる、明確で説明的なテスト名を付けます
• テストの実行順序に依存しないようにします。共通のフィクスチャには conftest.py を使用します
• CI でテストスイート全体を実行します。カバレッジには --cov を使用し、早期に失敗させるには --maxfail=1 を使用します
• マーカー（@pytest.mark.slow）でテストを分類し、対象を絞って実行します

リソース

• 公式ドキュメント：https://docs.pytest.org/
• pytest-cov：https://pytest-cov.readthedocs.io/
• pytest-xdist：https://github.com/pytest-dev/pytest-xdist

キーワード

pytest、Python テスト、フィクスチャ、パラメーター化、モック、conftest、カバレッジ、pytest-cov、pytest-xdist、ユニットテスト、マーカー