如何在 Python 的文档中写测试 - doctest 指南

在Python中，doctest是一个内置的模块，用于测试和文档化代码。它允许你在文档字符串中嵌入测试示例，并自动运行这些示例来验证代码的正确性。doctest通过在文档字符串中使用特殊的注释语法来编写测试用例，并执行这些测试来确保代码的正确性。

doctest 格式

其实 doctest 这个命名已经透露出了它的一些信息了。

我们需要将 doctest 写在文档字符串中，也就是 """ 中间，比如下面这个：

"""
>>> add(2, 3)
5
"""

这里表示一个测试用例，表示调用了 add(2, 3) 之后，会返回结果 5。

注意：需要严格按照上面的格式来写 doctest，也就是 >>> 开头接测试代码，然后接下来一行写测试结果。

下面是更加详细的讲解。

三步实现 Doctest 测试

1. 在文档中加入测试用例

def