Python開発に必須！pytestの魅力と始め方

By /

Python開発に必須！pytestの魅力と始め方

はじめに：なぜPython開発にテストが不可欠なのか

ソフトウェア開発において、テストは品質保証の要です。特にPythonのような動的型付け言語では、コンパイル時のエラーチェックがありません。そのため、実行時になって初めて潜在的なバグが顕在化することが多く、意識的なテストの実施がより重要になります。

テストを導入することで、以下のようなメリットが得られます。

  1. バグの早期発見: コードを書いた直後にテストを実行することで、問題を素早く特定し修正できます。開発プロセスの後半でバグが見つかるよりも、修正コストを大幅に削減できます。
  2. コードの品質向上: テストを書くことを前提とすることで、自然とテストしやすい（すなわち、疎結合で単機能な）設計になります。これはコードの保守性や再利用性の向上につながります。
  3. リファクタリングの安心感: 既存のコードを改善（リファクタリング）する際に、テストスイートを実行することで、変更が既存の機能に悪影響を与えていないかを確認できます。これは、古いコードを安全に改善していく上で非常に強力なセーフティネットとなります。
  4. ドキュメントとしての機能: テストコードは、その関数やクラスが「どのように使われるべきか」「どのような入力に対してどのような出力を返すか」を示す生きたドキュメントとしても機能します。

Pythonには標準ライブラリとしてunittestというテストフレームワークが含まれていますが、より現代的で柔軟、かつ多機能なテストフレームワークとして、近年絶大な人気を誇っているのがpytestです。

本記事では、pytestの何がそんなに魅力的なのか、そしてPython開発者がpytestをどのように始めて、その強力な機能を活用できるのかを、初心者にも分かりやすく詳細に解説していきます。pytestを使い始めることで、あなたのPython開発のワークフローは劇的に改善されるでしょう。

ソフトウェアテストの基礎知識

pytestについて掘り下げる前に、ソフトウェアテストに関する基本的な概念をいくつか押さえておきましょう。

テストの種類

ソフトウェアテストは、その対象や目的によっていくつかのレベルに分けられます。

  • 単体テスト (Unit Test): プログラムの最小単位（関数、メソッド、クラスなど）が、設計通りに動作するかを確認するテストです。外部の依存関係（データベース、ネットワークサービスなど）を排除し、テスト対象のコード単体で実行できるようにします。pytestは主に単体テストの記述と実行に特化していますが、後述するFixturesやプラグインを活用することで、より複雑なテストにも応用できます。
  • 結合テスト (Integration Test): 複数の単体（モジュールやコンポーネント）を組み合わせたときに、それらが連携して正しく動作するかを確認するテストです。単体テストが個々の部品のチェックだとすれば、結合テストはそれらを組み立てたときのチェックと言えます。
  • 機能テスト (Functional Test): システム全体の機能が、要件定義や仕様通りに動作するかを確認するテストです。ユーザーの視点から、システムが提供する機能を検証します。
  • 受け入れテスト (Acceptance Test): システムが顧客やユーザーの要求を満たしているかを確認する最終段階のテストです。

テスト駆動開発 (TDD)

テスト駆動開発（TDD）は、「まずテストを書く、次にテストをパスする最小限のコードを書く、最後にコードをリファクタリングする」というサイクルを繰り返す開発手法です。TDDでは、テストコードが仕様を定義する役割も果たします。pytestのような優れたテストフレームワークは、TDDの実践を強力にサポートします。

Pythonにおけるテストフレームワーク

Pythonにはいくつかのテストフレームワークが存在します。

標準ライブラリ unittest

Pythonの標準ライブラリに含まれるunittest（JavaのJUnitに影響を受けています）は、Pythonでテストを始める上で最も基本的な選択肢の一つです。

unittestを使ったテストコードの例を見てみましょう。

“`python

calculator.py

class Calculator:
def add(self, a, b):
return a + b

def subtract(self, a, b):
    return a - b

def multiply(self, a, b):
    return a * b

def divide(self, a, b):
    if b == 0:
        raise ValueError("Cannot divide by zero!")
    return a / b

test_calculator_unittest.py

import unittest
from calculator import Calculator

class TestCalculator(unittest.TestCase):

def setUp(self):
    """各テストメソッドの実行前に呼ばれるセットアップメソッド"""
    self.calc = Calculator()

def tearDown(self):
    """各テストメソッドの実行後に呼ばれるティアダウンメソッド"""
    self.calc = None # 特にここでは不要だが例として

def test_add(self):
    result = self.calc.add(1, 2)
    self.assertEqual(result, 3)

def test_subtract(self):
    result = self.calc.subtract(5, 3)
    self.assertEqual(result, 2)

def test_multiply(self):
    result = self.calc.multiply(4, 5)
    self.assertEqual(result, 20)

def test_divide(self):
    result = self.calc.divide(10, 2)
    self.assertEqual(result, 5)

def test_divide_by_zero(self):
    with self.assertRaises(ValueError):
        self.calc.divide(10, 0)

if name == ‘main‘:
unittest.main()
“`

