【Python3.x】SystemExit::__doc__定数の使い方
__doc__定数の使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
__doc__定数は、Pythonの組み込み例外であるSystemExitクラスのドキュメンテーション文字列を保持する定数です。
Pythonでは、クラス、メソッド、関数、モジュールなど、多くのプログラム要素がその目的や使い方を説明するテキスト情報を持つことができます。このテキスト情報は「ドキュメンテーション文字列」（docstring）と呼ばれ、通常は要素の定義直下に記述されます。そして、このドキュメンテーション文字列は、該当する要素の__doc__という特殊な属性を通じてアクセスできるようになっています。
SystemExitクラスは、Pythonプログラムを意図的に終了させるために使用される例外です。例えば、sys.exit()関数が実行された際にこの例外が発生し、インタープリタは通常、この例外を捕まえてプログラムを終了させます。この例外は、一般的なエラーを示すExceptionクラスとは異なり、プログラムの正常な終了要求として扱われるため、通常、エラーの追跡情報（トレースバック）は表示されません。
したがって、SystemExit.__doc__定数を参照することで、SystemExitクラスがどのような目的で設計され、どのように機能するかについて、そのクラス自身が持つ公式の説明文を取得することができます。これは、SystemExitクラスの役割と振る舞いを理解するために非常に役立つ情報源となります。
構文(syntax)
1SystemExit.__doc__
引数(parameters)
引数なし
引数はありません
戻り値(return)
str
この定数は、SystemExitクラス自体の説明文を表す文字列です。