本文旨在解决 Pytest 中使用参数化 fixture 时，fixture 未返回预期对象，而是返回参数元组的问题。通过分析问题原因，并提供清晰的解决方案，帮助读者正确使用参数化 fixture，从而实现更灵活的测试。
在使用 Pytest 进行测试时，参数化 fixture 是一种强大的工具，可以方便地对同一测试用例使用不同的参数进行多次测试。然而，如果配置不当，可能会遇到 fixture 没有返回预期对象，而是返回参数元组的情况。本文将深入探讨这个问题的原因，并提供详细的解决方案。
问题分析
当使用 @pytest.mark.parametrize 装饰器进行参数化时，如果同时使用了 fixture，Pytest 会将参数传递给测试函数。但如果 fixture 的名称与 @pytest.mark.parametrize 中指定的参数名称相同，并且没有正确配置，Pytest 可能会错误地将参数元组直接传递给测试函数，而不是执行 fixture 并返回其结果。
解决方案：使用 indirect=True
解决此问题的关键在于使用 @pytest.mark.parametrize 装饰器的 indirect=True 参数。indirect=True 告诉 Pytest 将参数值重定向到同名的 fixture，从而确保 fixture 被执行，并将结果传递给测试函数。
示例代码
假设我们有一个 browser_fixture fixture，用于创建不同类型的浏览器实例，并希望使用参数化测试来测试不同的浏览器。
首先，定义 browser_fixture：
from selenium import webdriver
from selenium.webdriver.chrome.options import Options as ChromeOptions
from selenium.webdriver.firefox.options import Options as FirefoxOptions
import pytest
def create_browser(browser_name, headless=True):
if browser_name == "chrome":
options = ChromeOptions()
if headless:
options.add_argument("--no-sandbox")
options.add_argument("--headless")
options.add_argument("--disable-dev-shm-usage")
options.add_argument("--disable-gui")
return webdriver.Chrome(options=options)
elif browser_name == "firefox":
options = FirefoxOptions()
if headless:
options.add_argument("--headless")
options.add_argument("--disable-gui")
return webdriver.Firefox(options=options)
else:
raise ValueError(f"Unsupported browser: {browser_name}")
@pytest.fixture(scope="class")
def browser_fixture(request):
browser_name, headless = request.param
browser = create_browser(browser_name, headless=headless)
yield browser
browser.quit()然后，在测试类中使用 @pytest.mark.parametrize 并设置 indirect=True：
import pytest
from django.contrib import management
from django.contrib.auth.models import User
@pytest.mark.parametrize("browser_fixture", [("chrome", False)], indirect=True)
@pytest.mark.slow()
class TestEndToEnd:
@pytest.fixture(autouse=True)
def setup(self, browser_fixture, live_server):
management.call_command("create_project_data", verbosity=0)
self.browser = browser_fixture
# At this point I would expect the browser to open
# but instead self.browser is just the tuple: `('chrome', False)`
self.live_server_url = live_server.url
def login_user(
self, username=None, password="test", user=None, browser=None
):
if browser is None:
raise Exception("No browser provided")
# The logic to login here
def test_as_admin(self):
standard_user = User.objects.first()
self.login_user(standard_user.username)
self.browser.get(self.live_server_url + "/mills/")
assert "Mills" in self.browser.title通过添加 indirect=True，Pytest 会将 "chrome" 和 False 传递给 browser_fixture fixture，fixture 会创建相应的浏览器实例，并将该实例传递给测试函数。
其他建议
- Fixture 命名: 通常情况下，fixture 的命名不应包含 "fixture" 后缀。例如，可以将 browser_fixture 重命名为 browser 或 driver，这样可以使代码更简洁易懂。
- 混合直接和间接参数化: indirect 参数也可以接受一个列表，用于指定哪些参数需要进行间接参数化。例如，indirect=["browser_fixture"] 与 indirect=True 的效果相同。当需要混合直接和间接参数化时，这种形式非常有用。
总结
当使用 Pytest 参数化 fixture 时，确保使用 indirect=True 参数，以确保 fixture 被正确执行，并将结果传递给测试函数。同时，注意 fixture 的命名，避免使用 "fixture" 后缀，以提高代码的可读性。通过理解并应用这些技巧，可以更有效地利用 Pytest 的参数化 fixture 功能，编写更灵活、更强大的测试用例。
