标准库：doctest

～风介～

doctest 模块寻找像Python交互式代码的文本，然后执行这些代码来确保它们的确就像展示的那样正确运行，有许多方法来使用doctest：

• 通过验证所有交互式示例仍然按照记录的方式工作，以此来检查模块的文档字符串是否是最新的。
• 通过验证来自一个测试文件或一个测试对象的交互式示例按预期工作，来进行回归测试。
• 为一个包写指导性的文档，用输入输出的例子来说明。 取决于是强调例子还是说明性的文字，这有一种 "文本测试 "或 "可执行文档 "的风格。
  

简单来说，就是执行注释中的代码！


下面是一个小却完整的示例模块:

1. """
   
2. This is the "example" module.
   
3. 
   
4. The example module supplies one function, factorial().  For example,
   
5. 
   
6. >>> factorial(5)
   
7. 120
   
8. """
   
9. 
   
10. def factorial(n):
    
11.     """Return the factorial of n, an exact integer >= 0.
    
12. 
    
13.     >>> [factorial(n) for n in range(6)]
    
14.     [1, 1, 2, 6, 24, 120]
    
15.     >>> factorial(30)
    
16.     265252859812191058636308480000000
    
17.     >>> factorial(-1)
    
18.     Traceback (most recent call last):
    
19.         ...
    
20.     ValueError: n must be >= 0
    
21. 
    
22.     Factorials of floats are OK, but the float must be an exact integer:
    
23.     >>> factorial(30.1)
    
24.     Traceback (most recent call last):
    
25.         ...
    
26.     ValueError: n must be exact integer
    
27.     >>> factorial(30.0)
    
28.     265252859812191058636308480000000
    
29. 
    
30.     It must also not be ridiculously large:
    
31.     >>> factorial(1e100)
    
32.     Traceback (most recent call last):
    
33.         ...
    
34.     OverflowError: n too large
    
35.     """
    
36. 
    
37.     import math
    
38.     if not n >= 0:
    
39.         raise ValueError("n must be >= 0")
    
40.     if math.floor(n) != n:
    
41.         raise ValueError("n must be exact integer")
    
42.     if n+1 == n:  # catch a value like 1e300
    
43.         raise OverflowError("n too large")
    
44.     result = 1
    
45.     factor = 2
    
46.     while factor <= n:
    
47.         result *= factor
    
48.         factor += 1
    
49.     return result
    
50. 
    
51. 
    
52. if __name__ == "__main__":
    
53.     import doctest
    
54.     doctest.testmod()

复制代码

命令行执行：

1. python example.py -v

复制代码

输出：

1. Trying:
   
2.     factorial(5)
   
3. Expecting:
   
4.     120
   
5. ok
   
6. Trying:
   
7.     [factorial(n) for n in range(6)]
   
8. Expecting:
   
9.     [1, 1, 2, 6, 24, 120]
   
10. ok
    
11. Trying:
    
12.     factorial(30)
    
13. Expecting:
    
14.     265252859812191058636308480000000
    
15. ok
    
16. Trying:
    
17.     factorial(-1)
    
18. Expecting:
    
19.     Traceback (most recent call last):
    
20.         ...
    
21.     ValueError: n must be >= 0
    
22. ok
    
23. Trying:
    
24.     factorial(30.1)
    
25. Expecting:
    
26.     Traceback (most recent call last):
    
27.         ...
    
28.     ValueError: n must be exact integer
    
29. ok
    
30. Trying:
    
31.     factorial(30.0)
    
32. Expecting:
    
33.     265252859812191058636308480000000
    
34. ok
    
35. Trying:
    
36.     factorial(1e100)
    
37. Expecting:
    
38.     Traceback (most recent call last):
    
39.         ...
    
40.     OverflowError: n too large
    
41. ok
    
42. 2 items passed all tests:
    
43.    1 tests in __main__
    
44.    6 tests in __main__.factorial
    
45. 7 tests in 2 items.
    
46. 7 passed and 0 failed.
    
47. Test passed.
    

复制代码

原文出处：https://docs.python.org/zh-cn/3/library/doctest.html