Last Updated on 2025年7月28日
概要
Pythonの開発中に頻繁に遭遇するエラーのひとつが AssertionError: expected X but got Y です。
このエラーは、主にテストやデバッグ目的で使われる assert 文で、期待された値と実際の値が異なる場合に発生します。
特にユニットテストやCI環境での自動検証においてよく見られるエラーです。
この記事では、このエラーの仕組みと原因、そして解決方法について詳細に解説します。
目次
エラー内容
以下のようなエラーが表示されることがあります。
|
1 |
AssertionError: expected 5 but got 3 |
このエラーは、開発者が「ある条件が必ず真であるべき」として書いた assert 文に違反する事象が発生したことを示します。
具体的には、以下のようなコードで発生します。
|
1 2 3 4 5 |
def add(a, b): return a + b result = add(1, 2) assert result == 5, f"expected 5 but got {result}" |
この場合、add(1, 2) は3を返すため、assert result == 5 は失敗し、
AssertionError: expected 5 but got 3 というエラーになります。
原因
このエラーの原因は主に以下の2つです。
- 期待値（expected）と実測値（actual）の不一致
テスト対象のコードが想定とは異なる挙動をした場合。 - テストケースの誤り
テストの書き方や論理にミスがある可能性。
例えば、以下のようなテストコードでエラーが発生したとします。
|
1 2 3 4 |
def multiply(a, b): return a * b assert multiply(2, 3) == 5, "expected 5 but got {}".format(multiply(2, 3)) |
この場合、実際には6が返されるため、テストの期待値が間違っています。
対処法
このエラーに対処するには、まずどちらにミスがあるかを確認する必要があります。
1. 実装コードを見直す
- 期待される値を返すようにロジックを修正
- 例えば、ロジックに誤りがある場合は以下のように修正
|
1 2 3 4 5 6 7 |
# 修正前 def add(a, b): return a * b # ミスで乗算している # 修正後 def add(a, b): return a + b |
2. テストコードを見直す
- テストの期待値が誤っていることも多いです。
- ドキュメントや仕様書と照らし合わせて確認します。
|
1 2 3 4 5 |
# 修正前 assert add(2, 2) == 5, "expected 5 but got {}".format(add(2, 2)) # 修正後 assert add(2, 2) == 4, "expected 4 but got {}".format(add(2, 2)) |
3. assertの使い方を再検討する
本番コードで assert を使用するのは推奨されません。
理由は、Pythonを-O（最適化）オプションで実行するとassert文が無効になるためです。
テストや検証用のコードに限定するのが安全です。
補足
テストフレームワークとの関係
unittest や pytest といったフレームワークを使う場合、assert文は重要な役割を果たします。
pytest では、assert文の失敗時に自動的に期待値と実測値を分かりやすく出力してくれるため、デバッグが容易になります。
より良いメッセージの書き方
エラーメッセージは読みやすく、トラブルの原因を把握しやすいように書くことが望ましいです。
|
1 |
assert result == 5, f"expected 5 but got {result} (input was: {a}, {b})" |
複数ケースのテスト例
以下はpytestで複数ケースを一気にテストする例です。
|
1 2 3 4 5 6 7 8 9 |
import pytest @pytest.mark.parametrize("a, b, expected", [ (1, 2, 3), (0, 0, 0), (-1, 1, 0), ]) def test_add(a, b, expected): assert add(a, b) == expected, f"expected {expected} but got {add(a, b)}" |
まとめ
AssertionError: expected X but got Yは、期待した値と実際の値が一致しないときに発生する。- 原因はコードロジックのバグ、またはテストのミスであることが多い。
- assert文の使用はテストや開発段階に限定するのが望ましい。
- エラー発生時は、ログや引数などの情報を追加してデバッグを助けるメッセージを書くと良い。
Pythonでの開発では、テストコードと実装コードの両方を常に見直しながら進めることで、AssertionErrorを早期に解決できます。
