如果您因为感觉像一件苦差事而避免编写测试，那么这个 pytest 教程 应该会改变您的想法。 Pytest 删除了大部分仪式：没有要继承的类，也没有需要记住的特殊断言方法。一个测试可以只有两行。

我们将构建一个小型购物车并逐步进行测试。我们使用 pytest 9.2 在 Python 3.13 上运行了所有内容，显示的输出是真实的，尽管我们修剪了在您的计算机上不同的文件路径和计时细节。

为什么要进行pytest？

Python 附带了 unittest，它运行良好，但 pytest 通常是更方便的选择。这是每个中相同的检查：

Pytest 还可以运行您现有的 unittest 测试，因此您可以逐渐切换。它还有一个大型插件生态系统，包括用于覆盖的 pytest-cov 和用于并行运行的 pytest-xdist。

安装pytest

首先创建一个虚拟环境，如我们的Python虚拟环境教程中所述，然后安装它：

pip install pytest
pytest --version

# pytest 9.2.0

创建一个包含两个文件 cart.py 和 test_cart.py 的项目文件夹。 Pytest 通过以下命名规则自动查找测试：名为 test_*.py 或 *_test.py 的文件、以 test 开头的函数以及以 Test 开头的类。如果没有进行测试，首先要检查命名不匹配。

要测试的代码

# cart.py
class Cart:
    def __init__(self):
        self.items = []

    def add(self, name, price, qty=1):
        if qty < 1:
            raise ValueError("qty must be at least 1")
        self.items.append((name, price, qty))

    def total(self, discount=0):
        subtotal = sum(price * qty for _, price, qty in self.items)
        return round(subtotal * (1 - discount / 100), 2)

您的第一次测试

# test_cart.py
from cart import Cart

def test_empty_cart_is_free():
    assert Cart().total() == 0

这是一个完整的测试。从项目文件夹运行 pytest，它会报告一项通过的测试。如果出现导入​​错误，请按 python -m pytest 运行，这会将当前文件夹添加到导入路径。

阅读失败

这就是 pytest 真正闪光的地方。这是一个故意错误期望值的测试：

def test_wrong_total():
    c = Cart()
    c.add("Keyboard", 1500)
    assert c.total() == 1400

这是我们运行时打印的内容：

    def test_wrong_total():
        c = Cart()
        c.add("Keyboard", 1500)
>       assert c.total() == 1400
E       assert 1500.0 == 1400
E        +  where 1500.0 = total()

FAILED fail_example.py::test_wrong_total - assert 1500.0 == 1400
============================== 1 failed in 0.12s ==============================

> 标记失败行，E 行显示实际值。您不必添加自定义消息，因为 pytest 重写了 assert 语句，以便它们可以报告比较的内容。它对列表和字典执行相同的操作，准确指出哪些项目不同。

测试异常

错误处理也是行为，值得测试。 pytest.raises 仅当块引发预期异常时才通过：

import pytest

def test_rejects_zero_qty():
    with pytest.raises(ValueError, match="at least 1"):
        Cart().add("Pen", 10, qty=0)

可选的 match 参数使用正则表达式检查消息，因此不同的 ValueError 不会意外通过。要了解如何引发和处理此类错误，请阅读我们的 Python 异常处理指南。

夹具：可重复使用的设置

大多数测试都需要先准备一些东西。 fixture 是提供它的函数。用 @pytest.fixture 装饰它，任何将其命名为参数的测试都会收到结果：

@pytest.fixture
def cart():
    c = Cart()
    c.add("Keyboard", 1500)
    c.add("Mouse", 500, qty=2)
    return c

def test_total(cart):
    assert cart.total() == 2500

默认情况下，每个测试都会获得一个新的购物车，因此测试不会相互影响。 Pytest 将参数名称与固定装置的名称相匹配，并且您永远不会自己调用固定装置。 @pytest.fixture是一个装饰器，我们在Python装饰器解释中对其进行了解释。

清理产量

当您事后需要清理时，请使用 yield 而不是 return。 yield 之后的代码在测试完成时运行，即使测试失败：

@pytest.fixture
def temp_db():
    print("\nopen db")
    yield {"users": []}
    print("close db")

