【Python3.x】NotImplementedError::__doc__定数の使い方
__doc__定数の使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
__doc__定数は、NotImplementedErrorクラスのドキュメンテーション文字列を表す定数です。NotImplementedErrorは、Pythonに組み込まれている標準的な例外の一つで、クラスのメソッドや機能がまだ実装されていないことを明示的に示すために使用されます。
この例外は、主に基底クラス（親クラス）で抽象的なメソッドを定義する際に利用されます。例えば、親クラスが「このメソッドは、それを継承する子クラスで必ず具体的に実装してください」という設計意図を持つ場合、親クラスの当該メソッドの実装部分にraise NotImplementedErrorと記述します。これにより、もし子クラスがそのメソッドを実装せずに呼び出してしまった場合、この例外が発生し、未実装であるというエラーが明確に通知されます。
NotImplementedErrorは、プログラムの設計段階で、将来的に実装が必要な部分や、サブクラスによる具体的な実装を強制したいインターフェースを定義する際に非常に役立ちます。開発者はこの例外によって、どの部分の実装がまだ不足しているのか、あるいはどのメソッドが抽象的なままであるのかを容易に把握でき、システムの整合性を保ちながら開発を進めることができます。
構文(syntax)
1print(NotImplementedError.__doc__)
引数(parameters)
引数なし
引数はありません
戻り値(return)
str
この定数は、NotImplementedError クラス自体の説明文を文字列として返します。