Python3 doctest — 通过文档来测试
Python 的 doctest 模块提供了一种将文档字符串作为测试的方法。在文档字符串中,可以包含可执行的 Python 代码,并且这些代码会被自动执行以检查其是否按预期工作。
以下是一个简单的示例:
def add(x, y):
"""
这是一个加法函数的文档字符串。
示例:
>>> add(1, 2)
3
"""
return x + y
if __name__ == '__main__':
import doctest
doctest.testmod()
在这个例子中,当你运行这段代码时,doctest 会找到 add
函数中的文档字符串,并执行其中的 >>> add(1, 2)
示例。如果函数返回的结果是 3,测试就会通过。如果不是,测试就会失败。这是一种在代码中自我测试的简单方法,可以确保文档和代码的一致性。
评论已关闭