【Python3.x】ExceptionGroup::__cause__定数の使い方
__cause__定数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
__cause__定数は、PythonのExceptionGroupオブジェクトが保持する特殊な属性の一つであり、そのExceptionGroupが発生する直接の原因となった単一の例外を指し示す定数です。Pythonでは、ある例外が別の例外を引き起こす「例外の連鎖」という仕組みがあり、__cause__はその連鎖において、現在の例外が直接引き起こされた原因の例外を保持します。
ExceptionGroupは、複数の関連する例外をまとめて扱うために導入された新しい例外クラスですが、この__cause__は、ExceptionGroupが内包する複数の例外（これらはexceptionsプロパティからアクセスできます）とは異なります。__cause__が示すのは、あくまで「このExceptionGroupが生成されることになった、そのきっかけとなった単一の例外」です。
例えば、ある関数が複数の並行処理を実行し、その中で個々の例外が発生した場合、それらをExceptionGroupとしてまとめることがあります。その際、もしExceptionGroupの生成自体が、さらに上位の層で発生した別の単一の例外によって引き起こされたのであれば、その上位の例外が__cause__に設定される可能性があります。
この定数は、通常、raise new_exception from original_exceptionのようなfrom句を用いた例外の再送出構文によって明示的に設定されます。明示的に設定されていない場合、その値はNoneとなります。デバッグ時にExceptionGroupがどのような文脈で発生したのか、その根本的な原因を追跡する上で非常に有用な情報を提供します。
構文(syntax)
1try: 2 original_error = ConnectionRefusedError("Connection failed") 3 raise ExceptionGroup("Multiple failures occurred", [ValueError("Invalid data")]) from original_error 4except ExceptionGroup as eg: 5 eg.__cause__
引数(parameters)
引数なし
引数はありません
戻り値(return)
BaseException | None
この __cause__ プロパティは、例外の連鎖によってこの例外が発生した場合、その直接の原因となった例外オブジェクト、または原因がない場合は None を返します。