什么是Python文档测试？

文档测试(doctest)是Python内置的测试框架，允许你将测试用例直接写在函数的文档字符串(docstring)中。这些测试用例看起来像是从Python交互式解释器中直接复制出来的会话内容。

基础语法与示例

文档测试的基本语法是在文档字符串中写入看起来像Python交互式会话的内容：

def add(a, b):
    """
    返回两个数字的和
    
    >>> add(2, 3)
    5
    >>> add(-1, 1)
    0
    >>> add(0.5, 0.5)
    1.0
    """
    return a + b

文档测试规则：

• 以>>>开头的行表示Python代码
• 下一行表示预期输出结果
• 如果预期没有输出，使用空白行表示
• 测试用例放在函数的文档字符串中

运行文档测试

方法1：通过命令行运行

python -m doctest your_module.py

方法2：在代码中添加测试运行器

if __name__ == "__main__":
    import doctest
    doctest.testmod()

实际应用示例

示例1：数学函数测试

def factorial(n):
    """
    计算n的阶乘
    
    >>> factorial(0)
    1
    >>> factorial(1)
    1
    >>> factorial(5)
    120
    >>> factorial(10)
    3628800
    """
    if n == 0:
        return 1
    else:
        return n * factorial(n-1)

示例2：字符串处理函数

def reverse_string(s):
    """
    反转字符串
    
    >>> reverse_string('hello')
    'olleh'
    >>> reverse_string('Python')
    'nohtyP'
    >>> reverse_string('')
    ''
    >>> reverse_string('a')
    'a'
    """
    return s[::-1]

文档测试最佳实践

优势与局限性