如何使用Python中的doctest编写交互式文档测试_直接在注释中运行

浅丽吖_9139

浅丽吖_9139

2026-05-20

788人浏览

原创

doctest通过扫描文档字符串中以>>>开头的交互式示例并执行比对来验证代码正确性,要求输出严格匹配repl格式,支持ellipsis等选项灵活处理动态内容。

如何使用python中的doctest编写交互式文档测试_直接在注释中运行

doctest 能直接运行文档字符串里的 Python 交互示例,但必须严格匹配 REPL 输出格式,否则看似正确的代码也会失败。

doctest 识别哪些内容为测试用例

只扫描函数、类、模块的 __doc__ 字符串中形如 >>> 开头的行,紧随其后的 Python 表达式或语句会被执行;下一行如果是预期输出(不以 >>> 或 ... 开头),就参与比对。

  • >>> 后必须有空格,>>>print(1) 不被识别,正确写法是 >>> print(1)
  • 多行语句用 ... 续行,且 ... 后必须跟空格(... x = 1)
  • 输出比对区分空格、换行、引号类型('a' ≠ "a"),print() 的换行也需显式写出
  • 异常测试要写完整 traceback,从 Traceback (most recent call last): 到异常类型和消息

运行 doctest 的三种常用方式

最轻量的是在模块末尾加 if __name__ == '__main__': doctest.testmod(),运行 python mymodule.py 即可;命令行方式更灵活:

Claw Code Suite (Python-Only Edition)
Claw Code Suite (Python-Only Edition)

仅使用 Python 将 Claw Code 虚拟化框架与 OpenClaw 集成,提供 184 种工具和 200 多条命令,用于安全分析和代码质量...

下载
  • python -m doctest mymodule.py:默认只报告失败,加 -v 显示全部结果
  • python -m doctest -o ELLIPSIS mymodule.py:启用 ELLIPSIS 选项,允许用 ... 匹配任意子串(比如长 traceback 中间部分)
  • python -m doctest -o NORMALIZE_WHITESPACE mymodule.py:忽略输出中多余的空格和换行差异(慎用,可能掩盖格式 bug)

常见失败原因与绕过技巧

最常踩的坑是浮点数精度、集合/字典顺序、对象内存地址等非确定性输出:

  • 浮点计算结果(如 0.1 + 0.2)建议用 round(x, 10) 或 math.isclose(),不要直接写期望值 0.30000000000000004
  • 字典和集合在 Python 3.7+ 虽有序,但 doctest 里仍建议用 sorted(d.items()) 或转成 list(d.keys()) 再断言
  • 含 <__main__.x object at></__main__.x> 的输出,用 ELLIPSIS 选项配合 ... 替换地址段
  • 时间相关输出(如 datetime.now())不适合写死,应改用固定时间戳或 mock

doctest 不适合测试什么

它不是单元测试替代品,而是文档验证工具。以下情况应换用 unittest 或 pytest:

  • 需要 setup/teardown(如临时文件、数据库连接)
  • 测试逻辑分支多、输入组合复杂,文档里写满示例反而干扰阅读
  • 涉及 I/O、网络、外部依赖,稳定性差且难以复现
  • 想做参数化测试(@parameterized)或并发测试

真正有效的 doctest,是那些用户复制粘贴就能跑通的「活文档」——所以每一行都要经得起真实 REPL 检验,而不是为了通过测试而妥协输出格式。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1771

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4604

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1729

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27157

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3287

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3287

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2563

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习