doctest模块通过检查文档字符串中的交互式示例测试代码,运行并验证输出是否一致。1. 在函数或模块的文档字符串中写入类似Python交互的示例;2. 使用doctest.testmod()在程序内运行测试,添加verbose=True可查看详细结果;3. 可测试异常情况,用...跳过traceback中易变内容;4. 支持从独立文本文件如test.txt加载测试用例,通过doctest.testfile()执行;5. 输出需完全匹配,注意浮点精度、空格和换行,可用#doctest: +ELLIPSIS等控制比对行为;6. 文档中空行用表示;7. doctest适用于简单示例和文档验证,复杂场景建议结合unittest或pytest使用。
doctest模块通过检查文档字符串中的交互式Python示例来测试代码是否按预期运行。它查找类似于Python解释器会话的文本,然后实际运行这些代码并验证输出是否一致。
在函数或模块的文档字符串中写入Python交互示例:
def add(a, b): """ 返回两个数的和。>>> add(2, 3) 5 >>> add(-1, 1) 0 """ return a + b
在文件末尾添加以下代码以运行测试:
if __name__ == "__main__": import doctest doctest.testmod()运行该Python文件,如果所有示例输出正确,不会有任何输出;加上verbose=True可看到详细结果:
=True)
可以测试函数是否会引发特定异常:
def divide(a, b): """ 除法运算,b为0时抛出异常。>>> divide(4, 2)
2.0
>>> divide(1, 0)
Traceback (most recent call last):
...
ZeroDivisionError: division by zero
"""
return a / b使用...表示异常 traceback 中可能变化的部分,避免因行号不同导致测试失败。
也可以将测试写在纯文本文件中:
# test.txt >>> from your_module import add >>> add(3, 4) 7用以下方式加载并运行:
doctest.testfile("test.txt")注意输出必须完全匹配,包括类型、空格和换行。例如:
#doctest: +ELLIPSIS忽略部分细节#doctest: +IGNORE_EXCEPTION_DETAIL等选项控制比对方式占位基本上就这些。doctest适合简单直观的示例测试,尤其是写文档时附带验证功能。复杂场景建议搭配unittest或pytest。