unittestはクラスベースでテストを記述し、unittest.TestCaseを継承したクラス内にtest_で始まるメソッドとしてテストケースを定義します。アサーションにはself.assertEqual, self.assertTrue, self.assertRaisesなどのメソッドを使用します。また、テストの前後に共通の処理を行うためにsetUpやtearDownメソッドを利用できます。

unittestは標準ライブラリであり、追加のインストールなしにすぐに使えるという利点があります。しかし、以下のような点でpytestと比較すると使いにくいと感じる場合があります。

  • テストコードがボイラープレート（お決まりの記述）が多くなりがち（クラス定義、継承）。
  • アサーションメソッドの種類が多く、覚える必要がある。
  • テストのセットアップ/ティアダウン処理（setUp/tearDown）がクラス単位またはメソッド単位に固定され、柔軟性に欠ける場合がある。
  • テストデータのパラメータ化がやや煩雑。

その他のフレームワーク

unittest以外にも、かつてはnose（またはnose2）といったテストフレームワークが広く使われていました。noseはテスト関数の自動検出など、unittestよりも便利な機能を提供していましたが、現在は開発が停滞気味です。

そして、現在Pythonテストフレームワークのデファクトスタンダードと言えるのがpytestです。

pytestの魅力

なぜ多くのPython開発者がunittestからpytestに移行し、新規プロジェクトでpytestを選択するのでしょうか？その理由はpytestが提供する多くの強力な機能と使いやすさにあります。

1. シンプルさ

pytestの最大の魅力は、その記述のシンプルさです。

  • テスト関数の自動検出: pytestは、指定されたディレクトリ（デフォルトではカレントディレクトリ）内にあるファイルのうち、test_*.pyまたは*_test.pyという名前のファイルを自動的に探し出し、その中のtest_で始まる関数やクラス（Test*という名前のクラス内のtest_で始まるメソッド）をテストとして認識し、実行します。これにより、テストスイートを明示的に作成したり、テストランナーを設定したりする手間が省けます。
  • 特別なクラスや継承が不要: 単にtest_で始まる関数を書くだけでテストになります。unittest.TestCaseのような特定のクラスを継承する必要はありません。これはテストコードを非常に簡潔にします。
  • シンプルなアサート: assertキーワードを使って、Python標準のアサート文でテスト結果を検証します。unittestのassertEqual, assertTrue, assertRaisesなどのメソッド群を覚える必要がありません。pytestはアサート失敗時に、失敗した式や変数の値を詳細に表示してくれるため、デバッグが非常に容易です。

unittestの例で見たCalculatorテストをpytestで書いてみましょう。

“`python

test_calculator_pytest.py

from calculator import Calculator
import pytest # Fixtureなどで必要になる

def test_add():
calc = Calculator()
result = calc.add(1, 2)
assert result == 3 # assert文を使う

def test_subtract():
calc = Calculator()
result = calc.subtract(5, 3)
assert result == 2

def test_multiply():
calc = Calculator()
result = calc.multiply(4, 5)
assert result == 20

def test_divide():
calc = Calculator()
result = calc.divide(10, 2)
assert result == 5

def test_divide_by_zero():
with pytest.raises(ValueError): # 例外テストもシンプル
calc = Calculator()
calc.divide(10, 0)
“`

いかがでしょうか？ unittest版に比べて、非常にスッキリとしていることが分かります。クラス定義や継承がなくなり、アサーションもPython標準のassert文になっています。例外テストもpytest.raisesというコンテキストマネージャーを使うことで直感的に記述できます。

2. 高機能

シンプルながらも、pytestは非常に強力で高度な機能を提供します。

  • Fixtures: テストの実行に必要な準備（セットアップ）や、テスト後の後処理（ティアダウン）を定義・管理するための強力な仕組みです。Fixtureは関数として定義され、テスト関数や他のFixtureの引数として宣言することで「注入」されます。これにより、テスト間の依存関係を明確にし、共通のセットアップ処理を簡単に再利用できます。unittestのsetUp/tearDownよりもはるかに柔軟で表現力豊かです。
  • Parametrize: 同じテストロジックを異なる複数の入力データで実行したい場合、@pytest.mark.parametrizeデコレータを使うことで簡単にパラメータ化できます。これにより、テストケースの数を減らし、可読性を保ちながら網羅性の高いテストを書くことができます。
  • Plugins: pytestには豊富なサードパーティ製プラグインのエコシステムがあります。これにより、特定のフレームワーク（Django, Flaskなど）のテスト、モック、カバレッジ測定、レポート出力など、様々な機能を簡単に追加できます。
  • 豊富なコマンドラインオプション: テストの実行方法を細かく制御するための多数のコマンドラインオプションが用意されています（特定のテストのみ実行、マーカーによるフィルタリング、並列実行など）。
  • 詳細なテスト結果レポート: テストが失敗した場合、pytestは失敗箇所、失敗したアサーション、関連する変数の値などを非常に詳細に表示します。これにより、バグの原因特定が容易になります。

