Python中的测试模块unittest和doctest的使用教程

为什么需要标准化测试

在实际开发中，许多脚本或第三方包缺乏完备的测试集，导致版本迭代时难以察觉隐蔽的逻辑缺陷。传统的调试方式多依赖控制台手动验证或重定向输出，虽然能发现基础报错，但无法提供自动化的完整性校验（Sanity Checks）。引入标准的测试模块，可以将验证逻辑固化到代码中，确保核心功能在不同环境下的行为一致。

使用doctest进行文档内联测试

第1步：在docstring中嵌入期望输出

目的：将预期运行结果直接绑定至函数说明中，实现代码即文档。
入口：目标函数的 """ 三引号文档字符串内部。
动作：模仿Python交互式会话，以 >>> 开头书写调用语句，下方紧跟精确的输出结果。注意空行会被解析为会话结束标记，因此复杂多行输出需借助辅助函数（如合并换行）进行预处理，并在代码中使用原始字符转义避免意外扩写。
重要参数：>>> 标识符，测试文件路径。
可观察的完成状态：文档字符串结构符合 doctest 解析规范，无语法缩进冲突或残留空白行。

import sys
from your_module import XML_Objectify, pyobj_printer, EXPAT, DOM

def show(xml_src, parser):
 """Self test using simple or user-specified XML data
 >>> xml = '''<?xml version="1.0"?>
 ... <Spam><Eggs>text</Eggs></Spam>'''
 >>> squeeze = lambda s: s.replace("\\n\\n","\\n").strip()
 >>> print(squeeze(show(xml, DOM)[0]))
 -----* _XO_Spam *-----
 {Eggs}
  PCDATA=text
 >>> print(squeeze(show(xml, EXPAT)[0]))
 -----* _XO_Spam *-----
 {Eggs}
  PCDATA=text
  PCDATA=
 """
 try:
  xml_obj = XML_Objectify(xml_src, parser=parser)
  py_obj = xml_obj.make_instance()
  return (pyobj_printer(py_obj).encode('UTF-8'), "SUCCESS")
 except Exception as e:
  return ("", f"FAILED ({parser}): {e}")

第2步：运行doctest执行检查

目的：自动提取并验证文档字符串中的示例。
入口：脚本主程序块或独立测试入口。
动作：调用 doctest.testmod() 并传入包含文档的模块对象。该函数会递归扫描模块级属性、函数及类中的所有文档字符串，匹配交互格式并执行比对。
重要参数：verbose=True 可在控制台打印每一步的详细过程；默认静默模式仅在失败时报错。
可观察的完成状态：终端输出包含每个用例的 ok 或 FAILED 状态，以及最终通过的测试总数。

使用unittest构建结构化测试

第1步：定义测试类与方法

目的：将离散的检查项归类管理，支持批量调度。
入口：继承自 unittest.TestCase 的新类。
动作：在类内部创建以 test_ 开头的方法，每个方法代表一个独立的业务场景。命名建议明确表达意图，例如 testNoNamespace。
重要参数：类名与方法命名规则。
可观察的完成状态：测试框架启动后能准确识别并逐一调用所有 test_* 方法。

第2步：设置前置清理与断言校验

目的：隔离测试环境依赖，精准定位逻辑失败点。
入口：重写 setUp()（测试前初始化）与 tearDown()（测试后恢复/清理）方法。
动作：在 setUp 中备份全局配置或创建临时文件；在 tearDown 中还原环境防止污染。测试体内使用断言方法，如 self.assertRaises(ExpectedError, func, args) 验证异常是否按预期抛出，或使用 self.failUnless(condition) 确认返回值/状态。
重要参数：raises 指定的异常类型，断言方法的布尔条件。
可观察的完成状态：日志清晰区分 FAIL（断言未达标，预期内的逻辑校验失败）与 ERROR（突发异常，需排查回溯堆栈）。

import unittest
from os.path import isfile
from your_module import XML_Objectify, config_nspace_sep, make_instance

class ExpatTest(unittest.TestCase):
 def setUp(self):
  self.orig_nspace = XML_Objectify.expat_kwargs.get('nspace_sep', '')
 
 def testNamespaceFailure(self):
  """Raise SyntaxError on non-setup namespace XML"""
  self.assertRaises(SyntaxError, make_instance, 'testns.xml')
 
 def testNamespaceSuccess(self):
  """Successfully objectify NS after setup"""
  config_nspace_sep(None)
  o = make_instance('testns.xml')
  self.assertIsNotNone(o)
 
 def tearDown(self):
  XML_Objectify.expat_kwargs['nspace_sep'] = self.orig_nspace
if __name__ == '__main__':
 unittest.main()

第3步：自定义测试运行器与结果捕获

目的：灵活控制输出流，便于集成到CI/CD管道或GUI界面。
入口：unittest.TestRunner 子类实例化调用。
动作：创建 TestSuite 并通过 addTest 添加指定类。使用 TextTestRunner(stream=io_string) 将标准输出重定向至内存对象。获取返回的 result 对象后，可通过 wasSuccessful() 判断整体成败，遍历 failures 与 errors 列表提取详细信息。
重要参数：stream 输出目标，verbosity 详细程度等级（1~3）。
可观察的完成状态：非阻塞模式下获得结构化结果字典，可随时写入文件或展示于面板。

组合多模块测试套件

随着项目扩展，单一脚本的测试已无法满足需求。标准库提供了跨模块聚合能力。通过 doctest.DocTestSuite() 可将文档内嵌用例转换为标准的 unittest 测试套件，再与原生的 makeSuite 合并执行。统一使用 TextTestRunner(verbosity=2).run(suite) 驱动。运行后终端将按顺序输出各模块的校验结果。当某个必需的外部文件缺失或依赖损坏时，前置条件测试会拦截后续流程并报告 FAIL 或 ERROR，有效收敛故障范围。这种组合策略使得新旧代码、不同解析器的测试用例能够在一次执行中完成交叉验证。

总结

掌握 doctest 的轻量子集校验与 unittest 的工程化断言架构，是构建高可用Python项目的基石。将测试代码与业务逻辑同步演进，不仅能显著降低回归风险，还为后续的性能调优与API重构提供安全网。以上就是Python单元测试模块doctest与unittest详细用法的详细内容，更多关于Python标准库进阶应用资料的内容请关注本站其它相关文章！