单元测试框架-Pytest 使用详解

以下是对 pytest 的详细介绍，包括更多示例、用法以及实际场景的讨论，帮助你全面了解这个强大的测试框架。

Pytest 使用详解

一、什么是 Pytest

Pytest 是一个用于 Python 的强大测试框架，专为编写简单和复杂测试而设计。它提供了一个简单的语法、丰富的插件生态和高效的测试报告，使得测试工作更为顺利。pytest 是一个广泛使用的测试工具，被社区和行业认可，适合于单元测试、功能测试和集成测试等。

二、安装 Pytest

要开始使用 pytest，首先需要安装它。可以通过 Python 的包管理工具 pip 进行安装：

pip install pytest

安装后，可以通过以下命令确认是否安装成功：

pytest --version

三、基本使用

1. 创建测试文件

pytest 自动识别以 test_ 开头的 Python 文件和以 test_ 开头的函数，因此我们需要遵循这一命名约定来编写测试。

以下是一个简单的测试示例，文件名为 test_sample.py：

# test_sample.py

def add(a, b):
    return a + b

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

2. 运行测试

在终端中，导航到包含 test_sample.py 文件的目录，然后运行以下命令：

pytest

pytest 将自动查找所有测试并执行。你会看到如下输出：

============================= test session starts =============================
platform linux -- Python 3.x.x, pytest-6.x.x, py-1.x.x, pluggy-0.x.x
collected 1 item

test_sample.py .                                                     [100%]

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

3. 详细测试报告

若需要更详细的输出，可以添加 -v 参数（verbose）：

pytest -v

你将看到每个测试的执行结果及其状态：

test_sample.py::test_add PASSED

四、使用 Fixtures

Fixtures 是 pytest 的一个重要特性，用于为测试提供必要的上下文。它可以用于设置和清理测试所需的环境。

1. 创建 Fixture

以下是一个使用 fixture 的示例：

# test_fixture.py

import pytest

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

def test_sample_data_length(sample_data):
    assert len(sample_data) == 3

def test_sample_data_content(sample_data):
    assert sample_data == [1, 2, 3]

在这个例子中，sample_data 是一个 fixture，它提供一个简单的列表。在每个测试函数中，可以通过将 fixture 的名称作为参数直接访问。

2. Fixture 的作用域

Fixtures 的作用域可以通过 scope 参数进行配置。常见的作用域包括：

• function：每次调用测试函数时都创建新的 fixture 实例（默认）。
• class：每个测试类使用一个 fixture 实例。
• module：每个测试模块使用一个 fixture 实例。
• session：整个测试会话使用一个 fixture 实例。

示例：

# test_scope.py

import pytest

@pytest.fixture(scope="module")
def setup_module():
    print("\nSetup for the module")
    yield
    print("\nTeardown for the module")

def test_one(setup_module):
    print("Executing Test One")
    assert True

def test_two(setup_module):
    print("Executing Test Two")
    assert True

在运行时，你会看到：

Setup for the module
Executing Test One
Executing Test Two
Teardown for the module

五、参数化测试

参数化测试允许你为同一测试函数提供多组输入，从而提高测试的覆盖率。

1. 使用 @pytest.mark.parametrize

以下是一个使用参数化测试的示例：

# test_parametrize.py

import pytest

def add(a, b):
    return a + b

@pytest.mark.parametrize("a, b, expected", [
    (1, 2, 3),
    (4, 5, 9),
    (-1, 1, 0),
    (0, 0, 0),
])
def test_add(a, b, expected):
    assert add(a, b) == expected

运行该测试时，pytest 会为每组参数调用 test_add 函数。

2. 组合多个参数

你也可以组合多个参数来测试更复杂的情况：

# test_combined_parametrize.py

import pytest

@pytest.mark.parametrize("a, b", [(1, 2), (3, 4)])
@pytest.mark.parametrize("op", ['+', '-'])
def test_operations(a, b, op):
    if op == '+':
        assert a + b == a + b
    elif op == '-':
        assert a - b == a - b

六、异常测试

使用 pytest 的 raises 方法可以测试某个函数是否抛出特定的异常。

# test_exceptions.py

import pytest

def divide(a, b):
    return a / b

def test_divide_by_zero():
    with pytest.raises(ZeroDivisionError):
        divide(1, 0)

在这个例子中，我们测试了 divide 函数在除以零时是否会抛出 ZeroDivisionError。

七、使用插件

pytest 有丰富的插件生态，支持多种功能。最常用的插件包括：

1. pytest-html

用于生成 HTML 格式的测试报告。

安装

pip install pytest-html

生成报告

pytest --html=report.html

2. pytest-cov

用于测试覆盖率的报告。

安装

pip install pytest-cov

运行测试并生成覆盖率报告

pytest --cov=your_package_name

八、编写测试套件

在实际项目中，测试通常会被组织成测试套件。可以使用 pytest 的命令行参数来指定运行的测试文件或目录。

例如，要运行 tests 目录下的所有测试：

pytest tests/

1. 选择性运行测试

你可以使用 -k 参数选择性运行测试：

pytest -k "test_add"

这将只运行名称中包含 test_add 的测试。

2. 运行特定标签的测试

使用 pytest 的标记功能，你可以标记特定的测试，并在运行时只选择这些测试。例如，首先在测试函数上添加标记：

@pytest.mark.smoke
def test_basic_functionality():
    assert True

然后，在运行时指定标记：

pytest -m "smoke"

九、总结

pytest 是一个功能强大且灵活的测试框架，适用于多种类型的测试。通过简单的语法、丰富的功能、灵活的插件机制，pytest 能够显著提高测试的效率和可维护性。

核心功能总结

• 易于使用：pytest 使用简单的语法来编写测试，自动发现测试用例。
• Fixtures：为测试提供上下文管理，便于资源的配置和清理。
• 参数化测试：支持为同一测试函数提供多组输入，提高测试覆盖率。
• 异常测试：轻松测试函数是否按预期抛出异常。
• 插件支持：支持多种插件，扩展功能如报告、覆盖率等。

参考资料

• pytest 官方文档
• pytest-html 插件
• pytest-cov 插件

希望这篇文章对你深入理解和使用 pytest 有所帮助！如果有更多问题或需要更具体的示例，请随时提问。