Pythonのassert文の使い方：独自のエラーメッセージでエラーをわかりやすく表示する

どのプログラミング言語にも、プログラム実行中に発生した例外を処理する仕組みが備わっています。Pythonではassertキーワード（assert文）を使用することで、システムが自動生成するエラーメッセージではなく、開発者が自由に定義したエラーメッセージを表示できます。これにより、エラーが発生した際の原因特定と修正が格段にしやすくなります。

assert文の基本構文

assert文は次のように記述します。

assert 条件式, エラーメッセージ

条件式がTrueであれば何も起こらず、プログラムはそのまま続行されます。一方、条件式がFalseと評価された場合にはAssertionErrorが発生し、指定したエラーメッセージが表示されます。

assert文を使った例

以下の例では、assertキーワードを使ってゼロ除算（0による割り算）のエラーを捕捉しています。エラーメッセージはプログラマーの意図に合わせて自由に記述できます。

コード例

x = 4
y = 0
assert y != 0, "if you divide by 0 it gives error"
print("Given values are ","x:",x ,"y:",y)
print("\nmultiplication of x and y is",x * y)
print("\ndivision of x and y is",x / y)

上記のコードを実行すると、次のような結果になります。

Traceback (most recent call last):
File "scratch.py", line 3, in
assert y != 0, "if you divide by 0 it gives error"
AssertionError: if you divide by 0 it gives error

変数yが0であるため、assert文の条件式y != 0がFalseとなり、3行目の時点でAssertionErrorが発生していることがわかります。このように、問題のある箇所をプログラムの早い段階で検出できるのがassert文の大きな利点です。

assert文を使わない場合

assert文を使わずに同じコードを実行するとどうなるでしょうか。assert文をコメントアウトして試してみます。

コード例

x = 4
y = 0
#assert y != 0, "if you divide by 0 it gives error"
print("Given values are ","x:",x ,"y:",y)
print("\nmultiplication of x and y is",x * y)
print("\ndivision of x and y is",x / y)

上記のコードを実行すると、次のような結果になります。

multiplication of x and y is 0
Traceback (most recent call last):
File "scratch.py", line 6, in <module>
print("\ndivision of x and y is",x / y)
ZeroDivisionError: division by zero

この場合、掛け算の処理は正常に実行され、最後の割り算の行で初めてPython標準のZeroDivisionErrorが発生します。システム生成のエラーメッセージだけでは意図が伝わりにくく、エラーの原因を突き止めるために追加の調査が必要になることもあります。

まとめ

assert文を使えば、エラーの内容を開発者の意図に沿ったわかりやすいメッセージとして表示でき、デバッグ作業の効率が向上します。なお、assert文はPythonを-O（最適化）オプション付きで実行した場合には無効化されるため、本番環境のチェックをassertに依存せず、あくまで開発・デバッグ段階の検証用途として使うのが推奨されています。