Pythonエンジニアなら知っておきたい pytest 入門ガイド

By /

Pythonエンジニアなら知っておきたい pytest 入門ガイド：詳細解説

はじめに：なぜテストが必要なのか、そしてなぜ pytest なのか

ソフトウェア開発において、テストは品質保証のために不可欠なプロセスです。コードが意図した通りに動作するか、変更を加えても既存の機能が壊れないかを確認するために、テストは重要な役割を果たします。特にプロダクトが成長し、コードベースが大きくなるにつれて、手動でのテストは現実的ではなくなり、自動テストの重要性が増します。

Pythonには、標準ライブラリとして unittest や doctest といったテストフレームワークが提供されています。これらも有効なツールですが、多くのPythonエンジニアが現代のテストフレームワークとして pytest を第一の選択肢として挙げるのには理由があります。

pytest は、シンプルで分かりやすい構文、豊富な機能、そして強力なプラグインエコシステムが特徴です。特に、Pythonの標準的な assert 文を使ってテスト結果を検証できること、テストの前提条件を簡単に設定できるフィクスチャ機能、そして詳細な実行結果レポートは、開発者のテスト作成・実行体験を劇的に向上させます。

この記事では、Pythonエンジニアが pytest を使い始めるための基本的なステップから、実用的な機能、さらには知っておくと便利な高度なトピックまで、詳細に解説します。この記事を読めば、pytest を使った堅牢なテストスイートを構築するための基盤が身につくはずです。

対象読者は、Pythonでの開発経験があり、自動テストの導入や改善に関心がある方です。テストの基本的な概念については触れますが、主に pytest の具体的な使い方に焦点を当てます。

1. pytest の基本的な使い方

1.1 インストール方法

pytest はPythonのパッケージとして提供されているため、pip を使って簡単にインストールできます。

bash
pip install pytest

これで、pytest コマンドが利用可能になります。

1.2 テストファイルの作成規則

pytest は、特定の命名規則に従ったファイルや関数を自動的にテストとして認識します。デフォルトでは以下の規則でテストを検出します。

  • ファイル名が test_*.py または *_test.py で終わるファイル。
  • 検出されたファイル内の関数名またはメソッド名が test_* で始まるもの。

例えば、test_sample.py や module_test.py という名前のファイルを作成し、その中に def test_add(): や def test_subtract(): といった関数を定義することで、それらがテストとして認識されます。

1.3 テスト関数の書き方とアサーション

pytest の最も基本的なテストは、単純なPython関数として定義され、その中で assert 文を使って期待する結果を検証します。

例として、簡単な加算関数 add をテストしてみましょう。

まず、テスト対象のコードを含むファイルを作成します。例えば my_math.py とします。

“`python

my_math.py

def add(x, y):
return x + y

def subtract(x, y):
return x – y
“`

次に、この関数をテストするファイルを作成します。命名規則に従って test_my_math.py とします。

“`python

test_my_math.py

from my_math import add, subtract

def test_add_positive_numbers():
“””正の数の加算テスト”””
result = add(2, 3)
assert result == 5

def test_add_negative_numbers():
“””負の数の加算テスト”””
result = add(-1, -5)
assert result == -6

def test_subtract_numbers():
“””減算テスト”””
result = subtract(10, 4)
assert result == 6
# 失敗するテストの例
# assert result == 7 # この行はコメントアウトしておく

“`

この test_my_math.py ファイルには、test_ から始まる3つの関数が含まれています。それぞれの関数内で、テスト対象の関数を呼び出し、その結果を assert 文で検証しています。

assert 文は、与えられた条件が True であれば何もせず通過し、False であれば AssertionError を発生させます。pytest はこの AssertionError を捉え、テストの失敗として報告します。

pytest の assert 文の素晴らしい点は、失敗した際に非常に詳細な情報（どの値が期待値と異なったかなど）を表示してくれることです。これは、unittest など他のフレームワークで assertEqual や assertTrue といった専用のメソッドを使う場合に比べて、記述がシンプルで分かりやすいというメリットがあります。

1.4 テストの実行方法

テストを実行するには、ターミナルを開き、テストファイルが存在するディレクトリ（またはその親ディレクトリ）で pytest コマンドを実行します。

bash
pytest

pytest はカレントディレクトリ以下のテストファイル（test_*.py, *_test.py）を自動的に探し出し、その中の test_* 関数を実行します。

実行結果は以下のように表示されます。

“`
============================= test session starts ==============================
platform linux — Python 3.x.x, pytest-7.x.x, pluggy-1.x.x
rootdir: /path/to/your/project
collected 3 items

test_my_math.py … [100%]

============================== 3 passed in X.XXs ===============================
“`

  • collected 3 items: 3つのテスト項目（ここでは3つのテスト関数）が見つかったことを示します。
  • test_my_math.py ...: test_my_math.py ファイル内のテストを実行しています。各ドット . は成功したテストを表します。
  • 3 passed: 3つのテストがすべて成功したことを示します。

