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

python中doctest如何嵌入源码?

冬宇大大_2242

冬宇大大_2242

发布时间:2025-12-02 20:50:02

|

420人浏览过

|

来源于php中文网

原创

doctest通过在文档字符串中嵌入交互式示例来测试代码,使用>>>表示输入和期望输出,运行方式包括在模块中调用doctest.testmod()或命令行执行python -m doctest,支持多行输出、异常处理及模糊匹配,适用于函数、类和模块的docstring,确保文档与代码一致性。

python中doctest如何嵌入源码?

在Python中,doctest通过将测试用例写在函数、类或模块的文档字符串(docstring)中来嵌入源码。这些测试看起来就像在交互式Python解释器中的输入输出,doctest会自动提取并运行它们。

基本格式:
在三引号的文档字符串里,使用>>>表示输入,后接期望的输出。例如:

def add(a, b):
    """
    返回两个数的和。

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

如何运行嵌入的doctest?

方法一:在代码末尾添加以下内容,直接运行模块:

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

保存为 calc.py 后,在命令行执行:
python calc.py —— 如果没有输出,说明所有测试通过。
加上 -v 参数可查看详细过程:python calc.py -v

方法二:从命令行单独运行doctest:

python -m doctest calc.py
python -m doctest -v calc.py  # 显示详情

支持多行输出与异常测试

doctest能处理复杂场景,比如多行返回值或异常:

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载

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

def divide(a, b):
    """
    执行除法,b为0时抛出异常。

    >>> divide(6, 2)
    3.0

    >>> divide(1, 3)  # doctest: +ELLIPSIS
    0.33...

    >>> divide(1, 0)  # doctest: +IGNORE_EXCEPTION_DETAIL
    Traceback (most recent call last):
    ZeroDivisionError: division by zero
    """
    return a / b
  • 使用 # doctest: +ELLIPSIS 可模糊匹配部分输出。
  • # doctest: +IGNORE_EXCEPTION_DETAIL 忽略异常类型的细节,只检查是否抛出指定异常。

适用位置灵活

doctest可嵌入:

  • 函数的 docstring
  • 类的 docstring
  • 模块的 docstring(文件开头)

只要包含符合格式的交互示例,都能被识别和执行。

基本上就这些。把测试写进文档,既保证了文档的准确性,又实现了轻量级测试。

相关文章

python速学教程(入门到精通)
python速学教程(入门到精通)

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

下载

相关标签:

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

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

墨刀AI
墨刀AI Hot

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

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

DeepSeek

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

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1818

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2864

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6184

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

5989

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

7594

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

11354

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

5839

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

6427

2025.08.07

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

20

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
兄弟连新版PHP视频教程
兄弟连新版PHP视频教程

共347课时 | 166.8万人学习

PHP 新手入门教程
PHP 新手入门教程

共54课时 | 31.8万人学习

Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

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

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