インタラクティブなPythonの例をテストする（doctest）

Pythonの標準ディストリビューションには「doctest」モジュールが含まれています。このモジュールの機能により、インタラクティブなPythonセッションのように見えるテキストを検索し、これらのセッションを実行して、表示されているとおりに機能するかどうかを確認できます。これらの例は、クラス、モジュール、または関数のdocstring式から抽出されています。 Doctestは、付随するテキストファイルのテキストファイルから実行することもできます。

Pythonでは、「docstring」は、クラス、関数、またはモジュールの最初の式として表示される文字列リテラルです。スイートの実行時には無視されますが、コンパイラによって認識され、囲んでいるクラス、関数、またはモジュールの__doc__属性に入れられます。

docstringは通常、Pythonコードのさまざまな部分の使用例を説明するために配置されます。 doctestモジュールを使用すると、これらのdocstringがコードの断続的なリビジョンで最新であることを確認できます。

次のコードでは、階乗関数が使用例を散在させて定義されています。使用例が正しいかどうかを確認するには、doctestモジュールでtestmod（）関数を呼び出します。

def add(a,b):
'''
>>> add(10,20)
30
>>> add('aaa','bbb')
'aaabbb'
>>> add('aaa',20)
Traceback (most recent call last):
...
TypeError: must be str, not int
'''
return a+b

まず、上記のスクリプトをmytest.pyとして入力して保存し、コマンドラインからこのスクリプトを実行してみてください。

Python mytest.py

例が失敗しない限り、出力は表示されません。次に、コマンドラインを

Python mytest.py –v

F:\Python36>python mytest.py -v
Trying:
add(10,20)
Expecting:
30
ok
Trying:
add('aaa','bbb')
Expecting:
'aaabbb'
ok
Trying:
add('aaa',20)
Expecting:
Traceback (most recent call last):
...
TypeError: must be str, not int
ok
1 items had no tests:
__main__
1 items passed all tests:
3 tests in __main__.add
3 tests in 2 items.
3 passed and 0 failed.
Test passed.

Using ''add''
-------------------
This is an example text file . First import
''add'' from the ''mytest'' module:
>>> from mytest import add
>>> add(10,20)
30

def add(a,b):
return a+b
if __name__ == "__main__":
import doctest
doctest.testfile("example.txt")