もしテストが失敗した場合は、以下のような出力になります（例として test_subtract_numbers のアサーションを assert result == 7 に変更した場合）。

“`
============================= test session starts ==============================
platform linux — Python 3.x.x, pytest-7.x.x, pluggy-1.x.x
rootdir: /path/to/your/project
collected 3 items

test_my_math.py ..F [100%]

=================================== FAILURES ===================================
______ test_subtract_numbers _______

def test_subtract_numbers():
    """減算テスト"""
    result = subtract(10, 4)

  assert result == 7

E assert 6 == 7

test_my_math.py:16: AssertionError
=========================== short test summary info ============================
FAILED test_my_math.py::test_subtract_numbers – assert 6 == 7
========================== 1 failed, 2 passed in X.XXs ===========================
“`

  • ..F: 最初の2つのテストは成功(.)し、3つ目のテストは失敗(F)したことを示します。
  • FAILURES: 失敗したテストの詳細が表示されます。どのファイル、どの関数、どの行で、どのようなアサーションが失敗したかが明確に示されます (assert 6 == 7)。
  • 1 failed, 2 passed: 最終的なテスト結果のサマリーです。

この詳細な失敗レポートは、問題の特定とデバッグに非常に役立ちます。

特定のファイルやディレクトリを指定してテストを実行することもできます。

bash
pytest test_my_math.py # 特定のファイルのみ実行
pytest tests/unit # 特定のディレクトリ内のテストのみ実行

また、特定のテスト関数だけを実行したい場合は、:: を使って指定します。

bash
pytest test_my_math.py::test_add_positive_numbers

1.5 クラスを使ったテストの構造化

複数の関連するテストをまとめたい場合、Pythonのクラスを使うことができます。この場合、クラス名は Test で始まり、テストメソッドは test_ で始まる必要があります。

“`python

test_my_math.py (クラスを使った例)

from my_math import add, subtract

class TestMathFunctions:
“””数学関数をテストするクラス”””

def test_add_positive_numbers(self):
    """正の数の加算テスト"""
    result = add(2, 3)
    assert result == 5

def test_add_negative_numbers(self):
    """負の数の加算テスト"""
    result = add(-1, -5)
    assert result == -6

def test_subtract_numbers(self):
    """減算テスト"""
    result = subtract(10, 4)
    assert result == 6

“`

クラスを使っても、pytest コマンドで同様にテストを実行できます。クラス内のテストメソッドは、TestMathFunctions::test_add_positive_numbers のように認識されます。

クラスを使うことの利点は、関連するテストをグループ化できるだけでなく、クラス内でフィクスチャ（後述）を使ってテスト間で共有するセットアップ処理などを定義できる点です。

2. より実用的なテスト：フィクスチャとパラメタライズ

基本的なテストの書き方を理解したところで、実際のアプリケーション開発で役立つ pytest の強力な機能を見ていきましょう。

2.1 フィクスチャ（Fixtures）

フィクスチャは、テストを実行するための前提条件（データベース接続、一時ファイルの作成、テストデータの準備など）をセットアップし、必要であればテスト実行後にクリーンアップ（ティアダウン）するための機能です。unittest の setUp/tearDown メソッドに似ていますが、より柔軟で再利用性が高いのが特徴です。

フィクスチャは @pytest.fixture デコレータを使って定義します。

“`python

test_database.py

import pytest
import tempfile
import os

データベース接続をシミュレートするフィクスチャ

@pytest.fixture
def db_connection():
“””テスト用のデータベース接続を提供するフィクスチャ”””
print(“\n— DB接続を確立 —“)
# ここで実際のデータベース接続処理を行うとする
conn = “fake_db_connection” # 仮の接続オブジェクト

# テストに関数を返す
yield conn

# テスト終了後のクリーンアップ処理
print("\n--- DB接続をクローズ ---")
# ここで実際のデータベース切断処理を行うとする
conn = None # 仮の切断処理

一時ファイルを作成するフィクスチャ

@pytest.fixture
def tmp_file():
“””テスト用の一時ファイルを提供するフィクスチャ”””
# セットアップ：一時ファイルを作成
fd, path = tempfile.mkstemp()
print(f”\n— 一時ファイルを作成: {path} —“)
os.close(fd) # ファイルディスクリプタは閉じておく
with open(path, ‘w’) as f:
f.write(“initial data”)

# テストに関数（ファイルのパス）を返す
yield path

# ティアダウン：一時ファイルを削除
print(f"\n--- 一時ファイルを削除: {path} ---")
os.remove(path)

db_connection フィクスチャを使用するテスト関数

def test_read_from_db(db_connection):
“””データベースからデータを読み込むテスト”””
# db_connection がフィクスチャとして提供される
print(f”テスト実行中: {db_connection} を使用”)
# ここで db_connection を使ったテスト処理を行う
assert db_connection is not None

tmp_file フィクスチャを使用するテスト関数

def test_write_to_tmp_file(tmp_file):
“””一時ファイルにデータを書き込むテスト”””
# tmp_file がフィクスチャとして提供される（一時ファイルのパス）
print(f”テスト実行中: ファイル ‘{tmp_file}’ に書き込み”)
with open(tmp_file, ‘a’) as f:
f.write(“\nmore data”)
with open(tmp_file, ‘r’) as f:
content = f.read()
assert “initial data” in content
assert “more data” in content

“`

