关于 Fixture¶

另请参见

如何使用 fixtures

另请参见

Fixtures 参考

pytest Fixture 旨在实现显式、模块化和可扩展。

什么是 Fixture¶

在测试中，fixture 为测试提供了一个定义明确、可靠且一致的上下文。这可能包括环境（例如配置了已知参数的数据库）或内容（例如数据集）。

Fixture 定义了构成测试“准备（arrange）”阶段的步骤和数据（参见测试解剖）。在 pytest 中，它们是您为此目的定义的函数。它们还可以用于定义测试的“执行（act）”阶段；这是一种设计更复杂测试的强大技术。

Fixture 设置的服务、状态或其他操作环境通过参数由测试函数访问。对于测试函数使用的每个 fixture，测试函数的定义中通常都有一个参数（以 fixture 的名称命名）。

我们可以通过使用 @pytest.fixture 装饰器来告诉 pytest 某个特定函数是一个 fixture。下面是一个 pytest 中 fixture 可能样子的简单示例

import pytest


class Fruit:
    def __init__(self, name):
        self.name = name

    def __eq__(self, other):
        return self.name == other.name


@pytest.fixture
def my_fruit():
    return Fruit("apple")


@pytest.fixture
def fruit_basket(my_fruit):
    return [Fruit("banana"), my_fruit]


def test_my_fruit_in_basket(my_fruit, fruit_basket):
    assert my_fruit in fruit_basket

测试不必仅限于一个 fixture。它们可以依赖任意数量的 fixture，并且 fixture 也可以使用其他 fixture。这正是 pytest fixture 系统真正出彩的地方。

相对于 xUnit 风格的 setup/teardown 函数的改进¶

pytest fixture 相对于经典的 xUnit 风格的 setup/teardown 函数提供了显著的改进

fixture 具有明确的名称，并通过在测试函数、模块、类或整个项目中声明其使用而被激活。
fixture 以模块化方式实现，因为每个 fixture 名称都会触发一个“fixture 函数”，该函数本身可以使用其他 fixture。
fixture 管理从简单的单元测试到复杂的函数测试都可以扩展，允许根据配置和组件选项对 fixture 和测试进行参数化，或者在函数、类、模块或整个测试会话范围内重用 fixture。
拆卸逻辑可以轻松安全地管理，无论使用了多少 fixture，无需手动仔细处理错误或微观管理清理步骤的添加顺序。

此外，pytest 继续支持如何实现 xunit 风格的设置。您可以混合使用这两种风格，根据您的喜好逐步从经典风格过渡到新风格。您也可以从现有的 unittest.TestCase 风格开始。

Fixture 错误¶

pytest 会尽力将给定测试的所有 fixture 按线性顺序排列，以便它可以查看哪个 fixture 首先发生、其次、再次，依此类推。但是，如果早期 fixture 出现问题并引发异常，pytest 将停止执行该测试的 fixture 并将该测试标记为有错误。

当一个测试被标记为有错误时，这并不意味着测试失败了。它只是意味着测试甚至无法尝试，因为它所依赖的一个东西出了问题。

这就是为什么最好尽可能减少给定测试的不必要依赖的原因之一。这样，无关事物的问题就不会导致我们对可能存在或不存在的问题有一个不完整的了解。

这是一个快速示例，有助于解释

import pytest


@pytest.fixture
def order():
    return []


@pytest.fixture
def append_first(order):
    order.append(1)


@pytest.fixture
def append_second(order, append_first):
    order.extend([2])


@pytest.fixture(autouse=True)
def append_third(order, append_second):
    order += [3]


def test_order(order):
    assert order == [1, 2, 3]

如果由于某种原因，order.append(1) 有一个 bug 并引发异常，我们将无法知道 order.extend([2]) 或 order += [3] 是否也会出现问题。在 append_first 抛出异常后，pytest 将不再为 test_order 运行任何 fixture，甚至不会尝试运行 test_order 本身。唯一会运行的将是 order 和 append_first。

关于 fixture 清理的注意事项¶

pytest 不会对 SIGTERM 和 SIGQUIT 信号进行任何特殊处理（SIGINT 通过 KeyboardInterrupt 由 Python 运行时自然处理），因此管理外部资源且在 Python 进程终止时（通过这些信号）清除这些资源很重要的 fixture 可能会泄漏资源。

pytest 不处理这些信号来执行 fixture 清理的原因是信号处理程序是全局的，更改它们可能会干扰正在执行的代码。

如果您的套件中的 fixture 在这些场景下需要特殊处理终止，请参阅问题跟踪器中的此评论以获取可能的解决方案。

关于 Fixture¶

什么是 Fixture¶

相对于 xUnit 风格的 setup/teardown 函数的改进¶

Fixture 错误¶

共享测试数据¶

关于 fixture 清理的注意事项¶