讲师中心 微信公众号
AI工具推荐 视频效率加速

Python中doctest模块如何直接测试文档中的示例代码?

陌芳酱_4338

陌芳酱_4338

发布时间:2026-10-13 10:07:10

|

397人浏览过

|

来源于php中文网

原创

doctest 严格比对文档字符串中模拟 Python REPL 的代码示例与实际输出,要求格式完全一致:包括 >>> 后空格、... 省略符、空行、异常 traceback 全貌等,任何空白或 repr 差异均导致失败。

python中doctest模块如何直接测试文档中的示例代码?

doctest 能直接运行文档字符串里的代码示例,但前提是示例格式必须严格匹配 Python 交互式会话的输出——包括提示符 >>>、省略号 ... 的用法、空行规则,以及异常 traceback 的完整写法。

doctest 示例必须严格模拟 Python REPL 输出

它不是“执行任意代码”,而是把文档字符串当作一段真实的交互日志来比对。任何格式偏差都会导致测试失败,哪怕只是多了一个空格或少了一行空行。

  • >>> 后必须紧跟一个空格,然后才是语句;...(三个英文点)用于表示被省略的 traceback 行或长输出,不能写成 … 或 ...(中文省略号或四点)
  • 表达式结果要写在下一行,且**不能带 >>> 或 ... 前缀**;如果结果是空行(比如函数返回 None),文档里就得真写一个空行
  • 异常测试必须包含完整的 Traceback (most recent call last): 行、错误类型和消息,且所有行都要原样写出(可配合 ... 省略中间帧)
def add(a, b):
    """
    >>> add(2, 3)
    5
    >>> add('a', 'b')
    'ab'
    >>> add(1, '2')
    Traceback (most recent call last):
      ...
    TypeError: unsupported operand type(s) for +: 'int' and 'str'
    """
    return a + b

运行 doctest 的三种常用方式

最直接的是用命令行跑整个模块:python -m doctest module.py;但默认不输出成功项,容易误以为没跑——加 -v 才能看到每个示例的通过/失败详情。

python-parallelization
python-parallelization

将顺序 Python 代码转换为并行/并发实现,用于在需要并行化 Python 代码、提升性能时使用。

下载
  • 在模块末尾加 if __name__ == '__main__': doctest.testmod(),然后 python module.py 运行;testmod() 默认只检查当前模块,不会递归导入的模块
  • 用 doctest.testfile('example.txt') 单独测试纯文本文件(如 README.rst),但文件里仍需用 >>> 标记代码块,且路径需手动指定
  • 在 IDE(如 PyCharm)中右键运行时,可能默认不启用 doctest 支持,需确认是否勾选了 “Run doctests” 或在配置里指定 -m doctest

常见失败原因:空格、换行、repr 差异

doctest 对空白字符极其敏感。比如 print('hello') 的输出是 hello\n,而文档里如果写成 'hello'(带引号)就变成 repr() 结果,二者不等价。

立即学习“Python免费学习笔记(深入)”;

  • 字典、集合、浮点数顺序或精度不一致:Python 3.7+ 字典有序,但旧版本无序;浮点计算结果可能因平台略有差异,建议用 round(x, 5) 或正则断言
  • 系统相关输出(如文件路径、时间戳)无法固定,应避免写进 doctest;若必须测试,可用 # doctest: +ELLIPSIS 或 # doctest: +SKIP 控制行为
  • 多行字符串中的换行符在 Windows 和 Unix 下可能不同,建议统一用 \n 并在 docstring 中用原始字符串 r"""..."""

真正难的不是写几个示例,而是让所有示例在不同环境、不同 Python 版本、不同终端宽度下都稳定通过——这要求你对输出的每一处空格、换行、repr 规则都有明确预期。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

1731

2023.07.20

python能做什么
python能做什么

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

4384

2023.07.25

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

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

1689

2023.07.31

python教程
python教程

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

25597

2023.08.03

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

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

3127

2023.08.04

python eval
python eval

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

3127

2023.08.04

scratch和python区别
scratch和python区别

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

1183

2023.08.11

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

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

596

2023.08.10

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

80

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn