前書き

Doctestは、Pythonプログラムのシンプルですが便利なテスト方法です。単体テストと比較して、doctestはテストケースを作成するために独立したスクリプトを必要としません。テストケースは、Python関数のドキュメント情報（トリプルシングル/ダブルクォート内のコンテンツ）に書き込むことができます。次に、これらのケースは、doctestモジュールを使用して機能をテストできます。

doctestそして、Pythonの対話セッションのような外観、そしてが示すように、彼らが正確に動作することを確認するために、これらのセッションを実行するテキストの一部のモジュールを検索します。（Pythonドキュメント）

簡単な例

間違ったabs()関数にdoctestを使用しましょう：

結果は次のとおりです。

上記の例が示しているように、doctestは、関数をテストするための非常に便利で簡単な方法です。

一言で言えば、たった3つのステップがあります。

• インポートdoctestモジュール
• を使用して、トリプル一重引用符/二重引用符でテストケースを記述します
• doctest.testmod()doctestの実行に使用

すべてのテストケースに合格した場合、doctestは何も出力しません。

Doctestのその他のヒント

1.詳細情報を印刷するには

ではdoctest.testmod、と呼ばれる重要なパラメータがありますverbose。

Falseデフォルトではに設定されています。つまり、テストの実行時に、失敗したケースのみが詳細情報を出力します。すべてのケースの完全な情報を取得したい場合は、に設定してくださいTrue。

if __name__ == '__main__':
    doctest.testmod(verbose=True)

実際には、if __name__ == '__main__':ブロックを書き込む必要はありません。ターミナルで直接doctestを実行できます。

$ python -m doctest wrong_abs.py

$ python -m doctest -v wrong_abs.py

関数の下にコメントとテストケースの両方を配置すると、少し面倒になることがあります。心配はいりません。すべてのテストケースを独立したファイルに入れても、doctestを完全に実行できます。

たとえば、というファイルを作成し、test_cases.txtその中に「doctestスタイル」のテストケースを入れましょう。

次に、次のコマンドでdoctestを実行します。

python -m doctest test_cases.txt

結論

Doctestは、Pythonプログラム用の使いやすいテスト方法です。この手法をうまく使用すると、バグのないコードを取得するのに役立ちます。

読んでくれてありがとう。

関連記事：

Pythonプログラマーのための6つのデバッグ手法

その他のPythonチュートリアル：

究極のPythonチュートリアル（更新を続ける）