pytest

スキル：pytest

フィクスチャ、パラメーター化、プラグインなど、pytest でテストを作成・整理する際のベストプラクティスです。

使用する場面

フィクスチャ、パラメーター化、マーカー、プラグイン、テスト構成など、pytest でテストを作成・整理するときにこのスキルを適用してください。

テストの整理

• ソースの構成に対応するように、テストを tests/ ディレクトリに配置します。
• テストファイルには test_<module>.py、テスト関数には test_<behavior>() という名前を付けます。
• 共通のフィクスチャやセットアップがある場合に限り、関連するテストをクラスにまとめます。

フィクスチャ

• 必要な最小のスコープ（function > class > module > session）でフィクスチャを定義します。
• 共有フィクスチャには conftest.py を使い、適切なディレクトリ階層に配置します。
• 複雑なフィクスチャの継承よりも、ファクトリーフィクスチャを優先します。
• セットアップとティアダウンには yield フィクスチャを使い、tempfile よりも tmp_path を優先します。

パラメーター化

• 複数の入力を使ったデータ駆動テストには @pytest.mark.parametrize を使います。
• テスト結果を読みやすくするため、テスト ID（ids=...）を付けます。
• フィクスチャと parametrize を組み合わせて、直積のテストを行います。

アサーション

• 通常の assert 文を使います。pytest が書き換えるため、失敗時のメッセージが明確になります。
• 例外のテストには pytest.raises(ExceptionType, match=...) を使います。
• 浮動小数点数の比較には pytest.approx() を使います。

プラグイン

• よく使われるプラグイン：pytest-cov、pytest-mock、pytest-asyncio、pytest-xdist、pytest-timeout。
• 生の unittest.mock.patch よりも、pytest-mock の mocker フィクスチャを使います。

注意点

• 可変状態には session スコープのフィクスチャを使わないでください。
• 実装の詳細ではなく、観察可能な振る舞いをテストしてください。
• テスト同士の依存を避け、各テストを単独で実行できるようにしてください。