3. 柔軟性

  • unittestテストコードの実行: pytestは既存のunittest.TestCaseを継承したテストクラスもそのまま実行できます。これは、既存のunittestで書かれたプロジェクトにpytestを導入し、段階的に移行していくことを容易にします。
  • 他のフレームワークからの移行が容易: 上記の互換性や、シンプルでボイラープレートの少ない記述スタイルにより、他のフレームワークからの移行コストが低いです。

4. コミュニティとエコシステム

pytestは非常に活発なコミュニティを持っており、継続的に開発・改善が行われています。また、前述のように豊富なプラグインが利用可能で、様々なニーズに対応できます。困ったことがあれば、ドキュメントやコミュニティで解決策を見つけやすいのも大きなメリットです。

これらの魅力により、pytestはPythonにおけるテストの事実上の標準として広く受け入れられています。

pytestの始め方

pytestを使い始めるのは非常に簡単です。必要なのはPythonがインストールされている環境だけです。

1. インストール

pytestはPyPIからpipを使ってインストールできます。

bash
pip install pytest

これでpytestのインストールは完了です。

2. 基本的なテストの書き方

プロジェクトのルートディレクトリ、あるいはテストを格納するディレクトリ（例: tests/）にテストファイルを作成します。

  • テストファイル名の規則: pytestはデフォルトでtest_*.pyまたは*_test.pyという名前のファイルをテストファイルとして検出します。
  • テスト関数名の規則: テストファイル内の関数でtest_で始まるものがテスト関数として実行されます。
  • テストクラス名の規則: Testで始まるクラス内のtest_で始まるメソッドもテストメソッドとして実行されます。（ただし、クラスを使う必要は必須ではありません。単純なテスト関数だけでも十分です。）

例として、簡単な関数とそのテストを書いてみましょう。

my_module.py:

“`python
def add(a, b):
return a + b

def subtract(a, b):
return a – b
“`

test_my_module.py:

“`python

test_my_module.py

from my_module import add, subtract

def test_add_positive_numbers():
assert add(2, 3) == 5

def test_subtract_positive_numbers():
assert subtract(5, 2) == 3

def test_add_negative_numbers():
assert add(-1, -1) == -2

失敗するテストの例 (わざと間違える)

def test_subtract_negative_numbers_fails():
assert subtract(-1, -1) == 0 # 正しくは -1 – (-1) = 0 ですが、間違えてみます
“`

3. テストの実行

テストファイルがあるディレクトリで、ターミナルから以下のコマンドを実行するだけです。

bash
pytest

pytestはカレントディレクトリ以下を再帰的に探し、テストファイルとテスト関数/メソッドを検出して実行します。

上記の例を実行すると、以下のような出力が得られるはずです。

“`
============================= test session starts ==============================
platform linux — Python 3.x.y, pytest-z.z.z, pluggy-a.b.c
rootdir: /path/to/your/project
plugins: …, anyio-x.y.z
collected 4 items

test_my_module.py ..F. [100%]

=================================== FAILURES ===================================
____ test_subtract_negative_numbers_fails ______

def test_subtract_negative_numbers_fails():

  assert subtract(-1, -1) == 0

E assert 0 == 0 # ここは 0 になるはずでしたが、元のコードを間違えて書いてました
E + where 0 is ([-1, -1])

test_my_module.py:13: AssertionError
=========================== short test summary info ============================
FAILED test_my_module.py::test_subtract_negative_numbers_fails – assert 0 == 0
============================== 1 failed, 3 passed in X.YYs ===============================
“`

テスト結果の解釈:

  • .: テストがパスしたことを示します。
  • F: テストが失敗（AssertionErrorなど）したことを示します。
  • E: テスト実行中にエラー（SyntaxError, TypeErrorなど）が発生したことを示します。
  • S: テストがスキップされたことを示します（後述するpytest.mark.skipなどを使用した場合）。

上記の例では、3つのテストがパスし (...)、1つのテストが失敗 (F) したことが分かります。失敗したテストの詳細（どのファイル/関数で、どのアサーションが失敗したか、関連する変数の値など）が非常に分かりやすく表示されています。

コマンドラインオプション

pytestコマンドには便利なオプションがたくさんあります。

  • -v (--verbose): より詳細なテスト結果（テスト関数名など）を表示します。
  • -s (--capture=no): テスト中のprint文などの標準出力を表示します。デフォルトではpytestが標準出力を捕捉して、テスト失敗時や-sオプション指定時にのみ表示します。
  • -x (--exitfirst): 最初のテスト失敗時にテスト実行を中断します。
  • --maxfail=N: N個のテストが失敗したら実行を中断します。
  • -k EXPRESSION: テスト名が指定した式にマッチするものだけを実行します。例: pytest -k "add or negative" は名前に”add”か”negative”が含まれるテストを実行します。
  • pytest test_my_module.py: 特定のテストファイルのみを実行します。
  • pytest test_my_module.py::test_add_positive_numbers: 特定のファイル内の特定のテスト関数のみを実行します。
  • pytest tests/: 特定のディレクトリ内のテストのみを実行します。

