5.2.2 どのドキュメンテーション文字列が検証されるのか?

全ての詳細は doctest.py のドキュメンテーション文字列を参照してください。混乱させるようなことはありません: モジュールのドキュメンテーション文字列、全ての関数、クラスおよびメソッドのドキュメンテーション文字列が検索されます。オプションとして、テスタはプライベートな名前をもつオブジェクトに添付されたドキュメンテーション文字列を除外することができます。モジュールに import されたオブジェクトは検索されません。

加えて、 M.__test__ が存在し、 "真の値を持つ" 場合、この値は辞書で、辞書の各エントリは (文字列の) 名前を関数オブジェクト、クラスオブジェクト、または文字列に対応付けていなくてはなりません。M.__test__ から得られた関数およびクラスオブジェクトのドキュメンテーション文字列は、その名前がプライベートなものでも検索され、文字列の場合にはそれがドキュメンテーション文字列であるかのように直接検索を行います。出力においては、M.__test__ におけるキー K は、

  <name of M>.__test__.K

のように表示されます。

検索中に見つかったクラスも同様に再帰的に検索が行われ、クラスに含まれているメソッドおよびネストされたクラスについてドキュメンテーション文字列のテストが行われます。 M 内のグローバル変数から到達したプライベートな名前はオプションでスキップされますが、M.__test__ から到達した名前は全て検索されます。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。