doctest.testfile()を使ってドキュメント兼テストコードを作成 #Python

doctest.testfile()が便利そうな気がしたのでメモ

dcotest.testmod()はソースコード中のコメントにある例をテストしていて，
これも便利だと思っていたけど，コメントが多くなってしまいがち

example.txt

Example of hoge
 python hoge.py -v
=========================

adder() receives two arguments and returns
the sum of them

 >>> from hoge import adder
 >>> adder(1, 2)
 3
 >>> adder('doc', 'test')
 'doctest'

hoge.py

import doctest

def adder(a, b):
    return a + b

if __name__ == "__main__":
    doctest.testfile('./example.txt')