doctest模块通过检查文档字符串中的交互式示例测试代码,运行并验证输出是否一致。1. 在函数或模块的文档字符串中写入类似Python交互的示例;2. 使用doctest.testmod()在程序内运行测试,添加verbose=True可查看详细结果;3. 可测试异常情况,用…跳过traceback中易变内容;4. 支持从独立文本文件如test.txt加载测试用例,通过doctest.testfile()执行;5. 输出需完全匹配,注意浮点精度、空格和换行,可用#doctest: +ELLIPSIS等控制比对行为;6. 文档中空行用<BLANKLINE>表示;7. doctest适用于简单示例和文档验证,复杂场景建议结合unittest或pytest使用。

doctest模块通过检查文档字符串中的交互式Python示例来测试代码是否按预期运行。它查找类似于Python解释器会话的文本,然后实际运行这些代码并验证输出是否一致。
基本用法
在函数或模块的文档字符串中写入Python交互示例:
def add(a, b): “”” 返回两个数的和。
>>> add(2, 3) 5 >>> add(-1, 1) 0 """ return a + b
在文件末尾添加以下代码以运行测试:
立即学习“”;
if __name__ == “__mn__”: import doctest doctest.testmod()
运行该Python文件,如果所有示例输出正确,不会有任何输出;加上verbose=True可看到详细结果:
doctest.testmod(verbose=True)
测试异常情况
可以测试函数是否会引发特定异常:
网上购物商城,它属于BtoC电子商务网站平台,它能够直接绕过中介(如批发商、销售商或经销商)建立与客户的直接关系。该网站可以为用户提供商品的详细信息,用户可以在线购买商品,确定镇定的订单;同时提供关于商品或电子零销商的选择建议等等。网上购物平台使得人们的购买变的更方便、更加容易。 前台功能模块有: 热销商品 订单管理 购物车 结算中心 注册会员 用户登录
0 def divide(a, b): “”” 除法运算,b为0时抛出异常。
>>> divide(4, 2) 2.0 >>> divide(1, 0) Traceback (most recent call last): ... ZeroDivisionError: division by zero """ return a / b
使用...表示异常 traceback 中可能变化的部分,避免因行号不同导致测试失败。
从独立文件运行测试
也可以将测试写在纯文本文件中:
# test.txt >>> from your_module import add >>> add(3, 4) 7
用以下方式加载并运行:
doctest.testfile(“test.txt”)
常见注意事项
注意输出必须完全匹配,包括类型、空格和换行。例如:
- 浮点数精度要一致,可使用
#doctest: +ELLIPSIS忽略部分细节 - 集合、字典的顺序不固定,可用
#doctest: +IGNORE_EXCEPTION_DETAIL等选项控制比对方式 - 在文档字符串中加入空行需用
<BLANKLINE>占位
基本上就这些。doctest适合简单直观的示例测试,尤其是写文档时附带验证功能。复杂场景建议搭配unittest或pytest。
以上就是中doctest模块如何使用?的详细内容,更多请关注php中文网其它相关文章!
微信扫一扫打赏
支付宝扫一扫打赏