これらのオプションを組み合わせることで、大規模なテストスイートの中から特定のテストを選んで実行したり、デバッグ時に素早く失敗箇所を見つけたりすることができます。

pytestの主要機能詳解

pytestの強力さを支える主要な機能について、さらに詳しく見ていきましょう。

1. Assert文の活用と詳細な失敗レポート

pytestはPython標準のassert文をそのまま使いますが、失敗時には通常のPythonのAssertionErrorよりもはるかに詳細な情報を提供してくれます。

例：

“`python

test_assertion_examples.py

def test_list_comparison():
a = [1, 2, 3, 4]
b = [1, 2, 4, 3]
assert a == b # 失敗するはず

def test_dictionary_comparison():
d1 = {‘a’: 1, ‘b’: 2, ‘c’: 3}
d2 = {‘a’: 1, ‘b’: 2, ‘d’: 3}
assert d1 == d2 # 失敗するはず

def test_in_operator():
names = [‘Alice’, ‘Bob’, ‘Charlie’]
assert ‘David’ in names # 失敗するはず

def test_is_none():
value = “hello”
assert value is None # 失敗するはず

def test_attribute_check():
class Person:
def init(self, name):
self.name = name
p = Person(“Alice”)
assert p.age == 30 # 失敗するはず (age属性は存在しない)
“`

これらのテストを実行すると、pytestはどの部分が一致しないか、変数の値がどうなっているかなどを詳細に報告します。例えば、test_list_comparisonの失敗時には、リストのどの要素が異なるかが示されます。test_attribute_checkのように属性が存在しない場合は、どのような属性アクセスが試みられたかが報告されます。この詳細なレポート機能は、テストが失敗したときに何が問題なのかを迅速に把握するのに非常に役立ちます。

2. 例外・警告のテスト

特定のコードが例外を発生させるべきか、警告を発するべきかをテストすることも重要です。pytestではpytest.raisesとpytest.warnsを使ってこれを簡単にテストできます。

“`python

my_errors.py

import warnings

def risky_division(a, b):
if b == 0:
raise ValueError(“Cannot divide by zero!”)
if b < 0.001:
warnings.warn(“Division by a very small number!”, RuntimeWarning)
return a / b

test_error_warnings.py

import pytest
from my_errors import risky_division

def test_zero_division_raises_value_error():
with pytest.raises(ValueError) as excinfo:
risky_division(10, 0)
# 例外のメッセージや型をさらに検証することも可能
assert “Cannot divide by zero!” in str(excinfo.value)

def test_small_division_warns_runtime_warning():
with pytest.warns(RuntimeWarning, match=”Division by a very small number!”):
risky_division(10, 0.0001)

警告が発生しないことを確認するテスト

def test_normal_division_does_not_warn():
with pytest.warns(None) as record:
risky_division(10, 2)
assert len(record) == 0 # 警告が何も記録されていないことを確認
“`

pytest.raisesはコンテキストマネージャーとして使い、そのブロック内で期待する例外が発生することを確認します。オプションで発生した例外オブジェクトを取得し、その詳細（エラーメッセージなど）をさらに検証することも可能です。pytest.warnsも同様にコンテキストマネージャーとして使い、期待する警告が発生することを確認します。match引数で警告メッセージの一部を検証したり、record属性で発生した警告オブジェクトのリストを取得して詳細に検証したりできます。

3. Fixtures: テストのセットアップと依存性注入

Fixturesはpytestの最も強力で柔軟な機能の一つです。テストの実行に必要な準備（リソースの確保、オブジェクトの生成、データベースへの接続など）を行い、テスト関数にそれらを提供します。

  • 定義: Fixtureは@pytest.fixtureデコレータを付けた関数として定義します。
  • 利用: Fixtureを利用したいテスト関数や他のFixtureは、そのFixture関数名を引数として宣言します。pytestがテスト実行時に依存関係を解決し、適切なFixtureの戻り値を引数に注入します。

“`python

test_fixtures.py

import pytest

@pytest.fixture
def sample_data():
“””テストに使用するサンプルデータを提供するFixture”””
print(“\nSetting up sample_data”) # セットアップ時の出力
data = {“item1”: 10, “item2”: 20}
yield data # yieldを使うと、テスト実行後に後処理を実行できる
print(“\nTearing down sample_data”) # 後処理時の出力

@pytest.fixture
def process_data(sample_data):
“””sample_data Fixtureに依存するFixture”””
print(“Setting up process_data”)
processed = {k: v * 2 for k, v in sample_data.items()}
return processed

def test_with_sample_data(sample_data):
“””sample_data Fixtureを利用するテスト”””
print(“Running test_with_sample_data”)
assert sample_data[“item1”] == 10
assert sample_data[“item2”] == 20

def test_with_processed_data(process_data):
“””process_data Fixtureを利用するテスト”””
print(“Running test_with_processed_data”)
assert process_data[“item1”] == 20
assert process_data[“item2”] == 40
“`