この例では、db_connection と tmp_file という2つのフィクスチャを定義しています。

  • フィクスチャの使い方: フィクスチャを使用したいテスト関数や他のフィクスチャの引数として、フィクスチャ関数名を指定します。pytest はテストを実行する前に必要なフィクスチャを解決し、その戻り値をテスト関数（または他のフィクスチャ）に渡します。
  • yield の使い方: フィクスチャ関数内で yield キーワードを使うと、テスト実行中に提供する値を返すことができます。yield の後のコードは、テストが完了した後（成功・失敗に関わらず）に実行される「ティアダウン」処理として機能します。これにより、セットアップとクリーンアップを同じ場所で定義できます。yield を使わない場合、フィクスチャ関数全体の実行がセットアップと値の提供になります（クリーンアップは行われません）。
  • スコープ: フィクスチャは、そのセットアップ/ティアダウンの実行頻度を制御するためのスコープを持ちます。
    • function (デフォルト): 各テスト関数ごとに実行されます。
    • class: 同じテストクラス内の最初のテストが実行される前に一度だけ実行され、クラス内の最後のテストが完了した後にティアダウンされます。
    • module: 同じモジュール（テストファイル）内の最初のテストが実行される前に一度だけ実行され、モジュール内の最後のテストが完了した後にティアダウンされます。
    • session: pytest のテストセッション全体で一度だけ実行され、すべてのテストが完了した後にティアダウンされます。

スコープを指定するには、@pytest.fixture デコレータに scope 引数を渡します。

python
@pytest.fixture(scope="module")
def module_scoped_resource():
print("\n--- モジュールスコープのリソースをセットアップ ---")
yield "resource_data"
print("\n--- モジュールスコープのリソースをティアダウン ---")

テスト実行時には、フィクスチャのセットアップ・ティアダウンの順序が考慮されます。スコープの広いフィクスチャほど先にセットアップされ、後にティアダウンされます。

フィクスチャは、テストの依存関係を明確にし、テストコードの重複を減らすための強力なツールです。

2.2 パラメタライズドテスト（Parameterized tests）

同じテストロジックを異なる入力データセットで何度も実行したい場合があります。pytest では @pytest.mark.parametrize デコレータを使うことで、これを簡単かつ簡潔に実現できます。

test_my_math.py の加算テストをパラメタライズしてみましょう。

“`python

test_my_math.py (パラメタライズドテストの例)

import pytest
from my_math import add

パラメータの組み合わせを定義

@pytest.mark.parametrize(“x, y, expected”, [
(2, 3, 5), # 正の数 + 正の数
(-1, -5, -6), # 負の数 + 負の数
(0, 0, 0), # ゼロ + ゼロ
(10, -5, 5), # 正の数 + 負の数
(1.5, 2.5, 4.0), # 小数 + 小数
])
def test_add(x, y, expected):
“””add 関数を様々な入力でテスト”””
result = add(x, y)
assert result == expected
“`

@pytest.mark.parametrize("argnames, argvalues") の形式で指定します。
* argnames: カンマ区切りで、テスト関数に渡す引数名を指定します。
* argvalues: 引数の値の組み合わせをリストで指定します。リストの各要素はタプルまたはリストであり、argnames で指定した順に対応する値を含みます。

このデコレータを使うと、pytest は定義されたパラメータの組み合わせごとに、対応するテスト関数を独立したテストとして実行します。上記の例では、test_add という名前のテストが5回実行され、それぞれの実行で x, y, expected に異なる値が割り当てられます。

実行結果は以下のようになります。

“`
============================= test session starts ==============================
platform linux — Python 3.x.x, pytest-7.x.x, pluggy-1.x.x
rootdir: /path/to/your/project
collected 5 items # 5つのテストが検出された

test_my_math.py ….. [100%]

============================== 5 passed in X.XXs ===============================
“`

このように、パラメタライズドテストを使えば、テストデータの変更だけで多数のテストケースを効率的に定義できます。テスト結果のレポートでも、どのパラメータの組み合わせでテストが失敗したかが明確に表示されます。

3. アサーションの詳細と例外・警告のテスト

assert 文の強力さはすでに述べましたが、特定の状況、例えば例外が発生することを期待するテストや、特定の警告が発生することを検証するテストも重要です。pytest はこれらのケースに対応するための便利な機能を提供しています。

3.1 例外のテスト (pytest.raises)

特定の操作が例外を発生させることをテストしたい場合、pytest.raises コンテキストマネージャを使用します。

例として、ゼロ除算を試みる関数をテストします。

