doctest Python

简介

doctest 是 Python 内置的一个模块，用于测试代码中的文档字符串。它可以让我们在编写文档字符串的同时，编写测试用例，方便我们对代码进行测试和验证。

在编写 doctest 测试用例时，我们可以使用 Python 解释器来执行这些测试用例，检查结果是否符合预期。当代码通过 doctest 测试时，我们可以非常自信地说这段代码具有高可靠性。

使用方法

编写测试用例

在编写测试用例时，我们只需要在文档字符串中添加测试用例即可。测试用例的格式为：在每个文档字符串行的开头添加 >>>，然后紧跟着代码片段。如下所示：

def add(a, b):
    """
    Add two numbers.

    >>> add(1,2)
    3
    >>> add(0,-1)
    -1
    >>> add(0,0)
    0
    """
    return a + b

在上面的例子中，我们给 add() 函数添加了三个测试用例，分别计算了不同的输入值的和。每个测试用例都是一行文本，以 >>> 开头，后面紧跟代码片段。代码片段下面的一行是期望的输出结果。

运行测试用例

当我们编写好了测试用例后，我们可以使用 Python 解释器来运行这些测试用例，检查代码的正确性。使用以下命令来运行测试用例：

python -m doctest [文件名]

其中，[文件名] 是你要运行测试用例的 Python 文件。例如，如果你的测试用例在 example.py 文件中，你可以使用以下命令来运行测试：

python -m doctest example.py

当测试用例执行完成后，如果没有出现异常信息，说明测试通过。如果有任何一组测试用例没有通过，我们就需要检查代码并修复错误。

注意事项

• 使用 doctest 时，我们需要仔细编写测试用例，尽量包含所有的情况和边界条件，以确保代码的正确性。
• doctest 可以很好地测试代码中的函数，但并不适合测试实际GUI操作，比如画图等，需要其他的测试方式来进行。
• 在运行 doctest 时，需要保证文件中的所有模块都已经被导入，否则测试可能会失败。