【python学习】python的doctest模块测试

中国史之【商铸后母戊鼎】：
后母戊鼎是商周时期青铜文化的代表作，因其鼎腹内壁著有铭文“后母戊”三字而得名。“母戊”是武丁妻妾妇妌（jing）的庙号。该鼎一说为祖庚或祖甲为祭祀母亲而铸造，一说是文丁为其母铸造。
-来源：全历史APP

今天讲python的doctest模块测试。有需要的也可以直接去我的github查看全部笔记：

https://github.com/JackKoLing/python_notes_with_ten_days

俗话说：“好记性不如烂笔头”，多写写多记记，总不会错。多一些不为什么的坚持，少一些功利主义的追求。对于环境的配置，可以参考以下两篇：

• win10版 @小保，公众号：CV之道
  【深度学习环境配置】手把手实战配置深度学习环境（win10版）
• Linux版 @小保，公众号：CV之道
  【深度学习环境配置】手把手实战配置深度学习环境（Ubuntu20.04版）

1、python文档字符串

• 如果函数、类或模块的第一行是一个字符串，这个字符串就称为文档字符串（docstrings）
• 内置函数help()或对象的默认方法__doc__可以显示这些文档字符串

def add(num1, num2):
    """ the sumary of num1 and num2.
    >>> add(2, 5)
    7
    >>> add(12, 77)
    89
    """
    return num1 + num2

print(add(2, 3))
>>>
5

print(help(add))
>>>
Help on function add in module __main__:

add(num1, num2)
    the sumary of num1 and num2.
    >>> add(2, 5)
    7
    >>> add(12, 77)
    89

None

print(add.__doc__)
>>>
the sumary of num1 and num2.
    >>> add(2, 5)
    7
    >>> add(12, 77)
    89

2 、使用doctest模块来测试

• doctest模块允许在文档字符串内嵌入注释以显示各种语句的期望行为，尤其是函数和方法的结果
• 此处的文档字符串看起来如同一个交互式shell会话
• 可用于测试文档是否与程序主体保持同步，或基于文档对程序本身做测试

import sys
sys.path.append('D:\learnCode\learnPython\day10\lib')
import my_module
import doctest
doctest.testmod(my_module) # 参数是模块
>>>
**********************************************************************
File "D:\learnCode\learnPython\day10\lib\my_module.py", line 9, in my_module.add
Failed example:
    add(12, 77)
Expected:
    90
Got:
    89
**********************************************************************
1 items had failures:
   1 of   2 in my_module.add
***Test Failed*** 1 failures.

TestResults(failed=1, attempted=2)

3、创建可自测试的模块

def add(num1, num2):
    """
    the sumary of num1 and num2.
    >>> add(2, 5)
    7
    >>> add(12, 77)
    90
    """
    return num1 + num2

if __name__ == '__main__':
    import doctest
    doctest.testmod()
>>>
**********************************************************************
File "__main__", line 6, in __main__.add
Failed example:
    add(12, 77)
Expected:
    90
Got:
    89
**********************************************************************
1 items had failures:
   1 of   2 in __main__.add
***Test Failed*** 1 failures.

【声明】：学习笔记基于互联网上各种学习资源的个人整理。

以上是本期内容，下期介绍。。。

下期内容没想好，本【python学习】系列完。觉得不错，点个赞吧。

我叫小保，一名计算机视觉爱好者、学习者、追随者，欢迎关注我一起学习。