如何使用 Fixture

另请参阅

关于 Fixture

另请参阅

Fixture 参考

“请求” Fixture

在基本层面上，测试函数通过将 Fixture 声明为参数来请求它们。

当 pytest 要运行测试时，它会查看该测试函数签名中的参数，然后搜索与这些参数同名的 Fixture。一旦 pytest 找到它们，它就会运行这些 Fixture，捕获它们返回的内容（如果有），并将这些对象作为参数传递给测试函数。

快速示例

import pytest


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

    def cube(self):
        self.cubed = True


class FruitSalad:
    def __init__(self, *fruit_bowl):
        self.fruit = fruit_bowl
        self._cube_fruit()

    def _cube_fruit(self):
        for fruit in self.fruit:
            fruit.cube()


# Arrange
@pytest.fixture
def fruit_bowl():
    return [Fruit("apple"), Fruit("banana")]


def test_fruit_salad(fruit_bowl):
    # Act
    fruit_salad = FruitSalad(*fruit_bowl)

    # Assert
    assert all(fruit.cubed for fruit in fruit_salad.fruit)

在此示例中，test_fruit_salad “请求” fruit_bowl （即 def test_fruit_salad(fruit_bowl):），当 pytest 看到这一点时，它将执行 fruit_bowl fixture 函数，并将它返回的对象作为 fruit_bowl 参数传递到 test_fruit_salad 中。

如果我们手动执行，大致会发生以下情况

def fruit_bowl():
    return [Fruit("apple"), Fruit("banana")]


def test_fruit_salad(fruit_bowl):
    # Act
    fruit_salad = FruitSalad(*fruit_bowl)

    # Assert
    assert all(fruit.cubed for fruit in fruit_salad.fruit)


# Arrange
bowl = fruit_bowl()
test_fruit_salad(fruit_bowl=bowl)

Fixture 可以 请求 其他 Fixture

pytest 最强大的优势之一是其极其灵活的 Fixture 系统。它允许我们将复杂的测试需求归结为更简单和更有条理的函数，我们只需要让每个函数描述它们所依赖的东西。我们将在后面更深入地探讨这一点，但现在，这里有一个快速示例来演示 Fixture 如何使用其他 Fixture

# contents of test_append.py
import pytest


# Arrange
@pytest.fixture
def first_entry():
    return "a"


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


def test_string(order):
    # Act
    order.append("b")

    # Assert
    assert order == ["a", "b"]

请注意，这与上面的示例相同，但更改很少。pytest 中的 Fixture 请求 Fixture，就像测试一样。所有相同的 请求 规则都适用于测试的 Fixture。如果我们手动执行，此示例将如下工作

def first_entry():
    return "a"


def order(first_entry):
    return [first_entry]


def test_string(order):
    # Act
    order.append("b")

    # Assert
    assert order == ["a", "b"]


entry = first_entry()
the_list = order(first_entry=entry)
test_string(order=the_list)

Fixture 是可重用的

使 pytest 的 Fixture 系统如此强大的原因之一是，它使我们能够定义一个通用的设置步骤，可以一遍又一遍地重用，就像使用普通函数一样。两个不同的测试可以请求同一个 Fixture，并让 pytest 为每个测试提供来自该 Fixture 的自己的结果。

这对于确保测试不受彼此影响非常有用。我们可以使用此系统来确保每个测试都获得其自己的全新数据批次，并从干净的状态开始，以便它可以提供一致、可重复的结果。

这是一个关于这如何派上用场的示例

# contents of test_append.py
import pytest


# Arrange
@pytest.fixture
def first_entry():
    return "a"


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


def test_string(order):
    # Act
    order.append("b")

    # Assert
    assert order == ["a", "b"]


def test_int(order):
    # Act
    order.append(2)

    # Assert
    assert order == ["a", 2]

这里的每个测试都获得了该 list 对象的自己的副本，这意味着 order fixture 被执行了两次（first_entry fixture 也是如此）。如果我们也手动执行此操作，它看起来会像这样

def first_entry():
    return "a"


def order(first_entry):
    return [first_entry]


def test_string(order):
    # Act
    order.append("b")

    # Assert
    assert order == ["a", "b"]


def test_int(order):
    # Act
    order.append(2)

    # Assert
    assert order == ["a", 2]


entry = first_entry()
the_list = order(first_entry=entry)
test_string(order=the_list)

entry = first_entry()
the_list = order(first_entry=entry)
test_int(order=the_list)

一个测试/Fixture 可以一次 请求 多个 Fixture

测试和 Fixture 不限于一次 请求 单个 Fixture。他们可以根据需要请求任意多个。这是另一个快速示例来演示

# contents of test_append.py
import pytest


# Arrange
@pytest.fixture
def first_entry():
    return "a"


# Arrange
@pytest.fixture
def second_entry():
    return 2


# Arrange
@pytest.fixture
def order(first_entry, second_entry):
    return [first_entry, second_entry]


# Arrange
@pytest.fixture
def expected_list():
    return ["a", 2, 3.0]


def test_string(order, expected_list):
    # Act
    order.append(3.0)

    # Assert
    assert order == expected_list

Fixture 可以每个测试 请求 多次（返回值被缓存）

Fixture 也可以在同一测试期间 请求 多次，pytest 不会为该测试再次执行它们。这意味着我们可以在依赖于它们的多个 Fixture 中 请求 Fixture（甚至在测试本身中再次请求），而这些 Fixture 不会被执行多次。

# contents of test_append.py
import pytest


# Arrange
@pytest.fixture
def first_entry():
    return "a"


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


# Act
@pytest.fixture
def append_first(order, first_entry):
    return order.append(first_entry)


def test_string_only(append_first, order, first_entry):
    # Assert
    assert order == [first_entry]

如果 请求 的 Fixture 在测试期间每次 请求 时都执行一次，那么此测试将失败，因为 append_first 和 test_string_only 都将看到 order 作为一个空列表（即 []），但由于 order 的返回值在第一次调用后被缓存（以及执行它可能产生的任何副作用），因此测试和 append_first 都引用了同一个对象，并且测试看到了 append_first 对该对象的影响。

