python中doctest如何放到独立文件？

舞姬之光 2025-12-02 00:00:00 次阅读

答案是：doctest可通过testfile()函数从独立文件运行测试，保持源码整洁。创建如my_module_test.txt的文本文件，包含>>>开头的交互式样例；用doctest.testfile()加载并执行，推荐将测试文件放入tests目录，通过os.path.join处理路径，确保导入正确且输出完全匹配，适合测试内容多时的项目结构管理。

在 Python 中，doctest 可以从源代码中移出，放到独立的文件中进行管理。这样做有助于保持源码整洁，尤其适合文档测试内容较多的情况。

基本原理

doctest 模块支持从外部文本文件中加载并运行测试。这些文件可以是纯文本格式，包含交互式 Python 会话的样例（即以 >>> 开头的代码行和对应的输出）。

1. 创建独立的 doctest 文件

新建一个文本文件，例如 my_module_test.txt，内容如下：

函数示例说明
>>> from my_module import add
>>> add(2, 3)
5
字符串拼接
>>> from my_module import greet
>>> greet("Alice")
'Hello, Alice'

注意：文件中不需要写 if name == 'main'，只需要模拟交互式解释器的内容即可。

2. 在代码中加载外部 doctest 文件

使用 doctest.testfile() 函数来运行独立的测试文件：

# test_runner.py
import doctest

if __name__ == '__main__':
    doctest.testfile('my_module_test.txt', verbose=True)

运行这个脚本就会执行 my_module_test.txt 中的所有测试。

常见参数：

verbose=True：显示详细执行过程
module_relative=False：若测试文件在模块路径外，可设为 False 并用相对或绝对路径
encoding='utf-8'：指定文件编码

3. 推荐项目结构

将测试文件组织到专门目录中，例如：

project/
│
├── my_module.py
├── tests/
│   └── my_module_test.txt
└── run_tests.py

在 run_tests.py 中：

import doctest
import os

if __name__ == '__main__':
    test_file = os.path.join('tests', 'my_module_test.txt')
    doctest.testfile(test_file, module_relative=False, verbose=True)