def test_db(temp_db):
    assert temp_db["users"] == []

使用 -s 运行以显示打印输出，确认订单已打开、测试，然后关闭。

夹具范围和conftest.py

默认情况下，夹具每次测试运行一次。对于昂贵的设置，例如数据库或浏览器，请使用 scope 更改其生命周期：

将多个文件使用的灯具放入名为 conftest.py 的文件中。 Pytest 自动加载它，因此测试可以使用它的装置而无需导入。不过，要小心共享范围，因为一个测试所做的更改可能会泄漏到下一个测试中。

参数化：一项测试，多项输入

不要为每个值复制测试，而是列出案例：

@pytest.mark.parametrize("discount, expected", [
    (0, 2500),
    (10, 2250),
    (100, 0),
])
def test_discount(cart, discount, expected):
    assert cart.total(discount) == expected

每行都成为自己的测试，您可以在我们运行完整文件的详细输出中看到这一点：

test_cart.py::test_total PASSED                        [ 16%]
test_cart.py::test_discount[0-2500] PASSED             [ 33%]
test_cart.py::test_discount[10-2250] PASSED            [ 50%]
test_cart.py::test_discount[100-0] PASSED              [ 66%]
test_cart.py::test_rejects_zero_qty PASSED             [ 83%]
test_cart.py::test_empty_cart_is_free PASSED           [100%]

============================== 6 passed in 0.05s ==============================

如果一行失败，其他行仍然运行，并且名称准确地告诉您哪些值导致了问题。请注意，我们将参数化与 cart 夹具结合起来。要选择可能发现错误的值，请使用边界值分析。

有用的内置装置

Pytest 包括几个现成的装置。这两个特别方便，并且都在我们的运行中通过了：

def test_write_report(tmp_path):
    report = tmp_path / "report.txt"
    report.write_text("passed")
    assert report.read_text() == "passed"

def read_mode():
    return os.environ.get("APP_MODE", "dev")

def test_mode(monkeypatch):
    monkeypatch.setenv("APP_MODE", "staging")
    assert read_mode() == "staging"

tmp_path 为每个测试提供一个唯一的临时文件夹，因此测试永远不会触及真实文件。 monkeypatch 更改环境变量或属性，并在测试结束时撤消更改。另一个有用的工具是 capsys，它捕获打印输出，以便您可以检查它。

标记：skip 和 xfail

标记为测试添加标签和行为：

@pytest.mark.skip(reason="payment sandbox is down")
def test_payment():
    assert False

@pytest.mark.xfail(reason="floating point")
def test_rounding():
    assert 0.1 + 0.2 == 0.3

skip 根本不运行测试。 xfail 运行它但预计会失败，因此已知问题不会破坏您的构建。与同一文件中的其他额外测试一起，我们的运行总结为 3 passed, 1 skipped, 1 xfailed。顺便说一句，舍入测试确实失败了：在浮点算术中，0.1 + 0.2 并不完全是 0.3。比较小数时使用 pytest.approx(0.3)。

您还可以创建自己的标记，例如 @pytest.mark.slow，并仅运行带有 pytest -m slow 的标记，或者使用 -m "not slow" 忽略它们。在配置文件中注册自定义标记以避免警告。

有用的命令行标志

在 CI 中运行 pytest

当测试在每次更改时自动运行时，测试才最有价值。一个最小的 GitHub Actions 作业如下所示：

steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-python@v5
    with:
      python-version: "3.13"
  - run: pip install -r requirements.txt
  - run: python -m pytest

当测试失败时，Pytest 会以非零代码退出，这就是管道停止的原因。我们没有执行此工作流程文件，因此请根据您的项目进行调整。我们的 GitHub Actions CI/CD 指南 解释了详细信息。 Pytest 也适用于浏览器测试，如我们的 Selenium Python 教程 和 页面对象模型教程 所示。

最后的话

您现在拥有大多数 Python 测试套件所需的东西：简单的断言、设置固定装置、变化参数化和一些速度标志。从小处开始。选择一个您最近修复了错误的函数，然后首先针对该错误编写测试。如果您不确定在每个级别测试什么，请阅读单元测试与集成测试。

常见问题

继续学习