このテストを実行すると、pytestはtest_with_sample_dataを実行する前にsample_data Fixtureを実行し、その戻り値をテスト関数の引数sample_dataに渡します。test_with_processed_dataを実行する前には、まずprocess_data Fixtureを実行し、その際にprocess_dataが依存するsample_data Fixtureも実行（または再利用）し、その戻り値をprocess_dataの引数sample_dataに渡します。最後にprocess_dataの戻り値をtest_with_processed_dataの引数process_dataに渡します。

yieldキーワードを使うと、yieldの前の部分がセットアップ、後の部分がティアダウンとして、テスト関数の実行後に必ず実行されるようになります。これはファイルやネットワーク接続を閉じるといったリソースの解放に非常に便利です。

Fixtureのスコープ:

Fixtureにはスコープがあり、実行される頻度を制御できます。

  • function (デフォルト): Fixtureを利用するテスト関数が呼び出されるたびに実行されます。
  • class: Fixtureを利用するテストクラス内の最初のテストメソッドが実行される前に一度だけ実行され、クラス内のすべてのテストメソッドでその戻り値が共有されます。
  • module: Fixtureを利用するテストモジュール（ファイル）内の最初のテスト関数/メソッドが実行される前に一度だけ実行され、モジュール内のすべてのテストでその戻り値が共有されます。
  • session: テストセッション全体で一度だけ実行され、すべてのテストファイル、テストクラス、テスト関数でその戻り値が共有されます。

スコープは@pytest.fixture(scope="...")のように指定します。より広いスコープを指定することで、セットアップにかかる時間を削減し、テスト実行を高速化できます。ただし、広いスコープを使う場合は、Fixtureの状態が異なるテスト間で副作用を引き起こさないように注意が必要です。

conftest.pyによるFixtureの共有:

conftest.pyという名前のファイルをテストディレクトリに配置することで、そのディレクトリ以下のテストファイルで自動的に利用可能なFixtureを定義できます。conftest.pyで定義されたFixtureは、importなしに他のテストファイルから参照できます。これはプロジェクト全体や特定のサブディレクトリで共通して利用するFixtureを管理するのに非常に便利です。

4. Parametrize: 複数のテストデータで同じテストを実行

同じテストロジックを異なる入力値と期待される出力値の組み合わせで繰り返し実行したい場合、@pytest.mark.parametrizeデコレータが非常に役立ちます。

“`python

test_parametrize.py

import pytest

(入力1, 入力2, 期待される出力) のリスト

test_data_add = [
(1, 2, 3),
(0, 0, 0),
(-1, 1, 0),
(-1, -1, -2),
(1000, 2000, 3000),
]

@pytest.mark.parametrize(“a, b, expected”, test_data_add)
def test_add_various_inputs(a, b, expected):
“””様々な入力で加算をテスト”””
from my_module import add
result = add(a, b)
assert result == expected

別の関数をパラメータ化する例

test_data_subtract = [
(5, 2, 3),
(0, 0, 0),
(1, -1, 2),
(-1, -1, 0),
]

@pytest.mark.parametrize(“a, b, expected”, test_data_subtract)
def test_subtract_various_inputs(a, b, expected):
“””様々な入力で減算をテスト”””
from my_module import subtract
result = subtract(a, b)
assert result == expected
“`

@pytest.mark.parametrize("引数名の文字列", [データのタプルやリスト]) の形式で指定します。上記の例では、test_add_various_inputsという一つのテスト関数が、test_data_addリストの各要素（タプル）に対して繰り返し実行されます。各実行では、タプルの値が引数a, b, expectedに順番に割り当てられます。これにより、個別のテスト関数を多数書くよりも、コードがDRY（Don’t Repeat Yourself）になり、可読性が向上します。

テストIDの生成:

パラメータ化されたテストは、デフォルトではパラメータの値を含むIDが自動的に生成されます。例えば、上記のテストは実行結果で test_add_various_inputs[1-2-3], test_add_various_inputs[0-0-0] のように表示されます。より分かりやすいIDを付けたい場合は、parametrizeの第3引数にidsのリストを指定します。

python
@pytest.mark.parametrize(
"a, b, expected",
[
(1, 2, 3),
(0, 0, 0),
(-1, 1, 0),
(-1, -1, -2),
(1000, 2000, 3000),
],
ids=["positive", "zeros", "negative_positive", "negative_negative", "large_numbers"]
)
def test_add_various_inputs_with_ids(a, b, expected):
from my_module import add
assert add(a, b) == expected

この場合、テスト結果では test_add_various_inputs_with_ids[positive], test_add_various_inputs_with_ids[zeros] のように表示され、どのデータセットでテストが実行されたかがより明確になります。

5. Markers: テストの分類とフィルタリング

Markerを使うと、テストにメタデータを付与して分類できます。これにより、特定のカテゴリに属するテストだけを実行したり、特定の条件でテストをスキップしたり、失敗を許容したりすることができます。

