Python 使用 pytest 进行单元测试的全面指南

MenzilBiz

于 2025-04-05 00:32:59 发布

阅读量911

点赞数 18

分类专栏： Python 文章标签： python pytest 单元测试

本文链接：https://blog.youkuaiyun.com/qaknar826/article/details/146992451

版权

Python 专栏收录该内容

11 篇文章

订阅专栏

Python 测试：如何使用 pytest 进行单元测试

在软件开发过程中，测试是确保代码质量的重要环节。Python 社区提供了多种测试工具，其中 pytest 因其简洁、灵活和功能强大而广受欢迎。本文将全面介绍如何使用 pytest 进行 Python 单元测试，从基础到高级用法，帮助你构建可靠的测试套件。

1. 安装 pytest

首先，你需要安装 pytest。可以通过 pip 轻松安装：

pip install pytest

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

pytest --version

建议在虚拟环境中安装 pytest，以避免与系统 Python 环境的冲突：

python -m venv venv
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate     # Windows
pip install pytest

2. 编写第一个测试

pytest 使用智能测试发现机制，会自动识别以下格式的测试：

以 test_ 开头的 Python 文件
以 _test.py 结尾的 Python 文件

测试函数应该以 test_ 开头。让我们创建一个简单的测试示例：

# test_sample.py
def add(a, b):
    """简单的加法函数"""
    return a + b

def test_add():
    """测试加法函数"""
    assert add(2, 3) == 5
    assert add(-1, 1) == 0
    assert add(0, 0) == 0
    assert add(2.5, 3.5) == 6.0  # 测试浮点数加法

运行测试只需在命令行中执行：

pytest

pytest 会输出详细的测试结果，包括通过的测试和失败的测试。

3. pytest 的高级功能

3.1 参数化测试

pytest 的 @pytest.mark.parametrize 装饰器可以显著减少重复测试代码：

import pytest

@pytest.mark.parametrize("a,b,expected", [
    (2, 3, 5),
    (-1, 1, 0),
    (0, 0, 0),
    (2.5, 3.5, 6.0),
    (999999, 1, 1000000),  # 大数测试
])
def test_add_parametrize(a, b, expected):
    assert add(a, b) == expected

3.2 Fixtures

Fixtures 是 pytest 的核心功能，用于管理测试资源和状态：

import pytest

@pytest.fixture
def sample_data():
    """提供测试数据"""
    return [1, 2, 3, 4, 5]

@pytest.fixture
def complex_data():
    """更复杂的fixture示例"""
    data = {"numbers": [1, 2, 3], "name": "test"}
    yield data  # 测试结束后可以执行清理操作
    print("\n测试完成，清理数据")

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

def test_data_length(complex_data):
    assert len(complex_data["numbers"]) == 3

3.3 异常测试

测试代码是否按预期抛出异常：

import pytest

def divide(a, b):
    """除法函数，处理除零错误"""
    if b == 0:
        raise ValueError("除数不能为零")
    return a / b

def test_divide():
    """测试异常情况"""
    # 测试正常情况
    assert divide(10, 2) == 5
    
    # 测试异常
    with pytest.raises(ValueError) as excinfo:
        divide(10, 0)
    assert "除数不能为零" in str(excinfo.value)

4. 测试组织和发现

pytest 提供了灵活的测试组织方式：

4.1 测试目录结构

project/
├── src/
│   └── your_package/
│       └── __init__.py
└── tests/
    ├── __init__.py
    ├── unit/
    │   ├── test_math.py
    │   └── test_string.py
    └── integration/
        └── test_integration.py

4.2 使用测试类组织相关测试

class TestMathOperations:
    """数学运算测试集"""

    def test_multiply(self):
        assert 3 * 4 == 12
        assert -1 * 5 == -5
    
    def test_power(self):
        assert 2 ** 3 == 8
        assert 10 ** 0 == 1

    @pytest.mark.skip(reason="暂未实现")
    def test_factorial(self):
        pass

5. 运行测试的不同方式

运行特定测试文件：pytest tests/unit/test_math.py
运行特定测试类：pytest tests/unit/test_math.py::TestMathOperations
运行单个测试方法：pytest tests/unit/test_math.py::TestMathOperations::test_multiply
运行标记的测试：pytest -m slow (需要先用 @pytest.mark.slow 标记测试)
显示详细输出：pytest -v
在第一次失败后停止：pytest -x
并行运行测试：pytest -n 4 (需要安装 pytest-xdist)
只运行上次失败的测试：pytest --lf

6. 测试覆盖率分析

测试覆盖率是衡量测试质量的重要指标：

pip install pytest-cov

运行覆盖率测试：

pytest --cov=your_package tests/
pytest --cov=your_package --cov-report=html tests/  # 生成HTML报告

在 htmlcov 目录中查看详细的覆盖率报告。

7. 最佳实践和技巧

测试命名：测试名称应该清晰描述测试目的，如 test_add_positive_numbers
测试隔离：每个测试应该独立运行，不依赖其他测试的状态
快速反馈：保持测试快速执行，将慢速测试单独标记
边界测试：特别注意测试边界条件和异常情况
测试文档：为测试添加文档字符串，说明测试目的
Mocking：使用 pytest-mock 或 unittest.mock 隔离外部依赖
测试配置：使用 pytest.ini 文件配置默认选项：

[pytest]
addopts = -v --cov=your_package --cov-report=term-missing
testpaths = tests
python_files = test_*.py
python_functions = test_*

8. 进阶主题

8.1 自定义标记

@pytest.mark.slow
def test_long_running_operation():
    import time
    time.sleep(5)
    assert True

运行时不包含慢速测试：

pytest -m "not slow"

8.2 临时目录和文件

def test_create_file(tmp_path):
    """使用pytest内置的tmp_path fixture"""
    file = tmp_path / "test.txt"
    file.write_text("Hello pytest")
    assert file.read_text() == "Hello pytest"