pytest教程-33-钩子函数-pytest_addoption

领取资料，咨询答疑，请➕wei:  June__Go

上一小节我们初步了解一下pytest的hook钩子函数，本小节我们讲解一下pytest_addoption钩子函数的使用方法。

pytest_addoption 是一个 pytest 钩子函数，它允许你在 pytest 的命令行接口中添加自定义选项。这些选项可以在运行测试时通过命令行传递给 pytest，从而影响测试的行为。以下是如何使用 pytest_addoption 的详细方法和代码示例：

1. 在 conftest.py 中实现 pytest_addoption

首先，你需要在你的项目根目录下创建一个名为 conftest.py 的文件（如果还没有的话）。然后，在该文件中实现 pytest_addoption 钩子函数。这个函数接受一个 parser 参数，你可以使用它来添加自定义选项。

# conftest.py

import pytest

def pytest_addoption(parser):
    # 添加一个名为 '--myoption' 的命令行选项
    # action='store' 表示存储参数的值
    # default='default_value' 表示默认值
    # help='Description of my option' 提供选项的描述
    parser.addoption('--myoption', action='store', default='default_value', help='Description of my option')

2. 使用自定义选项

一旦你定义了自定义选项，就可以在运行 pytest 时通过命令行传递这个选项，并在测试代码中通过 request.config.getoption 方法来获取它的值。

pytest --myoption=new_value

3. 在测试中获取选项值

在测试函数中，你可以使用 pytestconfig fixture 来获取 config 对象，然后通过 config.getoption 方法来获取命令行选项的值。

# test_example.py

def test_example(pytestconfig):
    # 获取 '--myoption' 的值
    my_option_value = pytestconfig.getoption('--myoption')
    assert my_option_value == 'new_value'  # 根据你传递的值进行断言

4. 在 fixture 中获取选项值

你也可以在 fixture 函数中获取选项值，这样你就可以在多个测试中重用这个值。

# conftest.py

@pytest.fixture
def my_option_value(pytestconfig):
    # 获取 '--myoption' 的值
    return pytestconfig.getoption('--myoption')

然后在测试中使用这个 fixture：

# test_example.py

def test_example(my_option_value):
    # 使用 my_option_value
    assert my_option_value == 'new_value'  # 根据你传递的值进行断言

这样，你就可以在 pytest 中自定义命令行选项，并在测试中使用这些选项了。记得在运行测试时提供正确的选项值。

5. pytest_addoption添加多个选项

当使用 pytest_addoption 时，你可以添加多个选项，并为每个选项指定不同的参数。以下是一个更详细的示例，演示如何添加多个选项以及不同类型的参数：

# content of conftest.py

def pytest_addoption(parser):
    parser.addoption("--env", action="store", default="dev",
                     help="Environment to run tests against: dev, staging, or prod")
    parser.addoption("--browser", action="store", default="chrome",
                     help="Browser to use for testing: chrome, firefox, or safari")
    parser.addoption("--headless", action="store_true", default=False,
                     help="Run tests in headless mode (without opening browser window)")
    parser.addoption("--maximized", action="store_true", default=False,
                     help="Maximize the browser window during testing")

# content of test_sample.py

import pytest

@pytest.mark.parametrize("url", ["https://www.google.com", "https://www.example.com"])
def test_page_load(url, pytestconfig):
    browser = pytestconfig.getoption('browser')
    headless = pytestconfig.getoption('headless')
    maximized = pytestconfig.getoption('maximized')
    print(f"Running test on {browser} with URL: {url}")
    print(f"Headless mode: {headless}, Maximized: {maximized}")

def test_environment(pytestconfig):
    env = pytestconfig.getoption('env')
    print("Testing environment:", env)

在这个示例中，我们添加了四个不同的选项：

--env: 用于指定测试运行的环境，可以是 "dev"、"staging" 或 "prod"。

--browser: 用于指定要在测试中使用的浏览器，可以是 "chrome"、"firefox" 或 "safari"。

--headless: 用于控制是否以无头模式运行浏览器（不显示浏览器窗口）。

--maximized: 用于控制是否在测试期间最大化浏览器窗口。

在测试模块中，我们使用 pytestconfig.getoption() 方法来获取每个选项的值，并在测试函数中使用这些值。pytestconfig 是 pytest 的配置对象，可以在测试模块中直接使用。

你可以像这样运行测试，根据需要设置不同的选项：

pytest --env=staging --browser=firefox --headless --maximized

这将运行测试，使用 staging 环境，在 Firefox 浏览器中以无头模式运行，并最大化浏览器窗口。

最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走，希望可以帮助到大家！领取资料，咨询答疑，请➕wei:  June__Go