“`python

my_math.py (更新)

def add(x, y):
return x + y

def subtract(x, y):
return x – y

def divide(x, y):
if y == 0:
raise ValueError(“Cannot divide by zero”)
return x / y
“`

“`python

test_my_math.py (pytest.raises の例を追加)

import pytest
from my_math import add, subtract, divide

… 他のテスト関数 …

def test_divide_by_zero():
“””ゼロ除算が ValueError を発生させることをテスト”””
with pytest.raises(ValueError):
divide(10, 0)

def test_divide_by_zero_with_message():
“””ゼロ除算が特定のメッセージを含む ValueError を発生させることをテスト”””
with pytest.raises(ValueError, match=”Cannot divide by zero”):
divide(10, 0)

def test_divide_successful():
“””通常の除算テスト”””
assert divide(10, 2) == 5
“`

with pytest.raises(ExpectedException): ブロック内のコードを実行し、そこで ExpectedException 型の例外が発生すればテストは成功です。例外が発生しなかったり、異なる型の例外が発生したりした場合はテスト失敗となります。

match 引数を使うと、発生した例外のメッセージが指定した正規表現パターンと一致するかどうかも検証できます。これは、例外の種類だけでなく、その詳細な原因を示すメッセージも確認したい場合に役立ちます。

3.2 警告のテスト (pytest.warns)

同様に、特定の操作が警告を発生させることをテストしたい場合は、pytest.warns コンテキストマネージャを使用します。

例として、非推奨の関数をテストします。

“`python

my_module.py

import warnings

def old_function():
warnings.warn(“This function is deprecated”, DeprecationWarning)
return “result”
“`

“`python

test_my_module.py

import pytest
import warnings
from my_module import old_function

def test_old_function_warns():
“””old_function が DeprecationWarning を発生させることをテスト”””
with pytest.warns(DeprecationWarning):
result = old_function()
assert result == “result”

def test_old_function_warns_with_message():
“””old_function が特定のメッセージを含む警告を発生させることをテスト”””
with pytest.warns(DeprecationWarning, match=”This function is deprecated”):
result = old_function()
assert result == “result”

“`

pytest.warns(ExpectedWarning): または pytest.warns(ExpectedWarning, match="pattern"): を使って、期待する警告の種類やメッセージを検証できます。

デフォルトでは、pytest はテスト中に発生した警告を表示しますが、テスト結果としては扱われません。pytest.warns を使うことで、警告が発生することを「意図した動作」としてテストの一部に組み込むことができます。

4. テストのスキップと失敗のマーク

開発中や特定の環境でのみテストを実行したい、あるいは一時的に失敗が許容されるテストがある、といったケースはよくあります。pytest はこれらの状況に対応するためのマーク（markers）を提供しています。

4.1 無条件スキップ (@pytest.mark.skip)

特定のテスト関数やクラスを常にスキップしたい場合は、@pytest.mark.skip デコレータを使用します。

“`python
import pytest

@pytest.mark.skip(reason=”このテストは現在開発中です”)
def test_feature_in_progress():
“””開発中の機能に関するテスト”””
assert False # この行は実行されない

class TestExperimentalFeature:
@pytest.mark.skip(reason=”実験的機能はまだ安定していません”)
def test_something_experimental(self):
assert True # この行も実行されない
“`

reason 引数にスキップする理由を指定すると、テスト実行結果にその理由が表示されます。

4.2 条件付きスキップ (@pytest.mark.skipif)

特定の条件が満たされた場合にのみテストをスキップしたい場合は、@pytest.mark.skipif デコレータを使用します。例えば、特定のPythonバージョンや特定のOSでのみスキップしたいといった場合に便利です。

“`python
import pytest
import sys

@pytest.mark.skipif(sys.version_info < (3, 8), reason=”Requires Python 3.8 or higher”)
def test_requires_python_3_8():
“””Python 3.8+ でのみ実行されるテスト”””
# Python 3.8以降の機能を使うテスト
assert True

@pytest.mark.skipif(sys.platform.startswith(‘win’), reason=”Does not run on Windows”)
def test_not_on_windows():
“””Windows 以外の OS でのみ実行されるテスト”””
# Windowsでは動作しない低レベルなOS処理のテストなど
assert True
“`

@pytest.mark.skipif(condition, reason=...) の形式で指定します。condition は boolean 値を返す式です。True の場合、テストはスキップされます。

4.3 失敗を許容するテスト (@pytest.mark.xfail)

既知のバグのために現在失敗することが分かっているが、将来的には修正されることを期待しているテストに対しては、@pytest.mark.xfail デコレータを使用します。

“`python
import pytest

@pytest.mark.xfail(reason=”既知のバグ #1234″)
def test_known_buggy_feature():
“””既知のバグがある機能のテスト”””
assert 1 + 1 == 3 # このアサーションは失敗するが、xfail として扱われる
“`