@pytest.mark.<marker_name> の形式でデコレータとしてテスト関数やテストクラスに付けます。

“`python

test_markers.py

import pytest

@pytest.mark.slow
def test_database_heavy_operation():
“””時間がかかる可能性のあるテスト”””
# データベースアクセスなど、重い処理をシミュレート
import time
time.sleep(2)
assert True

@pytest.mark.integration
def test_api_endpoint_status():
“””外部APIへの結合テスト”””
# 外部APIに接続する処理をシミュレート
assert True # APIが正常ならパス

@pytest.mark.skip(reason=”この機能は一時的に無効になっています”)
def test_feature_under_development():
“””まだ開発中の機能に関するテスト (常にスキップ)”””
assert False # この行には到達しないはず

@pytest.mark.skipif(pytest.version < “7.0”, reason=”pytest 7.0以降が必要です”)
def test_new_feature_requires_latest_pytest():
“””特定のバージョン以降でのみ実行されるテスト”””
assert True

@pytest.mark.xfail(reason=”既知のバグにより現在失敗します”)
def test_known_buggy_case():
“””既知のバグで失敗するテスト (実行はされるが、失敗してもテスト全体は成功とみなす)”””
assert 1 + 1 == 3 # 意図的に失敗させる
“`

マーカーによるテストの実行:

特定のマーカーを持つテストだけを実行するには、-mオプションを使います。

“`bash

‘slow’ マーカーを持つテストだけを実行

pytest -m slow

‘integration’ マーカーを持つテストだけを実行

pytest -m integration

‘slow’ または ‘integration’ マーカーを持つテストを実行

pytest -m “slow or integration”

‘slow’ マーカーを持たないテストを実行

pytest -m “not slow”
“`

組み込みマーカー:

  • @pytest.mark.skip(reason=...): そのテストを無条件にスキップします。
  • @pytest.mark.skipif(condition, reason=...): 指定したcondition（Python式）がTrueの場合にテストをスキップします。環境依存のテストなどで役立ちます。
  • @pytest.mark.xfail(condition=..., reason=...): 失敗することが期待されるテストを示します。xfailとマークされたテストが実行され、実際に失敗した場合、それはテストスイート全体としては失敗とは見なされず、XFAIL (Expected Failure)として報告されます。もしxfailとマークされたテストがパスした場合、それはXPASS (Expected Pass)として報告され、通常は警告が表示されます。既知のバグに対するテストを一時的にマークしておくのに便利です。

カスタムマーカーの登録:

定義したカスタムマーカー（例: slow, integration）は、設定ファイル（pytest.ini, pyproject.toml, またはsetup.cfg）に登録することを推奨します。登録しないと、pytest --strict-markers オプションを使った場合に警告が表示されます。

pytest.ini:

ini
[pytest]
markers =
slow: marks tests as slow (deselect with '-m "not slow"')
integration: marks tests as integration tests

設定ファイルはプロジェクトのルートディレクトリに配置します。

6. Configuration ファイル

pytest.ini, pyproject.toml, またはsetup.cfgといった設定ファイルを使うことで、pytestの様々な挙動をカスタマイズできます。

  • テスト検出パターンの変更: デフォルト以外のファイル名や関数名をテストとして検出するように設定できます。
  • コマンドラインオプションのデフォルト設定: 毎回同じオプション（例: -v, -s）を付けるのが面倒な場合に、設定ファイルに記述しておけます。
  • カスタムマーカーの登録: 前述のマーカー登録。
  • Pythonパスの設定: テスト対象のモジュールをimportするために必要なパスを設定できます。
  • その他のプラグイン設定: インストールしたプラグインの各種設定。

例 (pytest.ini):

ini
[pytest]
addopts = -v -s --strict-markers
testpaths = tests integration_tests
python_files = test_*.py *_test.py check_*.py
python_functions = test_* check_*
markers =
slow: marks tests as slow
integration: marks tests as integration tests

この設定ファイルは、pytest実行時に自動的に読み込まれ、指定されたオプションや設定が適用されます。

実践的なpytestの使い方

実際のプロジェクト開発でpytestをさらに効果的に使うためのテクニックをいくつか紹介します。

1. モックとスタブ

テスト対象のコードが、データベース、外部API、ファイルシステムなどの外部依存を持っている場合、単体テストではこれらの依存を「モック」または「スタブ」に置き換えるのが一般的です。これにより、テストの実行速度を上げ、外部サービスの可用性や状態に影響されずにテストを安定して実行できます。

Python標準ライブラリのunittest.mockモジュールや、pytestプラグインのpytest-mockを利用できます。pytest-mockはunittest.mockをpytestのFixtureとして使いやすくしたものです。

