文章目录

  • **1. 核心特点**
  • - **简洁易用**：无需复杂的配置，只需编写简单的函数或类即可进行测试。
  • - **丰富的断言**：直接使用 Python 内置的 `assert` 语句，失败时提供详细的错误信息。
  • - **自动发现测试**：通过约定的命名规则（如 `test_*.py` 或 `*_test.py`）自动收集测试用例。
  • - **参数化测试**：通过 `@pytest.mark.parametrize` 轻松实现多组输入和输出的测试。
  • - **Fixtures 管理资源**：通过 `fixture` 定义测试的前置条件和后置清理逻辑，支持重用和作用域控制。
  • - **插件生态**：丰富的插件（如 `pytest-html` 生成报告、`pytest-xdist` 并行执行）扩展功能。
  • - **模块化测试**：支持测试函数、测试类、测试方法等多种组织形式。
  • **2. 安装与快速入门**
  • **安装**
  • **编写第一个测试**
  • **运行测试**
  • **3. 核心功能详解**
  • **3.1 测试函数与类**
  • - **测试函数**：以 `test_` 开头的函数。
  • - **测试类**：以 `Test` 开头的类，类中的方法以 `test_` 开头。
  • **3.2 参数化测试**
  • **3.3 Fixtures（固定装置）**
  • 代码示例
  • **Fixtures 的作用域**：
  • **3.4 异常测试**
  • **3.5 插件系统**
  • - **生成 HTML 报告**：`pytest-html`
  • - **并行执行**：`pytest-xdist`
  • **3.6 命令行参数**
  • **基础控制**
  • - `-v` / `--verbose`：显示详细输出（如测试用例名称、断言信息）。
  • - `-q` / `--quiet`：静默模式，减少输出信息量（与 `-v` 相反，输出更简洁）。
  • **过滤与选择**
  • - `-k EXPRESSION`：按关键字匹配测试用例名称（支持逻辑运算符 `and/or/not`）。
  • - `-m MARKER`：运行指定标记的测试（需先用 `@pytest.mark.标记名` 标注测试）。
  • **执行策略**
  • - `-x` / `--exitfirst`：首次测试失败后立即停止执行。
  • - `--maxfail=num`：允许最多失败次数后停止（如 `--maxfail=2`）。
  • - `--ff` / `--failed-first`：优先运行上次失败的测试，再运行其他用例。
  • **输出控制**
  • - `-s` / `--capture=no`：禁用输出捕获，允许测试中 `print()` 的内容直接显示。
  • - `--tb=style`：设置回溯（Traceback）显示格式（`auto`/`line`/`short`/`no`/`long`）。
  • **报告与日志**
  • - `--html=report.html`：生成 HTML 测试报告（需安装 `pytest-html` 插件）。
  • - `--junitxml=file`：生成 JUnit XML 格式报告（适用于 CI/CD 集成）。
  • - `-l` / `--showlocals`：在失败时显示局部变量的值。
  • **性能优化**
  • - `-n NUM` / `--numprocesses=NUM`：并行执行测试（需安装 `pytest-xdist` 插件）。
  • - `--durations=N`：显示执行时间最长的 N 个测试用例。
  • **调试与收集**
  • - `--collect-only`：仅收集测试用例，不执行。
  • - `-c file`：指定自定义配置文件（非默认的 `pytest.ini`）。
  • **4. 高级用法**
  • **4.1 标记测试（Markers）**
  • **4.2 Hook 函数**
  • **4.3 多进程/分布式测试**
  • **4.4 模拟对象（Mock）**
  • **5. 实际应用场景**
  • - **单元测试**：验证单个函数或方法的正确性。
  • - **集成测试**：测试多个模块或系统的协作。
  • - **API 测试**：结合 `requests` 等库测试 HTTP 接口。
  • - **持续集成（CI/CD）**：集成到 Jenkins、GitHub Actions 等工具中，自动化运行测试。
  • **6. 优势总结**
  • **7. 学习资源**


pytest 是 Python 中最流行且功能强大的测试框架之一，以其简洁的语法、灵活的功能和强大的扩展性著称。它适用于从简单的单元测试到复杂的自动化测试场景，广泛用于开发、测试和持续集成流程中。以下是关于

pytest 的详细介绍：

1. 核心特点

- 简洁易用：无需复杂的配置，只需编写简单的函数或类即可进行测试。

- 丰富的断言：直接使用 Python 内置的 assert 语句，失败时提供详细的错误信息。

- 自动发现测试：通过约定的命名规则（如 test_*.py 或 *_test.py）自动收集测试用例。

- 参数化测试：通过 @pytest.mark.parametrize 轻松实现多组输入和输出的测试。

- Fixtures 管理资源：通过 fixture 定义测试的前置条件和后置清理逻辑，支持重用和作用域控制。

- 插件生态：丰富的插件（如 pytest-html 生成报告、pytest-xdist 并行执行）扩展功能。

- 模块化测试：支持测试函数、测试类、测试方法等多种组织形式。

2. 安装与快速入门

安装

pip install pytest

编写第一个测试

创建一个文件 test_sample.py：

def add(x, y):
    return x + y

def test_add():
    assert add(1, 2) == 3  # 断言

运行测试

在命令行中执行：

pytest test_sample.py

输出示例：

=========================== test session starts ============================
collected 1 item

test_sample.py .                                                    [100%]

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

3. 核心功能详解