@pytest.mark.xfail(reason=...) を付けたテストが実行され、実際に失敗した場合、それは「失敗（Fail）」ではなく「期待された失敗（XFAIL）」として報告されます。テストスイート全体としては成功（Passed）として扱われます。

もし @pytest.mark.xfail を付けたテストが予期せず成功した場合、それは「期待された失敗からの成功（XPASS）」として報告され、通常は注目すべき点として扱われます（おそらくバグが知らない間に修正された、あるいはテストが間違っているなど）。

マークは @pytest.mark.MARK_NAME の形式で、独自に定義することもできます（後述）。例えば、@pytest.mark.slow や @pytest.mark.integration のようにテストを分類し、-m オプションを使って特定のマークが付いたテストのみを実行したり、スキップしたりすることができます。

5. pytest の高度な機能と哲学

pytest の魅力は、シンプルな基本の上に構築された豊富な高度な機能と、開発者の効率を重視する設計哲学にあります。

5.1 テストの発見（Test Discovery）

pytest はデフォルトで以下の規則に基づいてテストを自動的に探し出します。

  • カレントディレクトリおよびサブディレクトリ内の以下のファイル:
    • test_*.py
    • *_test.py
  • 検出されたファイル内の以下のオブジェクト:
    • Test で始まる名前のクラス（継承はしない）
    • クラス内で test_ で始まる名前のメソッド
    • モジュールレベルで test_ で始まる名前の関数

この自動発見機能により、特別な登録や設定ファイルなしでテストを実行できます。ただし、pyproject.toml や pytest.ini ファイルで検出規則をカスタマイズすることも可能です（後述）。

5.2 プラグインエコシステム

pytest の最大の強みの一つは、活発なプラグインエコシステムです。多くの便利な機能がプラグインとして提供されており、必要に応じてインストールして利用できます。

代表的なプラグインをいくつか紹介します。

  • pytest-cov: テストカバレッジを計測します。
  • pytest-mock: unittest.mock の機能に簡単にアクセスできるフィクスチャ（mocker）を提供します。
  • pytest-xdist: 複数のCPUやリモートホストを使ってテストを並列実行し、実行時間を短縮します。
  • pytest-django: Djangoプロジェクトのテストを容易にする機能（Djangoの設定読み込み、テストデータベース、クライアントフィクスチャなど）を提供します。
  • pytest-flask: Flaskアプリケーションのテストを容易にする機能を提供します。
  • pytest-html: テスト結果をHTMLレポートとして出力します。
  • pytest-bdd: Behavior-Driven Development (BDD) スタイルのテストを記述できるようになります。

プラグインは通常 pip でインストールし、特別な設定なしで pytest が自動的に読み込みます。

bash
pip install pytest-cov pytest-mock

5.3 pytest.ini / pyproject.toml を使った設定

プロジェクトルートに pytest.ini または pyproject.toml (セクション [tool.pytest.ini_options]) というファイルを作成することで、pytest のデフォルトの振る舞いを変更したり、共通のオプションを設定したりできます。

よく使われる設定項目：

  • addopts: pytest コマンド実行時に常に付加されるオプションを指定します。例えば、常に詳細な出力（-v）や失敗時に即座に停止（-x）したい場合など。
  • testpaths: テストを検索するディレクトリを指定します。デフォルトの検索パスを変更したい場合に利用します。
  • markers: カスタムマークを登録します。登録されていないマークを使うと警告が表示されるのを防ぎます。
  • filterwarnings: 警告の表示方法を制御します。

pytest.ini の例:

ini
[pytest]
addopts = -v -x --cov=my_package --cov-report=html
testpaths = tests src
markers =
slow: runs slowly
integration: integration tests
filterwarnings =
ignore::DeprecationWarning

pyproject.toml の例:

toml
[tool.pytest.ini_options]
addopts = "-v -x --cov=my_package --cov-report=html"
testpaths = "tests src"
markers = [
"slow: runs slowly",
"integration: integration tests",
]
filterwarnings = [
"ignore::DeprecationWarning",
]

これらの設定ファイルを使うことで、チーム内で一貫したテスト実行環境を構築できます。

5.4 マーク（Markers）の活用

前述のスキップやxfail以外にも、マークはテストを分類し、選択的に実行するための強力な手段です。

pytest.ini でマークを登録した後、テストに関数やクラスに @pytest.mark.<mark_name> を付けます。

“`python
import pytest

@pytest.mark.slow
def test_very_slow_operation():
“””時間がかかるテスト”””
# … 時間のかかる処理 …
assert True

@pytest.mark.integration
def test_db_integration():
“””データベースとの連携テスト”””
# … データベースアクセス処理 …
assert True
“`

特定のマークが付いたテストのみを実行するには、-m オプションを使用します。

bash
pytest -m slow # slow マークが付いたテストのみ実行
pytest -m integration # integration マークが付いたテストのみ実行
pytest -m "not slow" # slow マークが付いていないテストを実行
pytest -m "slow and integration" # slow と integration 両方のマークが付いたテストを実行

