前言
之前简单的按照教程打过一遍doctest模块，但是并未重视，再加上自己平常就不用测试案例，所以最近在一本书上再看到这个模块时心里又有些模糊淡忘了。所以这次专门做个笔记，关于doctest模块以及稍微提及下unittest。
我们为什么忽视
少废话，直接看我得日常操作（或许也是大部分人的操作）就能得到原因。
""" Fibonacci Module """
def fib(n):
""" Calculates the n-th Fibonacci number iteratively """
a, b = 0, 1
for i in range(n):
a, b = b, a + b
return a
def fiblist(n):
""" creates a list of Fibonacci numbers up to the n-th generation """
fib = [0,1]
for i in range(1,n):
fib += [fib[-1]+fib[-2]]
return fib
上面是一个斐波那契数列的日常实现。
而我们经常直接就这么干了（手动测试），这里手动斜眼：
>>> from fibonacci import fib, fiblist
>>> fib(0)
0
>>> fib(1)
1
>>> fib(10)
55
>>> fiblist(10)
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
>>> fiblist(-8)
[0, 1]
>>> fib(-1)
0
>>> fib(0.5)
Traceback (most recent call last):
File "", line 1, in
File "fibonacci.py", line 6, in fib
for i in range(n):
TypeError: 'float' object cannot be interpreted as an integer
>>>
知道凭感觉想到了，输入一个浮点数会报错。
又或者我们会写一个简单判断测试一下，比如我们在文件中加入下面代码：
if __name__ == "__main__":
if fib(0) == 0 and fib(10) == 55 and fib(50) == 12586269025:
print("Test for the fib function was successful!")
else:
print("The fib function is returning wrong values!")
# 运行一下
$ python3 fibonacci.py
Test for the fib function was successful!
如果函数没有得到我们事先算好的值，返回"The fib function is returning wrong values!
所以结论是：doctest好像用不太到啊，我们像上面那么干就够了啊~~
doctest模块
什么情况下用doctest：
正式项目的测试或者需要优雅的方式，让逼格变高的测试案例。
一般有以下因素时尽量要试用下：
- 大小
对于集合(string,list,tuple,dict)- 空集合
- 单元素集
- 最少数量用例
- 较多用例
- 对分
- 奇数/偶数
- 正/负
- 空/满
- 边界
函数在接近阈值的时候处理不同，测试阈值。 - 顺序
函数对不同顺序的输入值，测试不同的顺序。
所以我们可以这么写
import doctest
def fib(n):
"""
Calculates the n-th Fibonacci number iteratively
>>> fib(0)
0
>>> fib(1)
1
>>> fib(10) #正确值为55
56
>>> fib(15)
610
>>>
"""
a, b = 0, 1
for i in range(n):
a, b = b, a + b
return a
if __name__ == "__main__":
doctest.testmod(verbose=True)
之后$ python3 fibonacci_doctest.py可得到测试信息，verbose=True为测试通过与未通过都将消息显示出来,默认为False，只显示失败信息。
Trying:
fib(0)
Expecting:
0
ok
Trying:
fib(1)
Expecting:
1
ok
Trying:
fib(10)
Expecting:
56
**********************************************************************
File "fibonacci_doctest.py", line 11, in __main__.fib
Failed example:
fib(10)
Expected:
56
Got:
55
Trying:
fib(15)
Expecting:
610
ok
1 items had no tests:
__main__
**********************************************************************
1 items had failures:
1 of 4 in __main__.fib
4 tests in 2 items.
3 passed and 1 failed.
***Test Failed*** 1 failures.
也有可能你需要在if __name__ == "__main__":下面写其他函数而不是测试函数。你可以换个方式。我修改下主函数。
if __name__ == "__main__":
print('hello world')
之后$ python3 -m doctest -v fibonacci_doctest.py跟上面测试信息一样，并不会输出hello world，这里-v等同verbose参数。
是否需要unittest
unittest是一个单元测试框架，具体教程可去官方文档查询，这里不多做介绍。
有些人用unittest多余doctest，主要原因是我把测试内容写在函数中，像函数注释一样，一旦测试的东西一多，那么可能导致函数看上去很复杂，影响美观，导致不优雅。
但是doctest还有个testfile方法，将测试文档写入一个单独的文件。这里我写一下。
# 尽量与py文件同名或者相近，好辨认，然后以txt结尾
The ``fibonacci_doctest`` module
======================
Using ``fib``
-------------------
First import fib fuction
>>> from fibonacci_doctest import fib
Now use it
>>> fib(0)
0
>>> fib(1)
1
>>> fib(10) #正确值为55
56
>>> fib(15)
610
# 上面时文件所有内容，及其一些注释，最重要的是 >>>后面的内容为测试内容
然后我们在fibonacci_doctest.py中主函数中写入:
if __name__ == "__main__":
doctest.testfile("fibonacci_doctest.txt")
得到如下:
**********************************************************************
File "fibonacci_doctest.txt", line 16, in fibonacci_doctest.txt
Failed example:
fib(10) #正确值为55
Expected:
56
Got:
55
**********************************************************************
1 items had failures:
1 of 5 in fibonacci_doctest.txt
***Test Failed*** 1 failures.
OK，结束。很好用。
总结
doctest测试模块时比较基础，容易理解也容易使用。
之前看见一个大佬说过，大体意思是这样的：你写完一个函数，心里就已经想好了测试案例，各种测试因素，来验证你写的这个函数的准确性。
说的很对。
参考资料
https://www.python-course.eu/python3_tests.php
http://blog.csdn.net/u012151283/article/details/77511806
https://docs.python.org/3/library/doctest.html#doctest.testfile