从0到1精通自动化测试，pytest自动化测试框架，doctest测试框架（十四）

一、前言

doctest从字面意思上看，那就是文档测试。doctest是python里面自带的一个模块，它实际上是单元测试的一种。
官方解释：doctest 模块会搜索那些看起来像交互式会话的 Python 代码片段，然后尝试执行并验证结果

doctest测试用例可以放在两个地方

1. 函数或者方法下的注释里面
2. 模块的开头

二、案例

先看第一个案例，将需要测试的片段,标准格式，需要运行的代码前面加>>> ,相当于进入cmd这种交互环境执行，期望的结果前面不需要加 >>>

>>> multiply(4, 3)
    12
>>> multiply('a', 3)
    'aaa'

放到multiply函数的注释里

def multiply(a, b):
    """
    fuction: 两个数相乘
    >>> multiply(4, 3)
    12
    >>> multiply('a', 3)
    'aaa'
    """
    return a * b
if __name__ == '__main__':
    import doctest
    doctest.testmod(verbose=True)

运行结果

Trying:
    multiply(4, 3)
Expecting:
    12
ok
Trying:
    multiply('a', 3)
Expecting:
    'aaa'
ok
1 items had no tests:
    __main__
1 items passed all tests:
   2 tests in __main__.multiply
2 tests in 2 items.
2 passed and 0 failed.
Test passed.

从运行的结果可以看出，虽然函数下方的注释里面有其它内容“fuction: 两个数相乘”，但不会去执行，只识别“>>>”这种符号。2个测试用例都是通过的，实际的结果与期望的结果一致

三、失败案例

doctest的内容放到.py模块的开头也是可以识别到的

# 保存为xxx.py
'''
fuction: 两个数相乘
>>> multiply(4, 8)
12
>>> multiply('a', 5)
'aaa'
'''