(Windows)Python 2.7 学习笔记 四十五 面向对象高级编程 — 文档测试

2019071142218

文档测试

如果你经常阅读 Python 的官方文档,可以看到很多文档都有示例代码。比如 re模块 就带了很多示例代码:

可以把这些示例代码在 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 内置的“文档测试”dectest)模块可以直接提取注释中的代码并执行测试。

doctest 严格按照 Python 交互式命令行的输入和输出来判断测试结果是否正确。只有测试异常的时候,可以用 表示中间一大段烦人的输出。

让我们用 doctest 来测试上次编写的 Dict 类:

运行 python mydict.py:

什么输出也没有。这说明我们编写的 doctest 运行都是正确的。如果程序有问题,比如把 __getattr__() 方法注释掉,再运行就会报错:

注意到最后两行代码。当模块正常导入时,doctest 不会被执行。只有在命令行运行时,才执行 doctest。所以,不必担心 doctest 会在非测试环境下运行。


doctest 非常有用,不但可以用来测试,还可以直接作为示例代码。通过某些文档生成工具,就可以自动把包含 doctest 的注释提取出来。用户看文档的时候,同时也看到了 doctest

发表评论

zh_CNChinese
zh_CNChinese