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

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

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

作成日: 更新日:

基本的な使い方

__doc__定数は、Pythonの組み込み型であるboolクラスのドキュメンテーション文字列(docstring)を保持する定数です。boolクラスは、プログラム内で真偽(正しいか間違っているか)を表現するために使用される、非常に基本的なデータ型です。この型は、True(真)とFalse(偽)という二つの値のみを持ち、これらはそれぞれboolクラスの唯一のインスタンスです。

bool(x)という形式で利用され、引数xがブールコンテキスト(真偽を判断する文脈)において真と評価される場合にはTrueを、偽と評価される場合にはFalseを返します。例えば、空でない文字列やリスト、0以外の数値などはTrueと評価され、空の文字列やリスト、数値の0などはFalseと評価されます。

このboolクラスは、内部的にはint(整数)クラスのサブクラスとして実装されており、Trueは整数の1、Falseは整数の0として扱われる側面もあります。これにより、論理演算だけでなく、数値的な文脈でも利用できる柔軟性を持っています。

__doc__属性は、Pythonにおいて、クラス、関数、メソッド、モジュールなどがどのような機能を持つか、どのように使うかといった説明を記述するための標準的な方法です。これにより、他の開発者や将来の自分がコードの意図や使い方を素早く理解できるようになります。bool.__doc__定数は、まさにこのboolクラスの基本的な振る舞いや使い方を説明する情報そのものを保持しているのです。

構文(syntax)

1print(bool.__doc__)

引数(parameters)

引数なし

引数はありません

戻り値(return)

str

bool型のオブジェクトが持つドキュメンテーション文字列を返します。

関連コンテンツ