Python模块——doctest

qq78707

　　doctest在docstring的部分加入测试代码，以一种简单的方式进行测试。
　　示例代码：
#dtest.py　　
import doctest
　　

　　
def add(x, y):
　　
    """
　　
    >>> add(1, 2)
　　
    3
　　
    """
　　
    return x + y
　　

　　
def main():
　　
    pass
　　

　　
if __name__ == '__main__':
　　
    main()
　　运行python -m doctest -v dtest.py
　　如果doctest通过，不会有任何输出。可以加-v参数来查看测试细节。
　　注意的地方
　　1.">>>"与测试代码之间有个空格。
　　2.期望的测试结果与docstring之间要有一个空行。
"""　　
>>> add(1, 2)
　　
3
　　
a docstring   #这个会被认为是测试输出的一部分
　　
"""
　　应该写成这样
"""　　
>>> add(1, 2)
　　
3
　　

　　
a docstring
　　
"""
　　作用
　　官方文档提到的应用情景：
　　1.通过验证例子（doctest）检查模块的docstring是最新的。
　　有时候会出现代码已经改变但docstring没有更新的情况，在docstring中加入doctest可以尽量避免这种情况的发生。
　　2.回归测试
　　我的理解是当测试未通过的时候，可以把用例写在docstring里，可以方便的进行回归测试。
　　3.作为包或库的教程示例
　　一个可以执行的示例比大段的说明性文字更直观有效
　　相比于unittest模块，doctest功能比较简单，可以很轻松的拿来用，是大型测试框架的有机补充。
　　参考
　　[1] http://docs.python.org/release/2.6.8/library/doctest.html
　　[2] http://www.doughellmann.com/PyMOTW/doctest/