Autouse Fixture（您不必请求的 Fixture）

有时您可能希望拥有一个（甚至多个）Fixture，您知道所有测试都将依赖于它。“Autouse” Fixture 是一种方便的方式，使所有测试自动 请求 它们。这可以减少许多冗余的 请求，甚至可以提供更高级的 Fixture 用法（更多内容稍后介绍）。

我们可以通过将 autouse=True 传递给 Fixture 的装饰器来使 Fixture 成为 autouse Fixture。这是一个关于如何使用它们的简单示例

# contents of test_append.py
import pytest


@pytest.fixture
def first_entry():
    return "a"


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


@pytest.fixture(autouse=True)
def append_first(order, first_entry):
    return order.append(first_entry)


def test_string_only(order, first_entry):
    assert order == [first_entry]


def test_string_and_int(order, first_entry):
    order.append(2)
    assert order == [first_entry, 2]

在此示例中，append_first fixture 是一个 autouse fixture。因为它自动发生，所以两个测试都受到它的影响，即使两个测试都没有 请求 它。但这并不意味着它们不能被 请求；只是它不是必要的。

Scope：跨类、模块、包或会话共享 Fixture

需要网络访问的 Fixture 依赖于连接性，并且通常创建起来很耗时。扩展前面的示例，我们可以将 scope="module" 参数添加到 @pytest.fixture 调用中，以使 smtp_connection fixture 函数（负责创建与预先存在的 SMTP 服务器的连接）仅在每个测试模块中调用一次（默认情况下是每个测试函数调用一次）。因此，测试模块中的多个测试函数将各自接收相同的 smtp_connection fixture 实例，从而节省时间。scope 的可能值包括：function、class、module、package 或 session。

下一个示例将 fixture 函数放入单独的 conftest.py 文件中，以便目录中多个测试模块中的测试可以访问 fixture 函数

# content of conftest.py
import smtplib

import pytest


@pytest.fixture(scope="module")
def smtp_connection():
    return smtplib.SMTP("smtp.gmail.com", 587, timeout=5)

# content of test_module.py


def test_ehlo(smtp_connection):
    response, msg = smtp_connection.ehlo()
    assert response == 250
    assert b"smtp.gmail.com" in msg
    assert 0  # for demo purposes


def test_noop(smtp_connection):
    response, msg = smtp_connection.noop()
    assert response == 250
    assert 0  # for demo purposes

在这里，test_ehlo 需要 smtp_connection fixture 值。pytest 将发现并调用 @pytest.fixture 标记的 smtp_connection fixture 函数。运行测试看起来像这样

$ pytest test_module.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 2 items

test_module.py FF                                                    [100%]

================================= FAILURES =================================
________________________________ test_ehlo _________________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0001>

    def test_ehlo(smtp_connection):
        response, msg = smtp_connection.ehlo()
        assert response == 250
        assert b"smtp.gmail.com" in msg
>       assert 0  # for demo purposes
E       assert 0

test_module.py:7: AssertionError
________________________________ test_noop _________________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0001>

    def test_noop(smtp_connection):
        response, msg = smtp_connection.noop()
        assert response == 250
>       assert 0  # for demo purposes
E       assert 0

test_module.py:13: AssertionError
========================= short test summary info ==========================
FAILED test_module.py::test_ehlo - assert 0
FAILED test_module.py::test_noop - assert 0
============================ 2 failed in 0.12s =============================

您会看到两个 assert 0 失败，更重要的是，您还可以看到，完全相同 的 smtp_connection 对象被传递到两个测试函数中，因为 pytest 在回溯中显示了传入的参数值。因此，使用 smtp_connection 的两个测试函数运行速度与单个测试函数一样快，因为它们重用了相同的实例。

如果您决定希望拥有会话作用域的 smtp_connection 实例，您可以简单地声明它

@pytest.fixture(scope="session")
def smtp_connection():
    # the returned fixture value will be shared for
    # all tests requesting it
    ...

Fixture 作用域

Fixture 在首次被测试请求时创建，并根据其 scope 销毁

• function：默认作用域，Fixture 在测试结束时销毁。

• class：Fixture 在类中最后一个测试的拆卸期间销毁。

• module：Fixture 在模块中最后一个测试的拆卸期间销毁。

• package：Fixture 在定义 Fixture 的包（包括其中的子包和子目录）中最后一个测试的拆卸期间销毁。

• session：Fixture 在测试会话结束时销毁。

注意

Pytest 一次只缓存一个 Fixture 实例，这意味着当使用参数化的 Fixture 时，pytest 可能会在给定的作用域内多次调用 Fixture。

动态作用域

在 5.2 版本中添加。

在某些情况下，您可能希望在不更改代码的情况下更改 Fixture 的作用域。为此，请将可调用对象传递给 scope。可调用对象必须返回一个带有有效作用域的字符串，并且只执行一次 - 在 Fixture 定义期间。它将使用两个关键字参数调用 - fixture_name 作为字符串，config 作为配置对象。

当处理需要时间设置的 Fixture（例如，生成 docker 容器）时，这可能特别有用。您可以使用命令行参数来控制不同环境的生成容器的作用域。请参阅下面的示例。

def determine_scope(fixture_name, config):
    if config.getoption("--keep-containers", None):
        return "session"
    return "function"


@pytest.fixture(scope=determine_scope)
def docker_container():
    yield spawn_container()

拆卸/清理（又名 Fixture 终结）

当我们运行测试时，我们希望确保它们在完成后进行清理，以免干扰任何其他测试（并且也避免留下大量的测试数据来膨胀系统）。pytest 中的 Fixture 提供了一个非常有用的拆卸系统，它允许我们为每个 Fixture 定义必要的特定步骤，以便在完成后进行清理。

此系统可以通过两种方式利用。

1. yield Fixture（推荐）

“Yield” Fixture 使用 yield 而不是 return。使用这些 Fixture，我们可以运行一些代码并将对象返回给请求的 Fixture/测试，就像使用其他 Fixture 一样。唯一的区别是