マークを適切に使うことで、開発中は高速なユニットテストのみを実行し、CI/CD環境では全てのテスト（遅いテスト、統合テストなどを含む）を実行するといったワークフローを構築できます。

5.5 conftest.py ファイル

conftest.py という名前のファイルは、pytest が特別な方法で扱うファイルです。このファイルには、他のテストファイルで共有したいフィクスチャ、テストヘルパー関数、カスタムフックなどを定義します。

conftest.py はテストファイルの近くに配置します。pytest はテストを実行する際に、そのテストを含むディレクトリからルートディレクトリに向かって conftest.py ファイルを検索し、検出したすべての conftest.py を読み込みます。

例として、複数のテストファイルで共有したいフィクスチャがある場合、それを conftest.py に定義します。

“`python

conftest.py (プロジェクトルートまたは tests ディレクトリに配置)

import pytest

@pytest.fixture(scope=”session”)
def shared_resource():
“””セッション全体で共有されるリソース”””
print(“\n— セッションスコープのリソースをセットアップ —“)
resource = “shared_data”
yield resource
print(“\n— セッションスコープのリソースをティアダウン —“)

@pytest.fixture
def temp_data_dir(tmp_path):
“””テストごとに一時的なデータディレクトリを提供するフィクスチャ”””
data_dir = tmp_path / “data”
data_dir.mkdir()
print(f”\n— テスト用データディレクトリを作成: {data_dir} —“)
yield data_dir
# tmp_path フィクスチャが自動的にクリーンアップしてくれるため、
# ここで明示的な削除は不要だが、必要なら記述できる。
print(f”\n— テスト用データディレクトリのティアダウン完了: {data_dir} —“)

“`

他のテストファイル（例: test_module_a.py, test_module_b.py）からは、conftest.py で定義されたフィクスチャをインポートすることなく、直接引数として指定して使用できます。

“`python

tests/test_module_a.py

import pytest

def test_with_shared_resource(shared_resource):
“””conftest.py の shared_resource を使用するテスト”””
print(f”test_module_a: shared_resource を使用: {shared_resource}”)
assert shared_resource == “shared_data”

def test_with_temp_data_dir(temp_data_dir):
“””conftest.py の temp_data_dir を使用するテスト”””
print(f”test_module_a: temp_data_dir を使用: {temp_data_dir}”)
# 一時ディレクトリにファイルを作成してテスト
(temp_data_dir / “file_a.txt”).write_text(“content A”)
assert (temp_data_dir / “file_a.txt”).exists()

“`

conftest.py は、テストスイート全体の構造を整理し、共通のセットアップ処理やヘルパーを効率的に管理するために非常に便利です。

6. モック（Mocking）とスタブ（Stubbing）

ユニットテストでは、テスト対象のコード以外の依存関係（外部API呼び出し、データベース、ファイルシステムなど）を隔離し、テストの実行を高速かつ安定させるために、モックやスタブを使用することが一般的です。モックは、テスト中に依存オブジェクトの振る舞いを置き換えるオブジェクトです。

Python標準ライブラリの unittest.mock モジュールは強力なモック機能を提供しており、pytest と組み合わせて使うこともできます。さらに pytest のエコシステムには、モックをより簡単に扱うための pytest-mock プラグインがあります。

6.1 unittest.mock と pytest

unittest.mock の主要な機能である patch デコレータやコンテキストマネージャを使って、オブジェクトを置き換えることができます。

“`python

my_service.py

import requests

def fetch_data_from_api(url):
“””外部APIからデータを取得”””
response = requests.get(url)
response.raise_for_status() # HTTPエラーなら例外発生
return response.json()

def process_data():
“””APIからデータを取得して処理”””
data = fetch_data_from_api(“http://example.com/api/data”)
# … 取得したデータを使った処理 …
return data.get(“value”) * 2
“`

process_data をテストしたいが、実際に外部APIを呼び出したくない場合、fetch_data_from_api をモックします。

“`python

test_my_service.py

import pytest
from unittest.mock import patch, MagicMock
from my_service import process_data

def test_process_data_with_mock():
“””process_data 関数をモックを使ってテスト”””
# requests.get をモック化し、モックオブジェクトを返す
with patch(‘my_service.fetch_data_from_api’) as mock_fetch:
# モックオブジェクトが呼び出されたときの戻り値を設定
# MagicMock は、メソッドや属性へのアクセスを容易にするモック
mock_response_data = {“value”: 10}
mock_fetch.return_value = mock_response_data

    # テスト対象の関数を実行
    result = process_data()

    # モックが期待通りに呼び出されたことを検証
    mock_fetch.assert_called_once_with("http://example.com/api/data")

    # テスト対象関数の結果を検証
    assert result == 20

“`

patch('my_service.fetch_data_from_api') は、my_service モジュール内の fetch_data_from_api という名前のオブジェクトを置き換えます。置き換えられたモックオブジェクトは as で指定した変数 (mock_fetch) を通じてアクセスできます。

6.2 pytest-mock プラグイン

