doctest通过解析函数或模块的文档字符串中以>>>开头的交互式示例,自动执行并验证输出是否匹配,确保代码示例正确性。

doctest库是Python标准库中的一个模块,用于从文档字符串(docstring)中提取示例代码并运行测试。它的设计目标是通过在函数说明中写实际的交互式Python使用示例,来验证代码是否按预期工作。
如何使用doctest
你可以在函数或模块的文档字符串里写像在Python解释器中输入一样的代码和期望输出,doctest会自动查找这些内容并执行。
例如:
def add(a, b):
"""
返回两个数的和。
示例:
>>> add(2, 3)
5
>>> add(-1, 1)
0
"""
return a + b
if __name__ == "__main__":
import doctest
doctest.testmod()
当你运行这个脚本时,doctest会检查add函数中的示例是否正确。如果没有输出,说明所有测试通过。
doctest的工作原理
doctest会扫描Python对象(如函数、类、模块)的文档字符串,寻找看起来像Python交互式会话的内容(即以>>>开头的行),然后执行这些代码,并比对实际输出是否与文档中写的一致。
立即学习“Python免费学习笔记(深入)”;
它主要匹配:
- 以
>>>开始的输入行 - 紧随其后的期望输出(不带前缀)
适用场景和注意事项
doctest特别适合写简单清晰的示例,并保证示例不会过时。常用于教学文档、小型工具函数或希望文档和代码同步的项目。
需要注意的几点:
- 输出必须完全匹配,包括空格和类型(比如
True不能写成true) - 浮点计算可能因精度问题失败,可用
#doctest: +ELLIPSIS或近似匹配技巧 - 不适合复杂测试,大型项目建议用unittest或pytest











