python中doctest文档测试

doctest

doctest为python自带一个测试模块，他会搜索模块中看起来像是交互式会话的代码片段，然后执行并验证结果；

使用方式1：

1、测试用例的位置必须放在整个模块文件的开头，或者紧接着对象声明语句的下一行。也就是可以被 __doc__ 这个属性引用到的地方。并非像普通注释一样写在哪里都可以。

2、verbose 参数用于控制是否输出详细信息，默认为 False，如果不写，那么运行时不会输出任何东西，除非测试 fail。

3、启动测试的方式是在 __main__ 函数里调用了 doctest.testmod() 函数。

举例：

#coding : UTF-8
import doctest
def multiply(v1,v2):
    """
    >>> multiply(10,8)
    80
    >>> multiply("zhangsan,",5)
    'zhangsan,zhangsan,zhangsan,zhangsan,zhangsan,'
    """
    return v1 * v2
def main():
    doctest.testmod(verbose=True)
if __name__ == "__main__":
    main()

 

 

C:\Users\USER\AppData\Local\Programs\Python\Python38\python.exe "D:/Python 3.8/pycharm/mysql/pytest.py"
Trying:
multiply(10,8)
Expecting:
80
ok
Trying:
multiply("zhangsan,",5)
Expecting:
'zhangsan,zhangsan,zhangsan,zhangsan,zhangsan,'
ok
2 items had no tests:
__main__
__main__.main
1 items passed all tests:
2 tests in __main__.multiply
2 tests in 3 items.
2 passed and 0 failed.
Test passed.

Process finished with exit code 0

 

使用方式二：
在没有main函数的情况下，可以使用命令行来启动测试；
python -m doctest test_doctest.py

使用方式三：
把测试用例写到一个独立文件中，如下：
testfile.txt
>>> from test import multiply
>>> multiply(2,3)
6
>>> multiply('aaa',2)
'aaaaaa'

运行方式如下：
import doctest

doctest.testfile（'testfile.txt'）