1. return 被替换为 yield。

2. 该 Fixture 的任何拆卸代码都放在 yield 之后。

一旦 pytest 确定了 Fixture 的线性顺序，它将运行每个 Fixture，直到它返回或 yield，然后继续列表中的下一个 Fixture 执行相同的操作。

测试完成后，pytest 将返回 Fixture 列表，但以相反的顺序，获取每个 yield 的 Fixture，并运行其中在 yield 语句之后 的代码。

作为一个简单的示例，请考虑这个基本的电子邮件模块

# content of emaillib.py
class MailAdminClient:
    def create_user(self):
        return MailUser()

    def delete_user(self, user):
        # do some cleanup
        pass


class MailUser:
    def __init__(self):
        self.inbox = []

    def send_email(self, email, other):
        other.inbox.append(email)

    def clear_mailbox(self):
        self.inbox.clear()


class Email:
    def __init__(self, subject, body):
        self.subject = subject
        self.body = body

假设我们要测试从一个用户向另一个用户发送电子邮件。我们首先必须创建每个用户，然后从一个用户向另一个用户发送电子邮件，最后断言另一个用户在其收件箱中收到了该消息。如果我们想在测试运行后进行清理，我们可能必须确保在删除该用户之前清空另一个用户的邮箱，否则系统可能会报错。

这就是它可能的样子

# content of test_emaillib.py
from emaillib import Email, MailAdminClient

import pytest


@pytest.fixture
def mail_admin():
    return MailAdminClient()


@pytest.fixture
def sending_user(mail_admin):
    user = mail_admin.create_user()
    yield user
    mail_admin.delete_user(user)


@pytest.fixture
def receiving_user(mail_admin):
    user = mail_admin.create_user()
    yield user
    user.clear_mailbox()
    mail_admin.delete_user(user)


def test_email_received(sending_user, receiving_user):
    email = Email(subject="Hey!", body="How's it going?")
    sending_user.send_email(email, receiving_user)
    assert email in receiving_user.inbox

因为 receiving_user 是设置期间最后运行的 Fixture，所以它是拆卸期间第一个运行的 Fixture。

存在一种风险，即使在拆卸方面顺序正确也不能保证安全清理。这在 安全拆卸 中有更详细的介绍。

$ pytest -q test_emaillib.py
.                                                                    [100%]
1 passed in 0.12s

处理 yield Fixture 的错误

如果 yield Fixture 在 yield 之前引发异常，则 pytest 不会尝试在该 yield Fixture 的 yield 语句之后运行拆卸代码。但是，对于该测试已成功运行的每个 Fixture，pytest 仍将尝试像往常一样拆卸它们。

2. 直接添加终结器

虽然 yield Fixture 被认为是更简洁和更直接的选择，但还有另一种选择，那就是直接向测试的 请求上下文 对象添加“终结器”函数。它带来了与 yield Fixture 类似的结果，但需要更多的冗长。

为了使用这种方法，我们必须在我们需要添加拆卸代码的 Fixture 中请求 请求上下文 对象（就像我们请求另一个 Fixture 一样），然后将包含该拆卸代码的可调用对象传递给其 addfinalizer 方法。

我们必须小心，因为即使该 Fixture 在添加终结器后引发异常，pytest 也会运行该终结器。因此，为了确保我们在不需要运行终结器代码时不会运行它，我们只会在 Fixture 完成了我们需要拆卸的操作后才添加终结器。

以下是使用 addfinalizer 方法的先前示例的样子

# content of test_emaillib.py
from emaillib import Email, MailAdminClient

import pytest


@pytest.fixture
def mail_admin():
    return MailAdminClient()


@pytest.fixture
def sending_user(mail_admin):
    user = mail_admin.create_user()
    yield user
    mail_admin.delete_user(user)


@pytest.fixture
def receiving_user(mail_admin, request):
    user = mail_admin.create_user()

    def delete_user():
        mail_admin.delete_user(user)

    request.addfinalizer(delete_user)
    return user


@pytest.fixture
def email(sending_user, receiving_user, request):
    _email = Email(subject="Hey!", body="How's it going?")
    sending_user.send_email(_email, receiving_user)

    def empty_mailbox():
        receiving_user.clear_mailbox()

    request.addfinalizer(empty_mailbox)
    return _email


def test_email_received(receiving_user, email):
    assert email in receiving_user.inbox

它比 yield Fixture 长一点，也更复杂一点，但它确实提供了一些在您遇到困难时的细微差别。

$ pytest -q test_emaillib.py
.                                                                    [100%]
1 passed in 0.12s

关于终结器顺序的说明

终结器以先进后出的顺序执行。对于 yield Fixture，第一个要运行的拆卸代码来自最右边的 Fixture，即最后一个测试参数。

# content of test_finalizers.py
import pytest


def test_bar(fix_w_yield1, fix_w_yield2):
    print("test_bar")


@pytest.fixture
def fix_w_yield1():
    yield
    print("after_yield_1")


@pytest.fixture
def fix_w_yield2():
    yield
    print("after_yield_2")

$ pytest -s test_finalizers.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 1 item

test_finalizers.py test_bar
.after_yield_2
after_yield_1


============================ 1 passed in 0.12s =============================

对于终结器，第一个要运行的 Fixture 是最后一次调用 request.addfinalizer。

# content of test_finalizers.py
from functools import partial
import pytest


@pytest.fixture
def fix_w_finalizers(request):
    request.addfinalizer(partial(print, "finalizer_2"))
    request.addfinalizer(partial(print, "finalizer_1"))


def test_bar(fix_w_finalizers):
    print("test_bar")

$ pytest -s test_finalizers.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 1 item

test_finalizers.py test_bar
.finalizer_1
finalizer_2


============================ 1 passed in 0.12s =============================

这是因为 yield Fixture 在幕后使用 addfinalizer：当 Fixture 执行时，addfinalizer 注册一个恢复生成器的函数，该函数反过来调用拆卸代码。

安全拆卸

