Pythonでカスタム例外を使ってオブジェクトを渡す正しい方法とは？

Pythonでは、組み込みのExceptionクラスを継承することで、独自のカスタム例外を簡単に定義できます。カスタム例外には、エラーメッセージとなる文字列や、その他のオブジェクトを引数として渡すことが可能で、例外発生時の詳細な情報を保持しておけます。

次のコードでは、ExceptionクラスのサブクラスとしてFooExceptionというカスタム例外を作成し、文字列オブジェクトを渡しています。

コード例

#foobar.py
class FooException(Exception):
    def __init__(self, text, *args):
        super(FooException, self).__init__(text, *args)
        self.text = text

try:
    bar = input("Enter a string:")
    if not isinstance(bar, str):
        raise FooException(bar)
except FooException as r:
    print('there is an error')
else:
    print(type(bar))
    print(bar)

コードのポイント

• コンストラクタの定義：__init__メソッド内で、渡されたオブジェクトをsuper()経由で親クラスに引き継ぎつつ、self.textとしてインスタンスに保存しています。これにより、後から例外オブジェクト経由で内容を参照できます。
• *argsによる柔軟な設計：可変長引数を受け付けることで、必要に応じて複数のオブジェクトを例外に渡すことも可能です。
• 例外の送出と捕捉：条件を満たさない場合にraise FooException(bar)で例外を発生させ、except FooException as r:で捕捉します。変数rからはr.textのように、渡したオブジェクトへアクセスできます。

実行方法

ターミナルで次のようにスクリプトを実行します。

$ python foobar.py

文字列を入力すると、以下のような結果が得られます。

出力例

C:/Users/TutorialsPoint1/~foobar.py
Enter a string: 'voila'
<class 'str'>
voila

このように、入力された値が文字列であればelseブロックが実行され、入力値の型と内容が出力されます。一方、条件に合致しない場合はFooExceptionが送出され、exceptブロック内の「there is an error」というメッセージが表示されます。

補足：Python 2とPython 3の違い

元のコードはPython 2向けに書かれており、文字列判定にはbasestringが使われていました。Python 3ではbasestringが廃止されているため、上記のようにstrを使用します。また、Python 3のinput()は常に文字列を返すため、数値などを扱いたい場合はint()などによる型変換やバリデーションを組み合わせるのがおすすめです。