0

0

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

舞姬之光

舞姬之光

发布时间:2025-12-02 23:11:25

|

923人浏览过

|

来源于php中文网

原创

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

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

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

基本原理

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

1. 创建独立的 doctest 文件

新建一个文本文件,例如 my_module_test.txt,内容如下:

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

函数示例说明
>>> 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() 函数来运行独立的测试文件:

艺帆网络工作室网站源码1.7.5
艺帆网络工作室网站源码1.7.5

艺帆网络工作室网站源码,是国庆后新一批新概念的网站源码,采用流行的Html5和JS组合流畅顺滑,界面清晰明朗,适合科技类企业和公司建站使用。如果你是想成为一家独特的设计公司,拥有独特的文化,追求品质,而非数量与规模。 这种坚持一直贯穿于项目运作之中,从品牌建立、形象推广设计到品牌形象管理。那可以考虑使用这款艺帆网络工作室网站源码。 这款源码中服务项目和团队程序需要在_template文件夹下的in

下载
# 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)

4. 注意事项

确保独立测试文件中的导入语句正确,能访问到被测函数。

  • 测试文件中的代码像真实交互一样运行,所以需要显式导入模块
  • 路径问题要处理好,建议使用相对路径配合 os.path.joinpathlib
  • 输出必须完全匹配,包括引号、空格和换行

基本上就这些。用独立文件管理 doctest 能让文档测试更清晰,也方便协作维护。

相关文章

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

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

下载

相关标签:

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

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

756

2023.06.15

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

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

636

2023.07.20

python能做什么
python能做什么

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

760

2023.07.25

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

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

618

2023.07.31

python教程
python教程

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

1264

2023.08.03

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

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

548

2023.08.04

python eval
python eval

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

578

2023.08.04

scratch和python区别
scratch和python区别

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

708

2023.08.11

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
【web前端】Node.js快速入门
【web前端】Node.js快速入门

共16课时 | 2万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.0万人学习

手把手实现数据传输编码
手把手实现数据传输编码

共1课时 | 725人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号