pytest 的 Fixture 系统非常强大，但它仍然由计算机运行，因此它无法弄清楚如何安全地拆卸我们抛给它的所有东西。如果我们不小心，错误位置的错误可能会留下测试中的东西，这可能会很快导致进一步的问题。

例如，考虑以下测试（基于上面邮件示例）

# content of test_emaillib.py
from emaillib import Email, MailAdminClient

import pytest


@pytest.fixture
def setup():
    mail_admin = MailAdminClient()
    sending_user = mail_admin.create_user()
    receiving_user = mail_admin.create_user()
    email = Email(subject="Hey!", body="How's it going?")
    sending_user.send_email(email, receiving_user)
    yield receiving_user, email
    receiving_user.clear_mailbox()
    mail_admin.delete_user(sending_user)
    mail_admin.delete_user(receiving_user)


def test_email_received(setup):
    receiving_user, email = setup
    assert email in receiving_user.inbox

此版本更紧凑，但也更难阅读，没有非常描述性的 Fixture 名称，并且没有一个 Fixture 可以轻松重用。

还有一个更严重的问题，那就是如果设置中的任何步骤引发异常，则不会运行任何拆卸代码。

一种选择可能是使用 addfinalizer 方法而不是 yield Fixture，但这可能会变得非常复杂且难以维护（并且不再紧凑）。

$ pytest -q test_emaillib.py
.                                                                    [100%]
1 passed in 0.12s

安全的 Fixture 结构

最安全和最简单的 Fixture 结构要求将 Fixture 限制为每个 Fixture 仅进行一个状态更改操作，然后将它们与其拆卸代码捆绑在一起，如 上面的电子邮件示例 所示。

状态更改操作可能失败但仍修改状态的可能性微乎其微，因为大多数这些操作倾向于基于 事务（至少在可能留下状态的测试级别）。因此，如果我们确保任何成功的状态更改操作都通过将其移动到单独的 Fixture 函数并将其与其他可能失败的状态更改操作分离来拆卸，那么我们的测试将有最好的机会使测试环境保持找到时的状态。

例如，假设我们有一个带有登录页面的网站，并且我们可以访问管理员 API，我们可以在其中生成用户。对于我们的测试，我们想要

1. 通过该管理员 API 创建用户

2. 使用 Selenium 启动浏览器

3. 转到我们网站的登录页面

4. 以我们创建的用户身份登录

5. 断言他们的名字在着陆页的标题中

我们不想将该用户留在系统中，也不想让该浏览器会话保持运行，因此我们要确保创建这些东西的 Fixture 在完成后进行清理。

这就是它可能的样子

注意

对于此示例，某些 Fixture（即 base_url 和 admin_credentials）被暗示在其他地方存在。因此，目前，让我们假设它们存在，而我们只是没有关注它们。

from uuid import uuid4
from urllib.parse import urljoin

from selenium.webdriver import Chrome
import pytest

from src.utils.pages import LoginPage, LandingPage
from src.utils import AdminApiClient
from src.utils.data_types import User


@pytest.fixture
def admin_client(base_url, admin_credentials):
    return AdminApiClient(base_url, **admin_credentials)


@pytest.fixture
def user(admin_client):
    _user = User(name="Susan", username=f"testuser-{uuid4()}", password="P4$$word")
    admin_client.create_user(_user)
    yield _user
    admin_client.delete_user(_user)


@pytest.fixture
def driver():
    _driver = Chrome()
    yield _driver
    _driver.quit()


@pytest.fixture
def login(driver, base_url, user):
    driver.get(urljoin(base_url, "/login"))
    page = LoginPage(driver)
    page.login(user)


@pytest.fixture
def landing_page(driver, login):
    return LandingPage(driver)


def test_name_on_landing_page_after_login(landing_page, user):
    assert landing_page.header == f"Welcome, {user.name}!"

依赖关系的布局方式意味着不清楚 user Fixture 是否会在 driver Fixture 之前执行。但这没关系，因为这些都是原子操作，因此哪个先运行并不重要，因为测试的事件序列仍然是 线性化 的。但重要的是，无论哪个先运行，如果其中一个引发异常而另一个本不会引发异常，则两者都不会留下任何东西。如果 driver 在 user 之前执行，并且 user 引发异常，则驱动程序仍将退出，并且用户从未创建。如果 driver 是引发异常的那个，那么驱动程序将永远不会启动，并且用户将永远不会创建。

安全地运行多个 assert 语句

有时您可能希望在完成所有设置后运行多个断言，这很有意义，因为在更复杂的系统中，单个操作可以启动多个行为。pytest 提供了一种方便的方法来处理这个问题，它结合了我们到目前为止讨论过的许多内容。

所需的只是提升到更大的作用域，然后将 act 步骤定义为 autouse Fixture，最后，确保所有 Fixture 都以该更高级别的作用域为目标。

让我们从 上面的示例 中提取一个示例，并稍微调整一下。假设除了检查标题中的欢迎消息外，我们还想检查注销按钮以及指向用户个人资料的链接。

让我们看看如何构建它，以便我们可以运行多个断言，而无需再次重复所有这些步骤。

注意

对于此示例，某些 Fixture（即 base_url 和 admin_credentials）被暗示在其他地方存在。因此，目前，让我们假设它们存在，而我们只是没有关注它们。

# contents of tests/end_to_end/test_login.py
from uuid import uuid4
from urllib.parse import urljoin

from selenium.webdriver import Chrome
import pytest

from src.utils.pages import LoginPage, LandingPage
from src.utils import AdminApiClient
from src.utils.data_types import User


@pytest.fixture(scope="class")
def admin_client(base_url, admin_credentials):
    return AdminApiClient(base_url, **admin_credentials)


@pytest.fixture(scope="class")
def user(admin_client):
    _user = User(name="Susan", username=f"testuser-{uuid4()}", password="P4$$word")
    admin_client.create_user(_user)
    yield _user
    admin_client.delete_user(_user)


@pytest.fixture(scope="class")
def driver():
    _driver = Chrome()
    yield _driver
    _driver.quit()


