Pythonのassert文とカスタムメッセージ

Pythonのassert文は、プログラムが期待する状態を確認するための便利なツールです。assert文は、指定した条件がTrueでない場合にAssertionErrorを発生させます。このエラーメッセージはデフォルトで提供されますが、カスタムメッセージを提供することも可能です。

assert文の基本的な使用方法

基本的なassert文の使用方法は以下の通りです:

def f():
    return 3

def test_function():
    assert f() == 4

このコードでは、関数fが4を返すことを期待しています。しかし、実際には3を返すため、AssertionErrorが発生します。

カスタムメッセージの追加

assert文にカスタムメッセージを追加するには、以下のようにassert文の後にカンマを付け、メッセージを記述します:

assert False, "Oopsie"

このコードはAssertionError: Oopsieというメッセージを出力します。

また、テスト中にAPIのステータスコードをチェックする際など、より詳細なカスタムメッセージを提供することも可能です。以下にその例を示します:

def assert_status(response, status=200):
    assert response.status_code == status, f"Expected {status}. Actual status {response.status_code}. Response text {response.text}"

この関数assert_statusは、レスポンスのステータスコードが期待する値と一致することを確認します。一致しない場合、期待するステータスコード、実際のステータスコード、レスポンステキストを含む詳細なエラーメッセージが出力されます。

以上がPythonのassert文とカスタムメッセージの基本的な使用方法です。これらの機能を活用することで、プログラムのデバッグやテストがより効率的に行えます。