Doctest：让你的测试更简单高效

简介：Doctest 是 Python 标准库的一部分，它允许开发者通过在文档字符串（docstrings）中编写示例来进行测试。这不仅可以在确保代码正确性的同时编写文档，还可以让读者更容易理解代码的用法和期望的输出。

对比 unittest、pytest 优势：

1、简洁性：与 unittest 和 pytest 相比，Doctest 的语法更为简洁，它将测试示例写在文档字符串中，让测试看起来更清晰、易读。

2、直观性：通过阅读 Doctest 中的示例，开发者和用户能够快速理解函数或方法的用法。

3、易用性：Doctest 不需要额外的安装和配置，它是 Python 标准库的一部分，可以直接使用。

安装：Doctest 是 Python 的内置库，不需要额外的安装。

参数说明：常见的参数：

1. -v：启用详细模式，显示所有测试用例的输出结果。

3. doctest.testmod()：运行当前模块中的所有 Doctest。

5. verbose 参数，如果设置为True则在执行测试的时候会输出详细信息。

6. 默认是False，表示运行测试时，只有失败的用例会输出详细信息，成功的测试用例不会输出任何信息。

案例:  测试加法函数、测试字符串反转函数、在类对象方法的使用。

1. # -*- coding: utf-8 -*-

2. # time: 2023/9/26 0:47

3. # file: doctest_demo.py

4. import doctest

7. def add(a, b):

8. """

9. # case1 加法函数

10. This function adds two numbers and returns the sum.

12. >>> add(2, 3)

13. 5

15. >>> add(-1, 1)

16. 0

17. """

18. return a + b

21. def reverse_string(s):

22. """

23. # case2 翻转字符串函数

24. This function returns the reversed string.

26. >>> reverse_string('hello')

27. 'olleh'

29. >>> reverse_string('Python')

30. 'nohtyP'

31. """

32. return s[::-1]

35. class Cat:

36. def __init__(self, name, age):

37. self.name = name

38. self.age = age

40. def fishing(self):

41. """

42. >>> c = Cat('tom', 5)

43. >>> c.fishing()

44. tom is a cat, 5 years old, and now he is fishing.

45. True

47. >>> c = Cat('Lucy', 22)

48. >>> c.fishing()

49. Lucy is too old to fish.

50. False

52. >>> c = Cat('Lily', 1)

53. >>> c.fishing()

54. Lily is too young to fish yet.

55. False

56. """

57. if 2 <= self.age <= 20:

58. print(f"{self.name} is a cat, {self.age} years old, and now he is fishing.")

59. return True

60. elif self.age < 2:

61. print(f"{self.name} is too young to fish yet.")

62. return False

63. else:

64. print(f"{self.name} is too old to fish.")

65. return False

68. if __name__ == '__main__':

69. doctest.testmod(verbose=True)

运行结果：

不符合预期时：

注意事项：确保测试用例的输出结果与示例中的完全匹配，包括空格和换行。Doctest 更适用于简单的、不需要太多设置和清理的测试场景。

总结：Doctest 是一个简单、直观、易用的测试框架，它通过文档字符串中的示例让你能够快速编写和理解测试。与其他测试框架相比，Doctest 为简单的测试场景提供了一个清晰、高效的解决方案。在日常的 Python 开发中，合理利用 Doctest 可以帮助你更好地保证代码的正确性和质量。

 感谢每一个认真阅读我文章的人！！！

作为一位过来人也是希望大家少走一些弯路，如果你不想再体验一次学习时找不到资料，没人解答问题，坚持几天便放弃的感受的话，在这里我给大家分享一些自动化测试的学习资源，希望能给你前进的路上带来帮助。

软件测试面试文档

我们学习必然是为了找到高薪的工作，下面这些面试题是来自阿里、腾讯、字节等一线互联网大厂最新的面试资料，并且有字节大佬给出了权威的解答，刷完这一套面试资料相信大家都能找到满意的工作。

 

          视频文档获取方式：
这份文档和视频资料，对于想从事【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！以上均可以分享，点下方小卡片即可自行领取。