3.1 测试函数与类

- 测试函数：以 test_ 开头的函数。

- 测试类：以 Test 开头的类，类中的方法以 test_ 开头。

class TestMath:
    def test_add(self):
        assert 1 + 1 == 2

    def test_subtract(self):
        assert 3 - 1 == 2

3.2 参数化测试

使用 @pytest.mark.parametrize 实现多组输入测试：

import pytest

@pytest.mark.parametrize("a, b, expected", [(1, 2, 3), (4, 5, 9), (7, 8, 15)])
def test_add(a, b, expected):
    assert a + b == expected

3.3 Fixtures（固定装置）

Fixtures 用于管理测试的前置条件（如初始化资源）和后置清理（如关闭连接）。通过装饰器 @pytest.fixture 定义：

代码示例

import pytest

@pytest.fixture
def tmp_dir(tmpdir):  # 使用内置的 tmpdir fixture
    return tmpdir.mkdir("test_data")

def test_tmp_dir(tmp_dir):
    file = tmp_dir.join("test.txt")
    file.write("Hello")
    assert file.read() == "Hello"

上述代码具体解释参见：pytest tmpdir fixture介绍（tmpdir_factory）（自动在测试开始前创建一个临时目录，并在测试结束后删除该目录）

Fixtures 的作用域：

  • function（默认）：每个测试函数执行一次。
  • class：每个测试类执行一次。
  • module：每个模块执行一次。
  • session：整个测试会话执行一次。

3.4 异常测试

测试是否抛出特定异常：

def test_exception():
    with pytest.raises(ValueError):
        raise ValueError("Invalid input")

3.5 插件系统

通过插件扩展功能：

- 生成 HTML 报告：pytest-html 

pytest --html=report.html

- 并行执行：pytest-xdist 

pytest -n 4  # 使用 4 个 CPU 并行运行

以下是补充了 -q 参数及其他相关参数的完整 pytest 介绍文章：

3.6 命令行参数

pytest 提供丰富的命令行参数，灵活控制测试执行和输出。以下为常用参数及示例：

基础控制

- -v / --verbose：显示详细输出（如测试用例名称、断言信息）。
pytest -v test_sample.py
- -q / --quiet：静默模式，减少输出信息量（与 -v 相反，输出更简洁）。
pytest -q test_sample.py

过滤与选择

- -k EXPRESSION：按关键字匹配测试用例名称（支持逻辑运算符 and/or/not）。
pytest -k "add or subtract"  # 运行名称含 "add" 或 "subtract" 的用例
- -m MARKER：运行指定标记的测试（需先用 @pytest.mark.标记名 标注测试）。
pytest -m slow  # 运行标记为 @pytest.mark.slow 的用例

执行策略

- -x / --exitfirst：首次测试失败后立即停止执行。
pytest -x
- --maxfail=num：允许最多失败次数后停止（如 --maxfail=2）。
- --ff / --failed-first：优先运行上次失败的测试，再运行其他用例。
pytest --ff

输出控制

- -s / --capture=no：禁用输出捕获，允许测试中 print() 的内容直接显示。
pytest -s test_output.py
- --tb=style：设置回溯（Traceback）显示格式（auto/line/short/no/long）。
pytest --tb=short  # 显示简化版回溯信息

报告与日志

- --html=report.html：生成 HTML 测试报告（需安装 pytest-html 插件）。
pytest --html=report.html
- --junitxml=file：生成 JUnit XML 格式报告（适用于 CI/CD 集成）。
- -l / --showlocals：在失败时显示局部变量的值。
pytest -l

性能优化

- -n NUM / --numprocesses=NUM：并行执行测试（需安装 pytest-xdist 插件）。
pytest -n 4  # 使用 4 个进程并行运行
- --durations=N：显示执行时间最长的 N 个测试用例。
pytest --durations=10

调试与收集

- --collect-only：仅收集测试用例，不执行。
pytest --collect-only
- -c file：指定自定义配置文件（非默认的 pytest.ini）。

4. 高级用法

4.1 标记测试（Markers）

为测试添加标签，用于分类或过滤：

import pytest

@pytest.mark.slow
def test_slow():
    assert 1 + 1 == 2

运行标记为 slow 的测试：

pytest -m slow

4.2 Hook 函数

通过钩子函数（Hook）自定义测试流程，例如修改测试报告或收集用例逻辑。需在 conftest.py 中定义。

4.3 多进程/分布式测试

结合 pytest-xdist 插件实现多进程或分布式测试，提升执行效率。

4.4 模拟对象（Mock）

使用 unittest.mock 模块模拟函数或对象行为：

from unittest.mock import Mock

def test_mock():
    mock = Mock(return_value=42)
    assert mock() == 42

5. 实际应用场景

- 单元测试：验证单个函数或方法的正确性。

- 集成测试：测试多个模块或系统的协作。

- API 测试：结合 requests 等库测试 HTTP 接口。

- 持续集成（CI/CD）：集成到 Jenkins、GitHub Actions 等工具中，自动化运行测试。

6. 优势总结

  • 学习成本低：语法简单，无需继承基类。
  • 可扩展性强：丰富的插件生态支持各种需求。
  • 社区活跃：文档完善，社区支持强大。
  • 高效调试：失败时自动显示详细的错误信息和中间值。

7. 学习资源

通过掌握 pytest，你可以显著提升 Python 项目的测试效率和代码质量！