##
1 簡単な利用法: docstring 中の例題をチェックする

doctest を試す簡単な方法、(とはいえ、いつもそうする必要はないのですが) は、各モジュール `M` の最後を、以下:

    def _test():
        import doctest, M
        doctest.testmod()

    if __name__ == "__main__":
        _test()

のようにして締めくくるやりかたです。

こうすると、`doctest` は`M` 中の docstring を検査します。 モジュールをスクリプトとして実行すると、 docstring 中の例題が実行 され、検証されます:

    python M.py

ドキュメンテーション文字列に書かれた例の実行が失敗しない限り、何も 表示されません。失敗すると、失敗した例と、その原因が (場合によっては複数) 標準出力に印字され、最後に"`***Test Failed*** N failures.`"という行を出力します。ここで、N は失敗した例題の数です。

一方、-v スイッチをつけて走らせると:

    python M.py -v

実行を試みた全ての例について詳細に報告し、最後に各種まとめをおこなった 内容が標準出力に印字されます。

`verbose=True` を `testmod()` に渡せば、 詳細報告 (verbose) モードを強制できます。また、 `verbose=False` にすれば禁止できます。どちらの場合にも、 `testmod()` は `sys.argv` 上のスイッチ を調べません。(従って、-v をつけても効果はありません)。

`testmod()` の詳しい情報は5.2.7 節を 参照してください。