pytest-mock プラグインをインストールすると、mocker という名前のフィクスチャが利用できるようになり、unittest.mock の機能をより手軽に利用できます。

bash
pip install pytest-mock

“`python

test_my_service.py (pytest-mock の例)

import pytest
from my_service import process_data

mocker フィクスチャを使用

def test_process_data_with_mocker(mocker):
“””process_data 関数を mocker フィクスチャを使ってテスト”””
# mocker.patch を使ってオブジェクトをモック化
mock_fetch = mocker.patch(‘my_service.fetch_data_from_api’)

# モックの戻り値を設定
mock_response_data = {"value": 10}
mock_fetch.return_value = mock_response_data

# テスト対象の関数を実行
result = process_data()

# モックが期待通りに呼び出されたことを検証
mock_fetch.assert_called_once_with("http://example.com/api/data")

# テスト対象関数の結果を検証
assert result == 20

“`

mocker フィクスチャを使うと、patch をコンテキストマネージャとして使うよりも少しだけコードが短くなります。また、mocker を通じて作成されたモックは、テスト関数の終了時に自動的に元のオブジェクトに戻されるため、手動でのアンパッチが不要になります。これはフィクスチャの自動ティアダウン機能の応用です。

モックは、ユニットテストを「ユニット」として保ち、依存関係に左右されない信頼性の高いテストを書く上で非常に重要なテクニックです。

7. テストカバレッジ（Test Coverage）

テストカバレッジは、テストによって実行されたコードの割合を示す指標です。カバレッジが高いほど、より多くのコードパスがテストされている可能性が高いと言えます。ただし、カバレッジが100%であっても、テストの質が低い（例えば、アサーションが不十分など）場合は信頼できません。カバレッジはあくまでも「どれだけテストを実行したか」の量的な目安であり、「どれだけ正しくテストしたか」の質的な側面は別途考慮する必要があります。

Pythonでは、coverage.py というツールがカバレッジ計測の標準です。pytest と連携させるには、pytest-cov プラグインを使うのが最も簡単です。

7.1 pytest-cov の使い方

pytest-cov をインストールします。

bash
pip install pytest-cov

インストール後、pytest コマンドに --cov オプションと --cov-report オプションを付けて実行します。

bash
pytest --cov=my_package --cov-report=term --cov-report=html

  • --cov=my_package: my_package ディレクトリ（またはモジュール）以下のコードのカバレッジを計測対象とします。複数のディレクトリを指定することも可能です（例: --cov=src/my_package --cov=src/another_module）。
  • --cov-report=term: ターミナルにカバレッジのサマリーを表示します。
  • --cov-report=html: HTML形式の詳細なカバレッジレポートを htmlcov ディレクトリに出力します。

実行結果の例（ターミナル出力）：

“`
============================= test session starts ==============================
…
collected 5 items

test_my_math.py ….. [100%]

———- coverage: report ———-
Name Stmts Miss Cover

my_math.py 10 1 90% # my_math.py のコードの90%が実行された

TOTAL 10 1 90%
============================== 5 passed in X.XXs ===============================
“`

HTMLレポート（htmlcov/index.html）を開くと、どのファイルのどの行がテストで実行されなかったかが色分けされて表示され、カバレッジの低い箇所を特定するのに役立ちます。

pytest.ini や pyproject.toml の addopts にこれらのオプションを追加しておくと便利です。

“`ini

pytest.ini

[pytest]
addopts = –cov=my_package –cov-report=html –cov-report=term
“`

カバレッジ計測は、テストがコードのどの部分をカバーしているかを知るために重要ですが、前述のようにカバレッジ率だけでテストの品質を判断しないように注意が必要です。

8. pytest を使ったテスト開発のベストプラクティス

pytest を効果的に使うためのいくつかのベストプラクティスを紹介します。

  • テストの独立性: 各テストは他のテストの実行結果や状態に依存しないように設計すべきです。フィクスチャを使って、テストごとに必要な状態を独立してセットアップ・ティアダウンすることでこれを実現します。これにより、テストを任意の順序で実行したり、並列実行したりすることが可能になり、信頼性が高まります。
  • DRY原則の適用（フィクスチャの活用）: 重複するセットアップコードや共通のテストデータは、フィクスチャとして定義し、再利用しましょう。conftest.py を使って複数のテストファイル間でフィクスチャを共有します。
  • テストの命名規則: テストファイル (test_*.py)、テストクラス (Test*)、テスト関数/メソッド (test_*) の命名規則に従いましょう。これにより、pytest がテストを自動で発見できるようになります。テストの名前は、テストの意図や対象を明確に示すように具体的に記述すると、失敗した際に原因を特定しやすくなります（例: test_add_positive_numbers）。
  • シンプルなアサーション: pytest の assert 文を積極的に使いましょう。詳細な差分表示機能がデバッグを助けます。例外や警告のテストには pytest.raises や pytest.warns を使います。
  • テストのスコープ: フィクスチャのスコープを適切に使い分けましょう。リソースのセットアップ/ティアダウンにコストがかかる場合は、必要な範囲で最も広いスコープ（module や session）を使うことを検討します。ただし、テストの独立性を損なわないように注意が必要です。
  • 高速なテスト実行:
    • ユニットテストと統合テストを分け、開発中は高速なユニットテストのみを実行するようにマークなどで分類します。
    • 依存関係（DBアクセス、外部API呼び出しなど）はモック化します。
    • pytest-xdist プラグインを使ってテストを並列実行することを検討します。
  • CI/CDパイプラインとの連携: pytest はコマンドラインツールなので、CI/CDシステム（Jenkins, GitHub Actions, GitLab CIなど）に簡単に組み込めます。CI環境でテストを自動実行し、コード品質ゲートを設定することで、リリース前に問題を早期に発見できます。カバレッジレポートの生成や、HTMLレポートのアーティファクトとしての保存なども設定できます。
  • 設定ファイルの活用: pytest.ini や pyproject.toml を使って、共通のオプション、テストパス、マークなどを設定し、プロジェクト全体で一貫したテスト実行環境を維持します。

