Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Python3.x】GeneratorExit::args定数の使い方

args定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

args定数は、Pythonの組み込み例外クラスであるGeneratorExitオブジェクトが保持する、例外発生時に渡された引数をタプルとして表す定数です。

GeneratorExitは、Pythonのジェネレータやコルーチンが閉じられる際、またはファイナライズされる際に送出される特別な種類の例外です。これは、一般的なプログラムのエラーを示すものではなく、ジェネレータの終了処理やクリーンアップを促すために使用されます。例えば、ジェネレータのclose()メソッドが呼び出された時などに発生します。

Pythonの例外オブジェクトは、コンストラクタに渡された引数を標準的にargs定数としてタプル形式で保持します。しかし、GeneratorExitは通常、引数を伴わずに送出されるため、このGeneratorExitオブジェクトのargs定数はほとんどの場合、空のタプルを保持しています。

この定数は、ジェネレータのシャットダウンプロセスの一部として機能するため、他の一般的なエラーを示す例外とは異なります。そのため、try...except GeneratorExitで捕捉した場合でも、通常はそのまま再送出(raise)することが推奨されます。これにより、ジェネレータの終了処理が適切に完了し、リソースが正しく解放されることを保証します。

構文(syntax)

1generator_exit_instance = GeneratorExit("Generator was closed externally.")
2print(generator_exit_instance.args)

引数(parameters)

引数なし

引数はありません

戻り値(return)

tuple

GeneratorExit例外が発生した際の、例外コンストラクタに渡された引数をタプル型で返します。

関連コンテンツ