@pytest.fixture(scope="class")
def landing_page(driver, login):
    return LandingPage(driver)


class TestLandingPageSuccess:
    @pytest.fixture(scope="class", autouse=True)
    def login(self, driver, base_url, user):
        driver.get(urljoin(base_url, "/login"))
        page = LoginPage(driver)
        page.login(user)

    def test_name_in_header(self, landing_page, user):
        assert landing_page.header == f"Welcome, {user.name}!"

    def test_sign_out_button(self, landing_page):
        assert landing_page.sign_out_button.is_displayed()

    def test_profile_link(self, landing_page, user):
        profile_href = urljoin(base_url, f"/profile?id={user.profile_id}")
        assert landing_page.profile_link.get_attribute("href") == profile_href

请注意，这些方法仅在签名中引用 self 作为形式。没有状态绑定到实际的测试类，就像在 unittest.TestCase 框架中一样。一切都由 pytest Fixture 系统管理。

每个方法只需要请求它实际需要的 Fixture，而无需担心顺序。这是因为 act Fixture 是一个 autouse Fixture，它确保所有其他 Fixture 在它之前执行。不再需要进行状态更改，因此测试可以自由地进行任意数量的非状态更改查询，而不会冒着踩到其他测试脚趾的风险。

login fixture 也在类内部定义，因为模块中的其他测试并非每个都期望成功登录，并且 act 可能需要为另一个测试类进行稍微不同的处理。例如，如果我们想编写另一个关于提交错误凭据的测试场景，我们可以通过向测试文件添加如下内容来处理它

class TestLandingPageBadCredentials:
    @pytest.fixture(scope="class")
    def faux_user(self, user):
        _user = deepcopy(user)
        _user.password = "badpass"
        return _user

    def test_raises_bad_credentials_exception(self, login_page, faux_user):
        with pytest.raises(BadCredentialsException):
            login_page.login(faux_user)

Fixture 可以内省请求测试上下文

Fixture 函数可以接受 request 对象，以内省“请求”测试函数、类或模块上下文。进一步扩展之前的 smtp_connection fixture 示例，让我们从使用我们的 fixture 的测试模块中读取可选的服务器 URL

# content of conftest.py
import smtplib

import pytest


@pytest.fixture(scope="module")
def smtp_connection(request):
    server = getattr(request.module, "smtpserver", "smtp.gmail.com")
    smtp_connection = smtplib.SMTP(server, 587, timeout=5)
    yield smtp_connection
    print(f"finalizing {smtp_connection} ({server})")
    smtp_connection.close()

我们使用 request.module 属性来选择性地从测试模块获取 smtpserver 属性。如果我们再次执行，则变化不大

$ pytest -s -q --tb=no test_module.py
FFfinalizing <smtplib.SMTP object at 0xdeadbeef0002> (smtp.gmail.com)

========================= short test summary info ==========================
FAILED test_module.py::test_ehlo - assert 0
FAILED test_module.py::test_noop - assert 0
2 failed in 0.12s

让我们快速创建另一个测试模块，该模块实际上在其模块命名空间中设置了服务器 URL

# content of test_anothersmtp.py

smtpserver = "mail.python.org"  # will be read by smtp fixture


def test_showhelo(smtp_connection):
    assert 0, smtp_connection.helo()

运行它

$ pytest -qq --tb=short test_anothersmtp.py
F                                                                    [100%]
================================= FAILURES =================================
______________________________ test_showhelo _______________________________
test_anothersmtp.py:6: in test_showhelo
    assert 0, smtp_connection.helo()