“`python

service.py

import requests

class MyService:
def get_remote_data(self, url):
response = requests.get(url)
response.raise_for_status() # HTTPエラーが発生したら例外を投げる
return response.json()

test_service.py (using pytest-mock)

import pytest
from service import MyService
import requests # モック対象のモジュールをimport

def test_get_remote_data_success(mocker):
“””外部API呼び出しが成功する場合のテスト”””
# requests.get 関数をモックする
mock_get = mocker.patch(‘requests.get’)

# モックされた関数が返すレスポンスオブジェクトを定義
mock_response = mocker.Mock()
mock_response.json.return_value = {"data": "some_data"}
mock_response.raise_for_status.return_value = None # エラーを投げないように設定

# モックされたrequests.getがこのモックレスポンスを返すように設定
mock_get.return_value = mock_response

# テスト対象のメソッドを呼び出す
service = MyService()
url = "http://example.com/api/data"
data = service.get_remote_data(url)

# 期待される結果が返されたかアサート
assert data == {"data": "some_data"}

# requests.getが期待されるURLで呼び出されたか検証 (オプション)
mock_get.assert_called_once_with(url)

def test_get_remote_data_http_error(mocker):
“””外部API呼び出しでHTTPエラーが発生する場合のテスト”””
mock_get = mocker.patch(‘requests.get’)

# エラーを発生させるモックレスポンスを設定
mock_response = mocker.Mock()
mock_response.raise_for_status.side_effect = requests.exceptions.HTTPError("404 Not Found")

mock_get.return_value = mock_response

service = MyService()
url = "http://example.com/api/data"

# HTTPErrorが発生することを期待する
with pytest.raises(requests.exceptions.HTTPError) as excinfo:
    service.get_remote_data(url)

assert "404 Not Found" in str(excinfo.value)

“`

pytest-mockはmockerというFixtureを提供します。mocker.patch()を使うことで、モジュール内の関数やクラスなどを簡単に置き換えられます。置き換えたモックオブジェクトに対して、return_valueで返り値を設定したり、side_effectで例外を発生させたり、assert_called_once_with()などで呼び出しを検証したりできます。

2. データベーステスト

データベースを使用するアプリケーションのテストは、テストごとにデータベースの状態をクリーンに保つ必要があります。これはFixtureを使って実現できます。

  • 一時データベース: テストセッションごとにインメモリデータベース（SQLiteなど）を使用したり、テスト用に独立したデータベースインスタンスを用意したりする。
  • トランザクション: 各テストの開始時にトランザクションを開始し、テストの終了時にロールバックする。これにより、テスト中にデータベースに書き込まれたデータが他のテストに影響を与えなくなります。多くのWebフレームワーク向けpytestプラグイン（pytest-django, pytest-flask-sqlalchemyなど）は、このトランザクション管理を自動で行うFixtureを提供しています。
  • テストデータの投入: テストに必要な初期データをFixtureでデータベースに投入する。

データベースFixtureの例（概念）：

“`python

conftest.py (データベース接続とトランザクション管理)

import pytest

仮のDBライブラリと設定を想定

import my_db_library as db

@pytest.fixture(scope=”session”)
def db_connection():
“””セッションスコープでDB接続を確立”””
print(“Establishing DB connection…”)
conn = “DBConnectionObject” # 実際のDB接続オブジェクト
yield conn
print(“Closing DB connection…”)
# conn.close() # 接続を閉じる

@pytest.fixture(scope=”function”, autouse=True) # autouse=True で全テスト関数で自動実行
def session(db_connection):
“””各テスト関数でトランザクションを開始・ロールバック”””
print(“Starting transaction…”)
# session = db_connection.start_transaction() # 仮のトランザクション開始
session = “DBSessionObject” # 実際のセッションオブジェクト
yield session
print(“Rolling back transaction…”)
# session.rollback() # トランザクションをロールバック
# session.close()

test_database.py

import my_models # テスト対象のDBモデルを想定

def test_create_user(session):
“””ユーザー作成テスト”””
# user = my_models.User(name=”Alice”)
# session.add(user)
# session.commit() # テストコード内ではcommitせず、fixtureのrollbackに任せることも多い
# retrieved_user = session.query(my_models.User).filter_by(name=”Alice”).one()
# assert retrieved_user.name == “Alice”
print(“Running test_create_user”)
assert session is not None
pass # 実際のテストコードに置き換える

def test_get_user_by_id(session):
“””IDによるユーザー取得テスト”””
# 事前にユーザーを作成（またはテストデータをFixtureで投入）
# retrieved_user = session.query(my_models.User).get(1)
# assert retrieved_user is not None
print(“Running test_get_user_by_id”)
assert session is not None
pass # 実際のテストコードに置き換える

注意: これは概念的なコードであり、実際のDBライブラリに合わせて記述する必要があります。

“`

autouse=Trueスコープを持つFixtureは、そのスコープ内で定義されているすべてのテストに対して自動的に実行されます。上記の例では、session Fixtureが関数スコープで自動実行されるため、各テスト関数の開始前にトランザクションが開始され、終了後にロールバックされます。

3. カバレッジレポートの生成