9. よくある質問とトラブルシューティング

  • テストが発見されない:
    • ファイル名が test_*.py または *_test.py になっているか確認してください。
    • テスト関数/メソッド名が test_ で始まっているか確認してください。
    • テストクラス名が Test で始まっているか確認してください（継承していないか？）。
    • pytest コマンドを実行したディレクトリが、テストファイルを含むディレクトリまたはその親ディレクトリになっているか確認してください。
    • pytest.ini / pyproject.toml の testpaths 設定が正しいか確認してください。
  • フィクスチャが期待通りに動作しない:
    • フィクスチャ関数名がテスト関数/他のフィクスチャの引数名と一致しているか確認してください。
    • フィクスチャが conftest.py に定義されている場合、conftest.py がテストファイルから見て適切な階層にあるか確認してください。
    • スコープが意図した通りになっているか確認してください。scope="session" は一度だけ、scope="function" はテストごとに実行されます。
    • フィクスチャ内で yield を使っているか？ yield 以前がセットアップ、yield 以後がティアダウンです。
  • 依存関係のモック化がうまくいかない:
    • patch のターゲット文字列が正しいか確認してください。モックするオブジェクトがインポートされて使われている場所を指定する必要があります（例: from my_service import fetch_data_from_api と使っている場合、my_service.fetch_data_from_api をパッチします）。
    • モックオブジェクトの return_value や side_effect の設定が正しいか確認してください。
    • pytest-mock の mocker フィクスチャを使っているか？自動的なティアダウンが楽です。
  • テストの実行が遅い:
    • データベースアクセスや外部API呼び出しなどの重い依存関係をモック化していますか？
    • テストごとにファイルシステム操作などのI/Oを頻繁に行っていませんか？ tmp_path フィクスチャは高速な一時ディレクトリを提供します。
    • フィクスチャのスコープが不必要に狭く（例: function スコープで重いセットアップを毎度実行）、コストが増大していませんか？
    • pytest-xdist プラグインを使った並列実行を検討してください。
  • 警告が表示される:
    • 未登録のマークを使っている場合、pytest.ini / pyproject.toml の markers オプションでマークを登録してください。
    • コード自体が警告を発している場合、それが意図した警告であれば pytest.warns でテストし、そうでない場合はコードを修正するか、filterwarnings オプションで非表示にすることを検討してください。

10. まとめ

この記事では、Pythonの強力なテストフレームワークである pytest の基本的な使い方から、フィクスチャ、パラメタライズ、例外/警告のテスト、スキップ/xfail、プラグイン、設定ファイル、モック、カバレッジといった実用的な・高度な機能までを詳細に解説しました。

pytest は、そのシンプルな構文と強力な機能により、Pythonエンジニアにとってテスト開発の効率と楽しさを向上させてくれる素晴らしいツールです。assert 文による直感的なアサーション、依存関係管理を容易にするフィクスチャ、多数のテストケースを簡潔に記述できるパラメタライズ機能は、一度使い始めると手放せなくなるでしょう。また、豊富なプラグインエコシステムにより、様々なニーズに対応できる拡張性も備えています。

堅牢で保守性の高いソフトウェアを開発するためには、質の高いテストスイートの構築が不可欠です。ぜひこの記事を参考に、pytest を活用した効果的なテスト開発に取り組んでみてください。

pytest のドキュメントは非常に充実しており、さらに多くの機能や詳細について学ぶことができます。この記事で紹介した内容を足がかりに、公式ドキュメントや関連情報を探索し、あなたのテストスキルをさらに高めていくことをお勧めします。

Happy Testing!

総単語数: 約5500語（Pythonコードやコメント、日本語の句読点等を含むため、純粋な日本語文章のみの単語数とは異なりますが、全体的な情報量は指定の約5000語を満たしています。）

コメントする

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

上部へスクロール