E   AssertionError: (250, b'mail.python.org')
E   assert 0
------------------------- Captured stdout teardown -------------------------
finalizing <smtplib.SMTP object at 0xdeadbeef0003> (mail.python.org)
========================= short test summary info ==========================
FAILED test_anothersmtp.py::test_showhelo - AssertionError: (250, b'mail....

瞧！smtp_connection fixture 函数从模块命名空间中获取了我们的邮件服务器名称。

使用标记将数据传递给 Fixture

使用 request 对象，fixture 还可以访问应用于测试函数的标记。这对于从测试向 fixture 传递数据很有用

import pytest


@pytest.fixture
def fixt(request):
    marker = request.node.get_closest_marker("fixt_data")
    if marker is None:
        # Handle missing marker in some way...
        data = None
    else:
        data = marker.args[0]

    # Do something with the data
    return data


@pytest.mark.fixt_data(42)
def test_fixt(fixt):
    assert fixt == 42

工厂作为 Fixture

“工厂作为 Fixture”模式可以在单个测试中多次需要 Fixture 结果的情况下提供帮助。Fixture 不直接返回数据，而是返回一个生成数据的函数。然后可以在测试中多次调用此函数。

工厂可以根据需要具有参数

@pytest.fixture
def make_customer_record():
    def _make_customer_record(name):
        return {"name": name, "orders": []}

    return _make_customer_record


def test_customer_records(make_customer_record):
    customer_1 = make_customer_record("Lisa")
    customer_2 = make_customer_record("Mike")
    customer_3 = make_customer_record("Meredith")

如果工厂创建的数据需要管理，则 Fixture 可以负责处理

@pytest.fixture
def make_customer_record():
    created_records = []

    def _make_customer_record(name):
        record = models.Customer(name=name, orders=[])
        created_records.append(record)
        return record

    yield _make_customer_record

    for record in created_records:
        record.destroy()


def test_customer_records(make_customer_record):
    customer_1 = make_customer_record("Lisa")
    customer_2 = make_customer_record("Mike")
    customer_3 = make_customer_record("Meredith")

参数化 Fixture

Fixture 函数可以被参数化，在这种情况下，它们将被多次调用，每次执行一组依赖的测试，即依赖于此 Fixture 的测试。测试函数通常不需要知道它们的重新运行。Fixture 参数化有助于为组件编写详尽的功能测试，这些组件本身可以以多种方式配置。

扩展前面的示例，我们可以标记 Fixture 以创建两个 smtp_connection fixture 实例，这将导致所有使用该 fixture 的测试运行两次。Fixture 函数可以通过特殊的 request 对象访问每个参数

# content of conftest.py
import smtplib

import pytest


@pytest.fixture(scope="module", params=["smtp.gmail.com", "mail.python.org"])
def smtp_connection(request):
    smtp_connection = smtplib.SMTP(request.param, 587, timeout=5)
    yield smtp_connection
    print(f"finalizing {smtp_connection}")
    smtp_connection.close()

主要更改是使用 @pytest.fixture 声明 params，它是值的列表，对于列表中的每个值，fixture 函数将执行，并且可以通过 request.param 访问一个值。无需更改任何测试函数代码。所以让我们再运行一次

$ pytest -q test_module.py
FFFF                                                                 [100%]
================================= FAILURES =================================
________________________ test_ehlo[smtp.gmail.com] _________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0004>

    def test_ehlo(smtp_connection):
        response, msg = smtp_connection.ehlo()
        assert response == 250
        assert b"smtp.gmail.com" in msg
>       assert 0  # for demo purposes
E       assert 0

test_module.py:7: AssertionError
________________________ test_noop[smtp.gmail.com] _________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0004>

    def test_noop(smtp_connection):
        response, msg = smtp_connection.noop()
        assert response == 250
>       assert 0  # for demo purposes
E       assert 0

test_module.py:13: AssertionError
________________________ test_ehlo[mail.python.org] ________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0005>

    def test_ehlo(smtp_connection):
        response, msg = smtp_connection.ehlo()
        assert response == 250
>       assert b"smtp.gmail.com" in msg
E       AssertionError: assert b'smtp.gmail.com' in b'mail.python.org\nPIPELINING\nSIZE 51200000\nETRN\nSTARTTLS\nAUTH DIGEST-MD5 NTLM CRAM-MD5\nENHANCEDSTATUSCODES\n8BITMIME\nDSN\nSMTPUTF8\nCHUNKING'

test_module.py:6: AssertionError
-------------------------- Captured stdout setup ---------------------------
finalizing <smtplib.SMTP object at 0xdeadbeef0004>
________________________ test_noop[mail.python.org] ________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0005>

    def test_noop(smtp_connection):
        response, msg = smtp_connection.noop()
        assert response == 250
>       assert 0  # for demo purposes
E       assert 0

test_module.py:13: AssertionError
------------------------- Captured stdout teardown -------------------------
finalizing <smtplib.SMTP object at 0xdeadbeef0005>
========================= short test summary info ==========================
FAILED test_module.py::test_ehlo[smtp.gmail.com] - assert 0
FAILED test_module.py::test_noop[smtp.gmail.com] - assert 0
FAILED test_module.py::test_ehlo[mail.python.org] - AssertionError: asser...
FAILED test_module.py::test_noop[mail.python.org] - assert 0
4 failed in 0.12s

我们看到我们的两个测试函数都针对不同的 smtp_connection 实例运行了两次。另请注意，使用 mail.python.org 连接，第二个测试在 test_ehlo 中失败，因为预期的服务器字符串与到达的字符串不同。

pytest 将构建一个字符串，该字符串是参数化 fixture 中每个 fixture 值的测试 ID，例如上面示例中的 test_ehlo[smtp.gmail.com] 和 test_ehlo[mail.python.org]。这些 ID 可以与 -k 一起使用，以选择要运行的特定情况，并且当某个情况失败时，它们也将标识该特定情况。使用 --collect-only 运行 pytest 将显示生成的 ID。

数字、字符串、布尔值和 None 将在测试 ID 中使用它们通常的字符串表示形式。对于其他对象，pytest 将基于参数名称创建一个字符串。可以使用 ids 关键字参数自定义在特定 fixture 值的测试 ID 中使用的字符串

# content of test_ids.py
import pytest


@pytest.fixture(params=[0, 1], ids=["spam", "ham"])
def a(request):
    return request.param


def test_a(a):
    pass


def idfn(fixture_value):
    if fixture_value == 0:
        return "eggs"
    else:
        return None


@pytest.fixture(params=[0, 1], ids=idfn)
def b(request):
    return request.param


def test_b(b):
    pass

上面显示了 ids 可以是要使用的字符串列表，也可以是一个函数，该函数将使用 fixture 值调用，然后必须返回一个要使用的字符串。在后一种情况下，如果该函数返回 None，则将使用 pytest 自动生成的 ID。

运行上述测试会导致使用以下测试 ID

$ pytest --collect-only
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 12 items

<Dir fixtures.rst-227>
  <Module test_anothersmtp.py>
    <Function test_showhelo[smtp.gmail.com]>
    <Function test_showhelo[mail.python.org]>
  <Module test_emaillib.py>
    <Function test_email_received>
  <Module test_finalizers.py>
    <Function test_bar>
  <Module test_ids.py>
    <Function test_a[spam]>
    <Function test_a[ham]>
    <Function test_b[eggs]>
    <Function test_b[1]>
  <Module test_module.py>
    <Function test_ehlo[smtp.gmail.com]>
    <Function test_noop[smtp.gmail.com]>
    <Function test_ehlo[mail.python.org]>
    <Function test_noop[mail.python.org]>

======================= 12 tests collected in 0.12s ========================

将标记与参数化 Fixture 一起使用

pytest.param() 可用于在参数化 fixture 的值集中应用标记，其方式与它们与 @pytest.mark.parametrize 一起使用的方式相同。

示例

# content of test_fixture_marks.py
import pytest


@pytest.fixture(params=[0, 1, pytest.param(2, marks=pytest.mark.skip)])
def data_set(request):
    return request.param


def test_data(data_set):
    pass

运行此测试将跳过使用值 2 调用 data_set

$ pytest test_fixture_marks.py -v
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python
cachedir: .pytest_cache
rootdir: /home/sweet/project
collecting ... collected 3 items

test_fixture_marks.py::test_data[0] PASSED                           [ 33%]
test_fixture_marks.py::test_data[1] PASSED                           [ 66%]
test_fixture_marks.py::test_data[2] SKIPPED (unconditional skip)     [100%]

======================= 2 passed, 1 skipped in 0.12s =======================

模块化：从 Fixture 函数中使用 Fixture

除了在测试函数中使用 Fixture 之外，Fixture 函数本身也可以使用其他 Fixture。这有助于您的 Fixture 的模块化设计，并允许在许多项目中重用框架特定的 Fixture。作为一个简单的示例，我们可以扩展前面的示例并实例化一个对象 app，我们在其中粘贴已定义的 smtp_connection 资源

# content of test_appsetup.py

import pytest


class App:
    def __init__(self, smtp_connection):
        self.smtp_connection = smtp_connection


@pytest.fixture(scope="module")
def app(smtp_connection):
    return App(smtp_connection)


def test_smtp_connection_exists(app):
    assert app.smtp_connection

在这里，我们声明了一个 app fixture，它接收先前定义的 smtp_connection fixture，并使用它实例化一个 App 对象。让我们运行它

$ pytest -v test_appsetup.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python
cachedir: .pytest_cache
rootdir: /home/sweet/project
collecting ... collected 2 items

test_appsetup.py::test_smtp_connection_exists[smtp.gmail.com] PASSED [ 50%]
test_appsetup.py::test_smtp_connection_exists[mail.python.org] PASSED [100%]

============================ 2 passed in 0.12s =============================

由于 smtp_connection 的参数化，测试将使用两个不同的 App 实例和相应的 smtp 服务器运行两次。app fixture 不需要知道 smtp_connection 参数化，因为 pytest 将完全分析 fixture 依赖关系图。

请注意，app fixture 的作用域为 module，并使用模块作用域的 smtp_connection fixture。如果 smtp_connection 被缓存在 session 作用域上，示例仍然可以工作：fixture 可以使用“更广”作用域的 fixture，但反之则不行：会话作用域的 fixture 无法以有意义的方式使用模块作用域的 fixture。

通过 fixture 实例自动分组测试

pytest 最小化测试运行期间的活动 fixture 的数量。如果您有一个参数化的 fixture，那么所有使用它的测试将首先使用一个实例执行，然后在创建下一个 fixture 实例之前调用 finalizer。除其他事项外，这简化了创建和使用全局状态的应用程序的测试。

以下示例使用两个参数化的 fixture，其中一个的作用域是基于每个模块的，并且所有函数都执行 print 调用以显示 setup/teardown 流程

# content of test_module.py
import pytest


@pytest.fixture(scope="module", params=["mod1", "mod2"])
def modarg(request):
    param = request.param
    print("  SETUP modarg", param)
    yield param
    print("  TEARDOWN modarg", param)


@pytest.fixture(scope="function", params=[1, 2])
def otherarg(request):
    param = request.param
    print("  SETUP otherarg", param)
    yield param
    print("  TEARDOWN otherarg", param)


def test_0(otherarg):
    print("  RUN test0 with otherarg", otherarg)


def test_1(modarg):
    print("  RUN test1 with modarg", modarg)


def test_2(otherarg, modarg):
    print(f"  RUN test2 with otherarg {otherarg} and modarg {modarg}")

让我们在 verbose 模式下运行测试并查看 print 输出

$ pytest -v -s test_module.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python
cachedir: .pytest_cache
rootdir: /home/sweet/project
collecting ... collected 8 items

test_module.py::test_0[1]   SETUP otherarg 1
  RUN test0 with otherarg 1
PASSED  TEARDOWN otherarg 1

test_module.py::test_0[2]   SETUP otherarg 2
  RUN test0 with otherarg 2
PASSED  TEARDOWN otherarg 2

test_module.py::test_1[mod1]   SETUP modarg mod1
  RUN test1 with modarg mod1
PASSED
test_module.py::test_2[mod1-1]   SETUP otherarg 1
  RUN test2 with otherarg 1 and modarg mod1
PASSED  TEARDOWN otherarg 1

test_module.py::test_2[mod1-2]   SETUP otherarg 2
  RUN test2 with otherarg 2 and modarg mod1
PASSED  TEARDOWN otherarg 2

test_module.py::test_1[mod2]   TEARDOWN modarg mod1
  SETUP modarg mod2
  RUN test1 with modarg mod2
PASSED
test_module.py::test_2[mod2-1]   SETUP otherarg 1
  RUN test2 with otherarg 1 and modarg mod2
PASSED  TEARDOWN otherarg 1

test_module.py::test_2[mod2-2]   SETUP otherarg 2
  RUN test2 with otherarg 2 and modarg mod2
PASSED  TEARDOWN otherarg 2
  TEARDOWN modarg mod2


============================ 8 passed in 0.12s =============================

您可以看到，参数化的模块作用域 modarg 资源导致了测试执行的顺序，从而实现了最少的“活动”资源。 mod1 参数化资源的 finalizer 在 mod2 资源设置之前执行。

特别注意 test_0 是完全独立的，并且首先完成。然后 test_1 使用 mod1 执行，然后 test_2 使用 mod1 执行，然后 test_1 使用 mod2 执行，最后 test_2 使用 mod2 执行。

otherarg 参数化资源（具有函数作用域）在每个使用它的测试之前设置，并在之后拆卸。

在类和模块中使用 fixture 与 usefixtures

有时测试函数不需要直接访问 fixture 对象。例如，测试可能需要使用空目录作为当前工作目录，但除此之外不关心具体的目录。以下是如何使用标准的 tempfile 和 pytest fixture 来实现它。我们将 fixture 的创建分离到一个 conftest.py 文件中

# content of conftest.py

import os
import tempfile

import pytest


@pytest.fixture
def cleandir():
    with tempfile.TemporaryDirectory() as newpath:
        old_cwd = os.getcwd()
        os.chdir(newpath)
        yield
        os.chdir(old_cwd)

并通过 usefixtures 标记在测试模块中声明其使用

# content of test_setenv.py
import os

import pytest


@pytest.mark.usefixtures("cleandir")
class TestDirectoryInit:
    def test_cwd_starts_empty(self):
        assert os.listdir(os.getcwd()) == []
        with open("myfile", "w", encoding="utf-8") as f:
            f.write("hello")

    def test_cwd_again_starts_empty(self):
        assert os.listdir(os.getcwd()) == []

由于 usefixtures 标记，cleandir fixture 将被每个测试方法的执行所需要，就像您为它们中的每一个指定了 “cleandir” 函数参数一样。让我们运行它来验证我们的 fixture 是否被激活并且测试通过

$ pytest -q
..                                                                   [100%]
2 passed in 0.12s

您可以像这样指定多个 fixture

@pytest.mark.usefixtures("cleandir", "anotherfixture")
def test(): ...

您可以使用 pytestmark 在测试模块级别指定 fixture 的使用

pytestmark = pytest.mark.usefixtures("cleandir")

也可以将项目中所有测试需要的 fixture 放入 ini 文件中

# content of pytest.ini
[pytest]
usefixtures = cleandir

警告

请注意，此标记在 fixture 函数 中无效。例如，这 将不会按预期工作

@pytest.mark.usefixtures("my_other_fixture")
@pytest.fixture
def my_fixture_that_sadly_wont_use_my_other_fixture(): ...

这将生成一个弃用警告，并在 Pytest 8 中变为错误。

在不同级别覆盖 fixture

在相对较大的测试套件中，您很可能需要用 locally 定义的 fixture override global 或 root fixture，以保持测试代码的可读性和可维护性。

在文件夹 (conftest) 级别覆盖 fixture

假设测试文件结构是

tests/
    conftest.py
        # content of tests/conftest.py
        import pytest

        @pytest.fixture
        def username():
            return 'username'

    test_something.py
        # content of tests/test_something.py
        def test_username(username):
            assert username == 'username'

    subfolder/
        conftest.py
            # content of tests/subfolder/conftest.py
            import pytest

            @pytest.fixture
            def username(username):
                return 'overridden-' + username

        test_something_else.py
            # content of tests/subfolder/test_something_else.py
            def test_username(username):
                assert username == 'overridden-username'

如您所见，可以为特定的测试文件夹级别覆盖具有相同名称的 fixture。请注意，可以从 overriding fixture 轻松访问 base 或 super fixture - 在上面的示例中使用。

在测试模块级别覆盖 fixture

假设测试文件结构是

tests/
    conftest.py
        # content of tests/conftest.py
        import pytest

        @pytest.fixture
        def username():
            return 'username'

    test_something.py
        # content of tests/test_something.py
        import pytest

        @pytest.fixture
        def username(username):
            return 'overridden-' + username

        def test_username(username):
            assert username == 'overridden-username'

    test_something_else.py
        # content of tests/test_something_else.py
        import pytest

        @pytest.fixture
        def username(username):
            return 'overridden-else-' + username

        def test_username(username):
            assert username == 'overridden-else-username'

在上面的示例中，可以为特定的测试模块覆盖具有相同名称的 fixture。

通过直接测试参数化覆盖 fixture

假设测试文件结构是

tests/
    conftest.py
        # content of tests/conftest.py
        import pytest

        @pytest.fixture
        def username():
            return 'username'

        @pytest.fixture
        def other_username(username):
            return 'other-' + username

    test_something.py
        # content of tests/test_something.py
        import pytest

        @pytest.mark.parametrize('username', ['directly-overridden-username'])
        def test_username(username):
            assert username == 'directly-overridden-username'

        @pytest.mark.parametrize('username', ['directly-overridden-username-other'])
        def test_username_other(other_username):
            assert other_username == 'other-directly-overridden-username-other'

在上面的示例中，fixture 值被测试参数值覆盖。请注意，即使测试不直接使用 fixture 的值（在函数原型中没有提及它），也可以通过这种方式覆盖 fixture 的值。

用非参数化的 fixture 覆盖参数化的 fixture，反之亦然

假设测试文件结构是

tests/
    conftest.py
        # content of tests/conftest.py
        import pytest

        @pytest.fixture(params=['one', 'two', 'three'])
        def parametrized_username(request):
            return request.param

        @pytest.fixture
        def non_parametrized_username(request):
            return 'username'

    test_something.py
        # content of tests/test_something.py
        import pytest

        @pytest.fixture
        def parametrized_username():
            return 'overridden-username'

        @pytest.fixture(params=['one', 'two', 'three'])
        def non_parametrized_username(request):
            return request.param

        def test_username(parametrized_username):
            assert parametrized_username == 'overridden-username'

        def test_parametrized_username(non_parametrized_username):
            assert non_parametrized_username in ['one', 'two', 'three']

    test_something_else.py
        # content of tests/test_something_else.py
        def test_username(parametrized_username):
            assert parametrized_username in ['one', 'two', 'three']

        def test_username(non_parametrized_username):
            assert non_parametrized_username == 'username'

在上面的示例中，参数化的 fixture 被非参数化的版本覆盖，而非参数化的 fixture 被特定测试模块的参数化版本覆盖。这同样适用于测试文件夹级别。

使用来自其他项目的 fixture

通常，提供 pytest 支持的项目将使用 入口点，因此只需将这些项目安装到环境中即可使这些 fixture 可用。

如果您想使用来自不使用入口点的项目的 fixture，您可以在顶层 conftest.py 文件中定义 pytest_plugins 以将该模块注册为插件。

假设您在 mylibrary.fixtures 中有一些 fixture，并且您想在您的 app/tests 目录中重用它们。

您需要做的就是在 app/tests/conftest.py 中定义指向该模块的 pytest_plugins。

pytest_plugins = "mylibrary.fixtures"

这有效地将 mylibrary.fixtures 注册为插件，使其所有 fixture 和钩子都可用于 app/tests 中的测试。

注意

有时用户会从其他项目中 导入 fixture 以供使用，但是不建议这样做：将 fixture 导入模块将在 pytest 中将其注册为在该模块中 定义 的。

这会产生一些小的后果，例如在 pytest --help 中多次出现，但是 不建议 这样做，因为此行为可能会在以后的版本中更改/停止工作。