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

【Python3.x】RecursionError::__doc__定数の使い方

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

作成日: 更新日:

基本的な使い方

__doc__定数は、Pythonの組み込み例外であるRecursionErrorクラスのドキュメンテーション文字列を保持する定数です。RecursionErrorは、プログラム内で関数が自分自身を繰り返し呼び出す「再帰」という処理において、その呼び出しの深さがPythonインタプリタによって定められた上限を超過した場合に発生するエラーです。

この__doc__定数が保持する文字列は「Recursion depth exceeded」であり、これは「再帰の深さが上限を超過しました」という意味を簡潔に示しています。Pythonでは、無限ループや無限再帰によるシステムリソースの枯渇を防ぐため、デフォルトで再帰の深さに制限が設けられています。通常、この制限は数百回程度の再帰呼び出しで到達します。

もしプログラムがこの上限を超えて再帰呼び出しを試みると、PythonインタプリタはRecursionErrorを送出し、プログラムの実行を中断します。この__doc__定数を参照することで、開発者はRecursionErrorがどのような状況で発生するエラーなのかをプログラム内からすぐに確認でき、エラーの原因を特定する手がかりや、適切なエラーハンドリングを実装する際に役立てることができます。

構文(syntax)

1print(RecursionError.__doc__)

引数(parameters)

引数なし

引数はありません

戻り値(return)

str

この定数は、RecursionError例外のクラスに関する説明文を文字列(str)型で返します。

関連コンテンツ