Pytestでパラメーター化テストを行う

プログラミング

2026.02.27

Pytestにおけるパラメーター化テスト

Pytestにおけるパラメーター化テスト

Pytestは、Pythonのテストフレームワークとして広く利用されており、その強力な機能の一つに「パラメーター化テスト」があります。パラメーター化テストとは、同じテストロジックを異なる入力値の組み合わせで繰り返し実行する手法です。これにより、テストコードの重複を減らし、網羅性の高いテストを効率的に記述することが可能になります。

パラメーター化テストの基本

Pytestでパラメーター化テストを実現するには、主に@pytest.mark.parametrizeデコレーターを使用します。このデコレーターは、テスト関数に適用され、テストケースを生成するための引数と、それに対応する値のリストを指定します。

@pytest.mark.parametrizeの基本構文

@pytest.mark.parametrize(argnames, argvalues)

argnames: テスト関数に渡される引数名の文字列。複数の引数がある場合はカンマで区切ります。
argvalues: 各テストケースに対応する引数の値のリスト。リストの各要素は、argnamesで指定された引数の順序に対応するタプルまたはリストになります。

簡単な例

例えば、2つの数値を加算する関数のテストを考えます。


import pytest

def add(a, b):
    return a + b

@pytest.mark.parametrize("a, b, expected", [
    (1, 2, 3),
    (0, 0, 0),
    (-1, 1, 0),
    (5, -3, 2),
])
def test_add(a, b, expected):
    assert add(a, b) == expected

この例では、test_add関数が4つの異なる引数の組み合わせで実行されます。それぞれの組み合わせは、(a, b, expected)というタプルとしてargvaluesリストに定義されています。Pytestはこれらのタプルを順番に取り出し、test_add関数を呼び出します。

パラメーター化テストの高度な利用方法

引数名の指定方法

argnamesで指定する引数名は、テスト関数で実際に使用される引数名と一致させる必要があります。文字列としてカンマ区切りで指定する以外にも、リスト形式で指定することも可能です。


@pytest.mark.parametrize(["x", "y"], [(1, 2), (3, 4)])
def test_foo(x, y):
    assert x + y == 5 # このテストは(1,2)のケースで失敗する

値の指定方法

argvaluesには、タプルのリストだけでなく、辞書のリストを指定することもできます。辞書形式で指定すると、引数名と値の対応が明確になり、コードの可読性が向上します。


@pytest.mark.parametrize("num, expected_type", [
    (10, int),
    (3.14, float),
    ("hello", str),
])
def test_type_checking(num, expected_type):
    assert isinstance(num, expected_type)

さらに、ids引数を使用することで、各テストケースに分かりやすい識別子を付けることができます。これは、テスト結果のレポートなどでどのテストケースが失敗したかを特定するのに役立ちます。


@pytest.mark.parametrize("x, y, expected", [
    (1, 1, 2),
    (2, 2, 4),
], ids=["case_one", "case_two"])
def test_simple_addition(x, y, expected):
    assert x + y == expected

複数の@pytest.mark.parametrizeデコレーター

1つのテスト関数に複数の@pytest.mark.parametrizeデコレーターを適用することも可能です。この場合、Pytestはデコレーターの全ての組み合わせに対してテストケースを生成します。


@pytest.mark.parametrize("x", [1, 2])
@pytest.mark.parametrize("y", [3, 4])
def test_combinations(x, y):
    print(f"Testing with x={x}, y={y}")
    assert x + y > 3

この例では、xが1または2、yが3または4なので、合計4つのテストケースが実行されます。

テストクラスでのパラメーター化

テストクラスのメソッドに対しても@pytest.mark.parametrizeデコレーターを使用できます。この場合、クラスのインスタンス化とメソッドの呼び出しが、指定されたパラメーターの組み合わせごとに繰り返されます。


class TestCalculator:
    @pytest.mark.parametrize("a, b, result", [
        (10, 5, 2),
        (20, 4, 5),
    ])
    def test_division(self, a, b, result):
        assert a / b == result

パラメーター化テストのメリットと考慮事項

メリット

コードの簡潔性: 同じテストロジックを繰り返し書く必要がなくなり、テストコードがスッキリします。
網羅性の向上: 様々な入力値の組み合わせを容易にテストできるため、潜在的なバグを見つけやすくなります。
保守性の向上: テストロジックの修正が必要になった場合、1箇所を修正するだけで全てのパラメーター化されたテストに反映されます。
可読性の向上: ids引数などを用いることで、テストケースの意図が伝わりやすくなります。

考慮事項

テストケースの数: パラメーターの組み合わせが多くなると、テストケースの総数も指数関数的に増加する可能性があります。実行時間の増加に注意が必要です。
デバッグの複雑さ: 多数のパラメーター化されたテストが失敗した場合、どのケースで何が問題だったのかを特定するのに時間がかかることがあります。idsや効果的なアサーションメッセージが重要になります。
テストデータの管理: 大量のテストデータを持つ場合、それらをどこにどのように配置し、管理するかが課題となることがあります。外部ファイル（CSV、JSONなど）からの読み込みも検討できます。

テストデータの外部化

テストケースが増加し、テストデータが複雑になるにつれて、コード内に直接記述するのが困難になる場合があります。このような場合、テストデータを外部ファイル（JSON、YAML、CSVなど）に保存し、Pytestのフィクスチャやカスタムプラグインなどを利用して読み込む方法が有効です。

例えば、JSONファイルからテストデータを読み込む例を考えます。


# data.json
[
    {"input_string": "abc", "expected_length": 3},
    {"input_string": "", "expected_length": 0},
    {"input_string": "12345", "expected_length": 5}
]


import pytest
import json

def get_string_length(s):
    return len(s)

def load_test_data(filename):
    with open(filename, 'r') as f:
        return json.load(f)

test_data = load_test_data("data.json")

@pytest.mark.parametrize("data", test_data, ids=[item["input_string"] for item in test_data])
def test_string_length(data):
    input_string = data["input_string"]
    expected_length = data["expected_length"]
    assert get_string_length(input_string) == expected_length

このように、テストデータを外部化することで、コードの可読性を保ちつつ、大量のテストケースを効率的に管理できます。

まとめ

Pytestのパラメーター化テストは、@pytest.mark.parametrizeデコレーターを用いることで、同じテストロジックを様々な入力値で柔軟に実行できる強力な機能です。コードの重複を排除し、テストの網羅性と保守性を高めるために不可欠なテクニックと言えます。テストケースの増加に伴う実行時間やデバッグの複雑さといった考慮事項もありますが、テストデータの外部化などの手法を組み合わせることで、より効果的に活用することが可能です。Pytestでテストを記述する際には、積極的にパラメーター化テストの導入を検討することをお勧めします。