カスタムメッセージ付きのPython例外クラスを実装する方法

Pythonでは、組み込み例外クラス（ValueErrorやExceptionなど）を継承することで、独自のエラーメッセージを持つカスタム例外を簡単に作成できます。カスタム例外を使うと、エラーの内容をより分かりやすく伝えたり、特定の条件下でのみ発生するエラーを明確に区別したりできるようになります。

カスタム例外の実装例

以下は、ValueErrorを継承したCustomValueErrorクラスを定義し、独自のメッセージとともに例外を発生させるサンプルコードです。

class CustomValueError(ValueError):
    def __init__(self, arg):
        self.arg = arg

try:
    a = int(input("Enter a number:"))
    if not 1 < a < 10:
        raise CustomValueError("Value must be within 1 and 10.")
except CustomValueError as e:
    print("CustomValueError Exception!", e.arg)

実行結果

Enter a number:45
CustomValueError Exception! Value must be within 1 and 10.
Process finished with exit code 0

コードの解説

1. カスタム例外クラスの定義

class CustomValueError(ValueError): のように、既存の例外クラスを継承して新しい例外クラスを作成します。__init__メソッドで引数argを受け取り、インスタンス属性として保持することで、後からエラーメッセージを参照できるようにしています。

2. 例外の発生

ユーザーから入力を受け取り、その値が1より大きく10未満でない場合に、raise CustomValueError(...)によってカスタム例外を意図的に発生させています。ここで渡された文字列「Value must be within 1 and 10.」が、例外オブジェクトのargに格納されます。

3. 例外の捕捉と表示

except CustomValueError as e: ブロックで発生したカスタム例外を捕捉し、e.argを通じてカスタムメッセージを出力しています。これにより、標準的なエラーメッセージではなく、開発者が用意した分かりやすいメッセージを表示できます。

補足：よりシンプルな書き方

特別な属性が必要ない場合は、__init__を定義せずに、親クラスの機能をそのまま利用する方法もあります。

class CustomValueError(ValueError):
    pass

try:
    raise CustomValueError("Value must be within 1 and 10.")
except CustomValueError as e:
    print("CustomValueError Exception!", e)

この場合も、raise時に渡した文字列がそのまま例外のメッセージとして扱われます。用途に応じて、シンプルな形式とカスタム属性を持つ形式を使い分けるとよいでしょう。