【Python】assertでテスト入門：書き方・落とし穴・実践例

# 基本構文
assert 条件式          # 条件式がFalseならAssertionError
assert 条件式, メッセージ  # 条件式がFalseならメッセージ付きでAssertionError

def average(numbers):
    # リストが空でないことをチェック
    assert len(numbers) > 0, "numbersは空であってはいけません"
    return sum(numbers) / len(numbers)


if __name__ == "__main__":
    print(average([1, 2, 3]))   # 正常: 2.0 が出力される
    print(average([]))          # AssertionError が発生する

def is_adult(age: int) -> bool:
    return age >= 20


if __name__ == "__main__":
    age = 25
    # ここでは、ageは20歳以上であることを前提にしている
    assert is_adult(age)

    # 以下の処理は、ageが成人であることを前提に進む
    print("成人向けサービスを表示します")

def divide(a: float, b: float) -> float:
    # bが0でないことを前提にしている
    assert b != 0, "bは0であってはいけません(ゼロ除算防止)"
    return a / b


if __name__ == "__main__":
    print(divide(10, 2))
    print(divide(10, 0))  # AssertionError: bは0であってはいけません(ゼロ除算防止)

def register_score(name: str, score: int) -> None:
    # 名前が空でなく、スコアが0〜100の範囲であることを前提とする
    assert name, "nameは空文字であってはいけません"
    assert 0 <= score <= 100, "scoreは0〜100の範囲である必要があります"

    print(f"{name}さんのスコア: {score}点を登録しました")


if __name__ == "__main__":
    register_score("Taro", 80)
    register_score("", 50)      # nameのassertで失敗
    register_score("Hanako", 150)  # scoreのassertで失敗

def register_score(name: str, score: int) -> None:
    assert name and 0 <= score <= 100, (
        "不正な引数: nameは非空、scoreは0〜100である必要があります"
    )
    print(f"{name}さんのスコア: {score}点を登録しました")

def add(a: int, b: int) -> int:
    return a + b


def test_add():
    # 期待される戻り値をassertで検証する
    assert add(1, 2) == 3
    assert add(-1, 1) == 0
    assert add(0, 0) == 0


if __name__ == "__main__":
    # 簡易テストとして関数を実行
    test_add()
    print("test_addはすべて成功しました")

def get_user(user_id: int) -> dict:
    # 実際にはDBなどから取得する想定
    return {"id": user_id, "name": "Taro", "age": 30}


def test_get_user():
    user = get_user(1)
    assert isinstance(user, dict), "戻り値はdictである必要があります"
    assert "id" in user and "name" in user and "age" in user, "必要なキーが不足しています"
    assert user["id"] == 1, "idが期待と異なります"

def divide(a: float, b: float) -> float:
    # bが0でないことを前提にしている
    assert b != 0, "bは0であってはいけません"
    return a / b


if __name__ == "__main__":
    print(divide(10, 0))

python -O example.py

def create_order(user, item, quantity):
    # 悪い例: ビジネスロジックをassertで書いている
    assert quantity > 0, "数量は1以上でなければなりません"
    # ...注文を登録する処理...

class ValidationError(Exception):
    pass


def create_order(user, item, quantity):
    if quantity <= 0:
        # ビジネスロジックに関わるチェックは通常のエラーとして扱う
        raise ValidationError("数量は1以上でなければなりません")
    # ...注文を登録する処理...

def save_user(user):
    # 悪い例: 副作用のある関数をassertの中で呼び出している
    assert save_to_db(user), "DB保存に失敗しました"

def save_user(user):
    # 先に副作用を実行する
    result = save_to_db(user)
    # その結果が期待どおりかをassertでチェックする(あくまでデバッグ用)
    assert result, "DB保存に失敗しました"

# 悪い例: f文字列の中で重い処理をしている
assert x > 0, f"xは正の数である必要があります。現在の統計情報: {expensive_calc()}"

def debug_stats():
    # 重い処理: デバッグ用途のみ
    return expensive_calc()


# 条件がFalseのときだけメッセージ組み立てを行う
if not x > 0:
    debug_message = f"xは正の数である必要があります。現在の統計情報: {debug_stats()}"
    assert False, debug_message

# calculator.py

def add(a: int, b: int) -> int:
    return a + b


def sub(a: int, b: int) -> int:
    return a - b


def mul(a: int, b: int) -> int:
    return a * b


def div(a: int, b: int) -> float:
    if b == 0:
        raise ValueError("bは0以外である必要があります")
    return a / b


def _run_simple_tests():
    # addのテスト
    assert add(1, 2) == 3
    assert add(-1, 1) == 0

    # subのテスト
    assert sub(5, 3) == 2
    assert sub(0, 3) == -3

    # mulのテスト
    assert mul(2, 3) == 6
    assert mul(-1, 3) == -3

    # divのテスト
    assert div(6, 3) == 2
    try:
        div(1, 0)
        assert False, "div(1, 0)は例外を投げるべきです"
    except ValueError:
        pass  # 期待通り


if __name__ == "__main__":
    _run_simple_tests()
    print("簡易テストはすべて成功しました")

# math_utils.py

def square(x: int) -> int:
    return x * x


def is_even(n: int) -> bool:
    return n % 2 == 0


def test_square():
    assert square(2) == 4
    assert square(-3) == 9
    assert square(0) == 0


def test_is_even():
    assert is_even(2) is True
    assert is_even(3) is False
    assert is_even(0) is True


if __name__ == "__main__":
    # テスト関数を手動で呼び出す
    test_square()
    test_is_even()
    print("すべてのテストが成功しました")

# test_calculator.py

from calculator import add, sub, mul, div
import pytest  # pytestを利用する例だが、assert自体は標準のもの


def test_add():
    assert add(1, 2) == 3
    assert add(-1, 1) == 0


def test_sub():
    assert sub(5, 3) == 2
    assert sub(0, 3) == -3


def test_mul():
    assert mul(2, 3) == 6
    assert mul(-1, 3) == -3


def test_div():
    assert div(6, 3) == 2
    with pytest.raises(ValueError):
        div(1, 0)

pytest

from calculator import div


def test_div_raises():
    try:
        div(1, 0)
        # ここに到達したら例外が出ていないので失敗
        assert False, "div(1, 0)はValueErrorを投げるべきです"
    except ValueError:
        # 期待通り
        pass

import pytest
from calculator import div


def test_div_raises():
    with pytest.raises(ValueError):
        div(1, 0)