---

Python pytest 快速入门 🚀

欢迎来到 pytest 的世界！如果你正在寻找一个强大、灵活且易于使用的 Python 测试框架，那么 pytest 绝对是你的不二之选。它不仅简化了测试代码的编写，还提供了丰富的功能来帮助你高效地进行测试。本文将带你快速入门 pytest，并通过代码示例、图表和资源链接让你全面掌握其核心用法。

为什么选择 pytest？✨

pytest 是 Python 中最流行的测试框架之一，它具有以下优点：

• 简洁的语法：使用简单的 assert 语句进行断言，无需学习复杂的 API。
• 丰富的插件生态：可通过插件扩展功能，如覆盖率报告、并行测试等。
• 强大的夹具（fixture）系统：轻松管理测试资源和状态。
• 自动发现测试：无需手动注册测试用例，pytest 会自动查找并运行它们。

根据 Python 开发者调查，pytest 是 Python 社区中最受欢迎的测试工具。它的设计哲学是让测试变得简单而有趣，从而鼓励开发者编写更多的测试，提高代码质量。

安装 pytest

首先，你需要安装 pytest。推荐使用 pip 进行安装：

pip install pytest

安装完成后，可以通过以下命令验证安装是否成功：

pytest --version

这将输出 pytest 的版本信息，确认安装无误。

第一个测试用例

让我们从一个简单的例子开始。假设我们有一个函数 add，用于计算两个数的和：

# calculator.py
def add(a, b):
    return a + b

现在，我们为这个函数编写一个测试。创建文件 test_calculator.py：

# test_calculator.py
from calculator import add

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

运行测试：

pytest test_calculator.py

如果一切正常，你会看到输出类似如下：

============================= test session starts ==============================
platform linux -- Python 3.x, pytest-7.x, pluggy-1.x
rootdir: /your/directory
collected 1 item

test_calculator.py .                                                     [100%]

============================== 1 passed in 0.01s ===============================

恭喜！你成功运行了第一个 pytest 测试。🎉

断言和异常测试

pytest 使用标准的 assert 语句进行断言，这使得测试代码非常直观。例如：

def test_assertions():
    assert 1 + 1 == 2
    assert "hello".upper() == "HELLO"
    assert [1, 2, 3] == [1, 2, 3]

你还可以测试代码是否抛出了预期的异常。假设我们有一个函数 divide：

# calculator.py
def divide(a, b):
    if b == 0:
        raise ValueError("Cannot divide by zero!")
    return a / b

测试异常：

# test_calculator.py
import pytest
from calculator import divide

def test_divide():
    assert divide(10, 2) == 5

def test_divide_by_zero():
    with pytest.raises(ValueError, match="Cannot divide by zero!"):
        divide(10, 0)

使用 pytest.raises 上下文管理器来捕获并验证异常。

夹具（Fixtures）系统

夹具是 pytest 的一个强大功能，用于管理测试所需的资源或状态。通过 @pytest.fixture 装饰器定义夹具，然后在测试函数中引用它们。

例如，创建一个简单的夹具来提供数据：

# test_calculator.py
import pytest

@pytest.fixture
def sample_data():
    return [1, 2, 3, 4, 5]

def test_sum(sample_data):
    total = sum(sample_data)
    assert total == 15

夹具可以设置和清理资源，例如数据库连接：

@pytest.fixture
def db_connection():
    conn = create_connection()  # 假设的函数
    yield conn
    conn.close()  # 测试完成后清理

def test_db_query(db_connection):
    result = db_connection.query("SELECT * FROM table")
    assert len(result) > 0

使用 yield 可以实现 setup 和 teardown 逻辑。

参数化测试

参数化允许你使用不同的输入运行同一测试函数，减少代码重复。使用 @pytest.mark.parametrize 装饰器：

# test_calculator.py
import pytest
from calculator import add

@pytest.mark.parametrize("a, b, expected", [
    (2, 3, 5),
    (-1, 1, 0),
    (0, 0, 0),
    (100, 200, 300),
])
def test_add_parametrized(a, b, expected):
    assert add(a, b) == expected

这将运行 test_add_parametrized 四次，每次使用不同的参数。

测试组织和发现

pytest 自动发现测试文件（以 test_ 开头或结尾的 .py 文件）和测试函数（以 test_ 开头的函数）。你还可以使用类来组织测试：

# test_calculator.py
class TestCalculator:
    def test_add(self):
        assert add(2, 3) == 5

    def test_multiply(self):
        assert multiply(2, 3) == 6  # 假设有 multiply 函数

运行整个类或模块的测试：

pytest test_calculator.py::TestCalculator  # 运行特定类
pytest test_calculator.py  # 运行整个文件
pytest  # 运行所有测试

使用 Mermaid 可视化测试流程

下面是一个简单的 mermaid 流程图，展示了 pytest 的基本工作流程：

这个流程展示了从编写测试到运行和报告的基本步骤。pytest 的自动发现机制使得整个过程非常高效。

高级特性

pytest 还有许多高级特性，例如：

• 标记（Marking）：使用 @pytest.mark 对测试进行分类，如 @pytest.mark.slow 标记慢速测试，然后选择性地运行它们。
• 插件系统：安装插件以增强功能，如 pytest-cov 用于测试覆盖率报告。
• 并行测试：使用 pytest-xdist 插件并行运行测试，加快大型测试套件的速度。

你可以在 pytest 官方文档 中找到更多详细信息和示例。

常见问题与最佳实践

测试文件结构

保持测试代码的组织清晰非常重要。通常，测试文件应放在与源代码相同的目录中，或在一个专门的 tests 目录中。例如：

project/
│
├── calculator.py
└── test_calculator.py

或者：

project/
│
├── src/
│   └── calculator.py
└── tests/
    └── test_calculator.py

避免测试依赖

确保每个测试是独立的，不依赖其他测试的状态或顺序。使用夹具来提供隔离的环境。

持续集成

将 pytest 集成到你的持续集成（CI）流程中，以确保代码质量。许多 CI 工具如 Jenkins 或 GitLab CI 都支持 pytest。

结语

pytest 是一个功能丰富且易于使用的测试框架，能够显著提升你的测试效率和代码质量。通过本文的介绍，希望你已经掌握了 pytest 的基本用法，并愿意在项目中尝试它。记住，编写测试不仅是为了捕捉错误，更是为了构建可靠、可维护的软件。 Happy testing! 🎯

如果你对 pytest 感兴趣，可以进一步阅读 Real Python 的 pytest 教程，其中包含了更多高级示例和技巧。