基础概念
什么是 Pytest？
Pytest 是一个成熟、功能丰富的 Python 测试框架。与 Python 内置的 unittest 框架相比，Pytest 具有以下核心优势：
- 更少的样板代码：测试用例就是函数，不需要继承任何类。
- 更强大的断言：直接使用 Python 的
assert语句，失败时能提供详细的上下文信息，无需记忆assertEqual,assertTrue等方法。 - 强大的 Fixture (夹具)：以一种优雅、模块化的方式管理测试的依赖和状态（如数据库连接、临时文件等）。
- 丰富的插件生态：拥有数百个高质量的插件，如
pytest-cov(测试覆盖率)、pytest-xdist(分布式测试)、pytest-django(Django集成) 等。 - 灵活的测试发现：自动发现并执行项目中的测试文件和测试函数。
- 清晰的输出信息：默认提供简洁明了的测试报告。
1. 安装
首先，你需要通过 pip 安装 pytest：
pip install pytest
2. 你的第一个测试
Pytest 的测试发现机制遵循一些简单的规则：
- 文件名以
test_*.py或*_test.py格式命名。 - 文件内，以
test_开头的函数会被识别为测试函数。 - 文件内，包含以
test_开头的方法的Test开头的类（不能有__init__方法）会被识别为测试类。
示例：
假设我们有一个简单的函数需要测试。
project/calculator.py
# 一个简单的计算器模块
def add(a, b):
return a + b
def subtract(a, b):
return a - b
现在，在同一个目录下创建一个测试文件。
project/test_calculator.py
# 导入需要测试的函数
from calculator import add
# 这是一个测试函数
def test_add():
# 使用 assert 语句进行断言
assert add(2, 3) == 5
assert add(-1, 1) == 0
assert add(-1, -1) == -2
def test_add_strings():
# 这个测试预期会失败，因为 add 函数不支持字符串
assert add('a', 'b') == 'ab'
3. 运行测试
在你的终端中，切换到 project 目录，然后执行 pytest 命令。
cd project
pytest
你会看到类似以下的输出：
============================= test session starts ==============================
platform linux -- Python 3.9.5, pytest-8.2.2, pluggy-1.5.0
rootdir: /path/to/project
collected 2 items
test_calculator.py .F [100%]
=================================== FAILURES ===================================
______________________________ test_add_strings ______________________________
def test_add_strings():
# 这个测试预期会失败，因为 add 函数不支持字符串
> assert add('a', 'b') == 'ab'
E TypeError: unsupported operand type(s) for +: 'int' and 'str'
E or
E TypeError: can only concatenate str (not "int") to str
test_calculator.py:14: TypeError
=========================== short test summary info ============================
FAILED test_calculator.py::test_add_strings - TypeError: unsupported operand...
========================= 1 failed, 1 passed in 0.02s ==========================
输出解读：
.(点) 代表一个通过的测试 (test_add)。F代表一个失败的测试 (test_add_strings)。- Pytest 详细地展示了
test_add_strings失败的原因 (TypeError) 和失败发生在哪一行代码，这就是assert的强大之处。
常用运行选项：
- 详细模式 (
-v)：显示每个测试函数的全名和结果。pytest -v - 运行指定文件：
pytest test_calculator.py - 使用关键字 (
-k) 运行特定测试：运行函数名中包含 “add” 的测试。pytest -k "add" - 遇到第一个失败就停止 (
-x)：pytest -x
4. Fixture (夹具)：管理测试依赖
Fixture 是 Pytest 的核心功能，用于为测试提供一个固定的基线状态。它们是管理 setup 和 teardown 逻辑的首选方式。
使用场景：
- 创建一个数据库连接。
- 创建一个临时目录或文件。
- 提供一个可复用的数据对象。
示例： 假设我们需要一个临时文件来进行测试。
import pytest
import os
# 定义一个 fixture
@pytest.fixture
def temp_file(tmpdir):
# Setup: 创建一个临时文件并写入内容
file_path = os.path.join(tmpdir, "test.txt")
with open(file_path, "w") as f:
f.write("hello pytest")
# yield 关键字返回资源，测试函数会在这里执行
yield file_path
# Teardown: 这里可以写清理代码，但 tmpdir 会自动清理
# print("\nCleaning up the file")
# 在测试函数中，把 fixture 的名字作为参数传入
def test_read_from_temp_file(temp_file):
with open(temp_file, "r") as f:
content = f.read()
assert content == "hello pytest"
@pytest.fixture装饰器定义了一个 fixture。- 测试函数
test_read_from_temp_file通过参数名temp_file来声明它需要使用这个 fixture。 yield之前是 setup 代码，yield之后是 teardown (清理) 代码。tmpdir是 Pytest 内置的一个 fixture，用于创建临时目录。
Fixture 的作用域 (scope)
Fixture 可以在多个测试之间共享，以提高效率。scope 参数控制其生命周期：
function(默认): 每个测试函数都运行一次。class: 每个测试类只运行一次。module: 每个模块只运行一次。session: 整个测试会话只运行一次（所有测试开始前创建，结束后销毁）。
@pytest.fixture(scope="module")
def db_connection():
# 假设这里是连接数据库的昂贵操作
print("\nSetting up DB connection")
conn = ... # connect_to_db()
yield conn
print("\nTearing down DB connection")
conn.close()
5. Markers (标记)：组织和控制测试
Markers 用于给测试函数打上标签，方便你对它们进行分组、跳过或标记为预期失败。
常用内置标记：
@pytest.mark.skip: 无条件跳过测试。@pytest.mark.skip(reason="Function not implemented yet") def test_new_feature(): ...@pytest.mark.skipif: 根据条件跳过测试。import sys @pytest.mark.skipif(sys.version_info < (3, 8), reason="requires Python 3.8 or higher") def test_modern_syntax(): ...@pytest.mark.xfail: 标记为预期失败 (XFAIL - Expected Failure)。如果测试失败，结果是XFAIL；如果意外通过，结果是XPASS。@pytest.mark.xfail(reason="Bug #123 is not fixed yet") def test_known_bug(): assert some_buggy_function() == False
自定义标记： 你可以创建自己的标记来对测试进行分类，例如 “slow”, “api”, “ui”。
pytest.ini (在项目根目录创建此文件)
[pytest]
markers =
slow: marks tests as slow to run
api: marks tests related to API calls
test_file.py
import pytest
@pytest.mark.slow
def test_very_slow_operation():
...
@pytest.mark.api
def test_api_endpoint():
...
运行带有特定标记的测试 (-m)
# 只运行标记为 "slow" 的测试
pytest -m slow
# 运行所有不是 "slow" 的测试
pytest -m "not slow"
# 运行 "api" 或 "slow" 的测试
pytest -m "api or slow"
6. 参数化 (parametrize)：用不同数据多次运行同一测试
当你需要用多组不同的输入和输出来测试同一个函数时，参数化非常有用。
import pytest
from calculator import add
# 使用 @pytest.mark.parametrize 装饰器
@pytest.mark.parametrize("input1, input2, expected", [
(1, 2, 3), # 测试用例1
(-1, 1, 0), # 测试用例2
(10, 0, 10), # 测试用例3
(99, 1, 100), # 测试用例4
pytest.param(1, 1, 3, marks=pytest.mark.xfail) # 标记为预期失败的用例
])
def test_add_multiple(input1, input2, expected):
assert add(input1, input2) == expected
- 第一个参数是参数名的字符串，用逗号分隔。
- 第二个参数是一个列表，列表中的每个元素（通常是元组）对应一组测试数据。
- Pytest 会为每一组数据生成并运行一个独立的测试。
7. 配置文件 (pytest.ini)
pytest.ini 是 Pytest 的主配置文件，通常放在项目的根目录。它可以让你自定义 Pytest 的行为。
一个常见的 pytest.ini 示例：
[pytest]
# 设置默认的命令行参数
addopts = -v --strict-markers
# 指定测试文件所在的目录
testpaths = tests
# 定义自定义标记，避免拼写错误
markers =
slow: marks tests as slow to run
smoke: marks tests for smoke testing
# 忽略某些目录或文件
norecursedirs = .git venv *.egg-info
8. 常用插件
pytest-cov: 生成测试覆盖率报告。pip install pytest-cov pytest --cov=my_project --cov-report=html这会生成一个
htmlcov目录，里面有详细的 HTML 覆盖率报告。pytest-xdist: 并行运行测试，加快执行速度。pip install pytest-xdist pytest -n auto # 'auto' 会根据 CPU 核心数自动决定进程数
总结
这个教程涵盖了 Pytest 最核心和最常用的功能。掌握了这些，你已经可以高效地为你的项目编写健壮的测试了。
学习路径建议：
- 从编写简单的
test_函数和使用assert开始。 - 学习使用 Fixture 来管理测试的准备和清理工作。
- 当你发现测试用例重复时，使用
@pytest.mark.parametrize进行参数化。 - 当测试集变大时，使用 Markers (
@pytest.mark) 来组织和筛选测试。 - 通过
pytest.ini配置文件来固化你的测试习惯。 - 根据需要，探索并使用插件来扩展 Pytest 的功能。
最好的学习方法是实践。尝试为你自己的项目编写测试，或者为一个你喜欢的小型开源项目贡献测试代码。
要了解更多信息，请随时查阅 Pytest 官方文档。
实战
1. 一个简单的
import pytest
import math
# 简单的被测试函数示例
def add_numbers(a, b):
"""加法函数"""
return a + b
def divide_numbers(a, b):
"""除法函数"""
if b == 0:
raise ValueError("除数不能为0")
return a / b
def is_even(num):
"""判断是否为偶数"""
return num % 2 == 0
# 基本测试
def test_add_numbers():
"""测试加法函数"""
result = add_numbers(2, 3)
assert result == 5
# 测试负数
result = add_numbers(-1, 1)
assert result == 0
def test_divide_numbers():
"""测试除法函数"""
result = divide_numbers(10, 2)
assert result == 5.0
# 测试浮点数
result = divide_numbers(7, 3)
assert abs(result - 2.333333) < 0.0001
def test_divide_by_zero():
"""测试除零异常"""
with pytest.raises(ValueError, match="除数不能为0"):
divide_numbers(10, 0)
# 参数化测试
@pytest.mark.parametrize("num, expected", [
(2, True),
(3, False),
(0, True),
(-2, True),
(-3, False)
])
def test_is_even_parametrized(num, expected):
"""参数化测试偶数判断"""
result = is_even(num)
assert result == expected
# 使用fixture
@pytest.fixture
def sample_data():
"""测试数据fixture"""
return [1, 2, 3, 4, 5]
def test_with_fixture(sample_data):
"""使用fixture的测试"""
assert len(sample_data) == 5
assert sum(sample_data) == 15
assert max(sample_data) == 5
# 测试类
class TestMathOperations:
"""数学操作测试类"""
def test_addition_in_class(self):
"""类中的加法测试"""
assert add_numbers(1, 1) == 2
def test_multiplication(self):
"""乘法测试"""
result = 3 * 4
assert result == 12
@pytest.mark.skip(reason="跳过这个测试")
def test_skipped(self):
"""被跳过的测试"""
assert False
# 条件跳过测试
@pytest.mark.skipif(not hasattr(math, 'isqrt'), reason="需要Python 3.8+")
def test_with_condition():
"""条件跳过的测试"""
assert math.isqrt(16) == 4
if __name__ == "__main__":
# 直接运行此文件进行测试
pytest.main([__file__])
