使用python做文档测试的方法

小编给大家分享一下使用python做文档测试的方法，希望大家阅读完这篇文章后大所收获，下面让我们一起去探讨吧！

看到Python的官方文档，很多都有示例代码，比如re模块就带了很多示例代码：

>>> import re
>>> m = re.search('(?<=abc)def', 'abcdef')
>>> m.group(0)
'def'

可以把示例代码在Python的交互式环境下输入执行，结果与文档的示例代码显示的一致。

当我们编写注释，写上下面的注释更友好：

def abs(n):
    '''
    Function to get absolute value of number.
 
    Example:
    >>> abs(1)
    1
    >>> abs(-1)
    1
    >>>abs(0)
    0
    '''
    return  n if n >= 0 else (-n)

好处：

•告诉函数的调用者该函数期望输入和输出

•Python内置的“文档测试”（doctest）模块可以直接提取注释中的代码并执行测试

•doctest 严格按照Python交互式命令行的输入和输出判断测试结果是否正确，只有测试异常的时候，可以用...表示一大推输出

看完了这篇文章，相信你对使用python做文档测试的方法有了一定的了解，想了解更多相关知识，欢迎关注亿速云行业资讯频道，感谢各位的阅读！