テストがコードのどれだけをカバーしているか（実行しているか）を測定することは、テストスイートの網羅性を把握する上で重要です。pytest-covプラグインを使うと、pytestの実行と同時にカバレッジを測定し、レポートを生成できます。

  1. インストール: pip install pytest-cov
  2. 実行: テスト実行時に--cov=<module_or_package>オプションを追加します。

“`bash

my_module.py のカバレッジを測定

pytest –cov=my_module

my_package ディレクトリ以下のカバレッジを測定

pytest –cov=my_package

カバレッジレポートを詳細表示

pytest –cov=my_module –cov-report=term-missing
“`

--cov-report=term-missingオプションを付けると、どの行がテストによって実行されなかったかがターミナルに詳細に表示されます。HTML形式のレポートを生成することも可能です。

bash
pytest --cov=my_module --cov-report=html

実行後、htmlcov/index.htmlというファイルが生成され、ブラウザで開くとコードカバレッジを視覚的に確認できます。

4. CI/CD 環境との連携

継続的インテグレーション/継続的デリバリー (CI/CD) パイプラインにテストを組み込むのは一般的です。GitLab CI, GitHub Actions, JenkinsなどのCIサービスは、pytestを簡単に実行できます。多くの場合、CI設定ファイルに以下のコマンドを記述するだけです。

“`yaml

.gitlab-ci.yml または .github/workflows/ci.yml の一部として

test:
stage: test
script:
– pip install pytest pytest-cov # テストに必要なライブラリをインストール
– pytest –cov=your_package_name –cov-report=xml # テストを実行し、カバレッジレポートをXML形式で出力 (CIサービスが読み取れる形式)
# オプション: テスト結果やカバレッジレポートを成果物としてアップロード
artifacts:
paths:
– .coverage
– htmlcov/ # pytest-covがHTMLレポートを生成した場合
reports:
junit: report.xml # pytestのXMLレポートプラグインなどが必要
coverage_report:
coverage_format: cobertura
path: coverage.xml
“`

XML形式のカバレッジレポート (--cov-report=xml) やJUnit形式のテスト結果レポート (--junitxml=report.xml – pytest-xunit2プラグインなどが必要) を出力するように設定すると、CIサービスがこれらのレポートを読み込み、ビルド結果画面でテストのパス/失敗状況やカバレッジ率を分かりやすく表示してくれます。

unittestからの移行

既存のプロジェクトがunittestでテストを書いている場合でも、pytestへの移行は比較的容易です。前述の通り、pytestはunittest.TestCaseを継承したテストクラスをそのまま実行できます。

  1. pytestをインストールし、pytestコマンドでテストを実行してみる: 多くのunittestテストは、特別な設定なしにpytestで実行できるはずです。
  2. 少しずつpytestスタイルに書き換える: 新しいテストはpytestスタイル（シンプルな関数、assert文、Fixtures）で書き始めます。既存のunittest.TestCaseクラスも、時間を見つけて一つずつpytestスタイル（クラスをなくし、メソッドを関数にし、self.assertEqualなどをassertに書き換え、setUp/tearDownをFixtureに移行）に書き換えていくことができます。一度にすべてを書き換える必要はありません。
  3. Fixtureを活用する: 共通のsetUp/tearDown処理が多い場合は、それを適切なスコープのFixtureに移行することを検討します。
  4. parametrizeを活用する: 同じロジックで異なるデータセットをテストしている箇所があれば、@pytest.mark.parametrizeを使って簡潔に書き換えます。

このように、共存させながら段階的に移行できるため、大きなプロジェクトでも無理なくpytestを導入できます。

まとめ：pytestを使い始めよう！

本記事では、Python開発におけるテストの重要性から始まり、標準ライブラリのunittestと比較しつつ、pytestの圧倒的な魅力と実用的な使い方を詳細に解説しました。

pytestの魅力は、そのシンプルさ（コード量の削減、直感的なassert）、高機能さ（Fixtures, parametrize, markers, plugins）、そして柔軟性（unittestとの互換性）に集約されます。これらの機能は、テストコードをより書きやすく、読みやすく、メンテナンスしやすくし、結果として開発効率とコード品質を大幅に向上させます。

テストを書くことは、最初は少し手間に感じるかもしれません。しかし、それは開発初期のわずかな投資で、将来のバグ修正や機能追加、リファクタリングにかかるコストを劇的に削減し、プロジェクトを健全に保つための最良の方法です。そして、そのテストを書く作業を最も快適かつ効率的にしてくれるのがpytestです。

この記事で学んだpytestの基本的な使い方、Fixtures、parametrize、markersといった主要機能をぜひあなたのPython開発に取り入れてみてください。まずは小さな機能やモジュールからテストを書き始めて、pytestのパワーを実感してください。きっと、もうpytestなしの開発は考えられなくなるでしょう。

良いテストライフを！

参考文献・リソース

  • pytest公式ドキュメント: https://docs.pytest.org/ – 最も正確で詳細な情報源です。まずはここから始めるのがおすすめです。
  • Python Testing with pytest by Brian Okken – pytestに関する優れた書籍です。より深く学びたい場合に役立ちます。

コメントする

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

上部へスクロール