在 Python 的测试生态中，Pytest 提供了多种灵活且强大的测试工具。其中，doctests 是一种独特而直观的测试方法，通过直接从文档注释中提取和执行测试用例，确保代码示例的正确性。本文将深入介绍 Pytest 中 doctests 的测试方法，包括基本用法和实际案例，以帮助你更好地利用这一特性。

什么是Pytest中的doctests？

在 Pytest 中，doctests 是一种通过文档注释中的代码示例进行测试的方法。这种测试方法不仅可以作为代码的说明文档，还可以确保文档中的示例代码真正能够运行，并且产生的输出符合预期。

基本用法

在函数、类或模块的文档注释中编写 doctests 很简单。让我们以一个简单的加法函数为例：

def add(a, b):    """    Function to add two numbers.

    Example:    >>> add(2, 3)    5

    >>> add(-1, 1)    0    """    return a + b

在这个例子中，我们使用了函数的文档注释来包含 doctests。每个示例都以 `>>>` 开始，后面是调用函数的代码，接着是期望的输出结果。当运行 Pytest 时，它会自动检测并执行这些 doctests。

现在我也找了很多测试的朋友，做了一个分享技术的交流群，共享了很多我们收集的技术文档和视频教程。
如果你不想再体验自学时找不到资源，没人解答问题，坚持几天便放弃的感受
可以加入我们一起交流。而且还有很多在自动化，性能，安全，测试开发等等方面有一定建树的技术大牛
分享他们的经验，还会分享很多直播讲座和技术沙龙
可以免费学习！划重点！开源的！！！
qq群号：691998057【暗号：csdn999】

案例演示

考虑一个更复杂的情景，我们有一个字符串处理的函数 `capitalize_and_reverse`：

def capitalize_and_reverse(text):    """    Function to capitalize a string and reverse it.

    Example:    >>> capitalize_and_reverse('pytest')    'TSEYTP'

    >>> capitalize_and_reverse('hello')    'OLLEH'    """    capitalized_text = text.capitalize()    reversed_text = ''.join(reversed(capitalized_text))    return reversed_text

这个函数首先将字符串首字母大写，然后将其反转。我们通过 doctests 来验证这个函数的正确性。

运行测试

要运行包含 doctests 的测试，只需在 Pytest 命令中添加 `-k doctest`：

pytest -k doctest

Pytest 将查找包含 doctests 的模块，并执行其中的测试用例。如果所有的测试都通过，输出将显示为 `1 passed`。

与其他测试方法的结合

doctests 可以与其他 Pytest 的测试方法结合使用，构建更全面的测试套件。例如，我们可以在同一个模块中同时使用 doctests 和常规的测试函数：

# test_code.py

def test_add_function():    assert add(2, 3) == 5    assert add(-1, 1) == 0

# Run both doctests and regular testspytest -k "doctest or test_add_function"

这样，我们既能够利用 doctests 验证示例代码，又能够使用常规的测试函数覆盖更复杂的测试场景。

优势与注意事项

优势：

1. 直观清晰: Doctests 直接嵌入在文档中，使得测试用例与文档保持同步，更易于理解和维护。

2. 文档即测试: Doctests 让文档不仅仅是静态的说明，还可以作为实际的测试用例，确保文档中的示例是可运行的。

3. 一体化: Doctests 不需要额外的配置，与文档紧密结合，方便快捷。

注意事项:

1. 简单场景: Doctests 更适用于简单的测试场景，对于复杂的测试逻辑，建议使用其他 Pytest 的测试方法。

2. 维护成本: 如果 doctests 过于繁琐，可能导致文档难以维护。在实际项目中，需要根据情况权衡使用。

Pytest 中的 doctests 提供了一种简单而直观的测试方法，使得文档不仅仅是说明文档，还可以成为实际的测试用例。通过嵌入在文档中的示例代码，我们可以轻松验证代码的正确性，确保文档中的示例是可运行的。然而，在实际项目中，需要谨慎使用 doctests，根据测试的复杂度和维护成本进行权衡。尝试在你的项目中使用 doctests，发现它的便利之处，让测试更加直观与高效。

下面是配套资料，对于做【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！

最后： 可以在公众号：自动化测试老司机 ！ 免费领取一份216页软件测试工程师面试宝典文档资料。以及相对应的视频学习教程免费分享！，其中包括了有基础知识、Linux必备、Shell、互联网程序原理、Mysql数据库、抓包工具专题、接口测试工具、测试进阶-Python编程、Web自动化测试、APP自动化测试、接口自动化测试、测试高级持续集成、测试架构开发测试框架、性能测试、安全测试等。

如果我的博客对你有帮助、如果你喜欢我的博客内容，请 “点赞” “评论” “收藏” 一键三连哦！