pytest系列——pytest_addoption钩子函数添加自定义参数到pytest配置对象中+request.config.getoption获取参数值

Pytest 2022-11-23

钩子函数之 pytest_addoption介绍：

① pytest_addoption 钩子函数可以让用户注册一个自定义的命令行参数，以便于用户在测试开始前将数据从外部（如：控制台）传递给程序；【程序根据获取的用户传递的自定义的参数值来做一些事情】

② pytest_addoption 钩子函数一般和内置 fixture pytestconfig 配合使用， pytest_addoption 注册自定义的命令行参数， pytestconfig 通过pytest配置对象读取参数的值；

③ pytest_addoption 钩子函数还可以与内置fixture函数request中 request.config.getoption 结合使用来读取用户注册的自定义命令行参数对应的参数值。如下所有的例子都是通过此方法。

可能的应用场景：

  1. 我们的自动化用例需要支持在不同的测试环境运行，有时候在dev环境运行，有时候在test环境运行，有时候在uat环境运行；
  2. 有时候需要根据获取某个参数不同的参数值，执行不同的业务逻辑；

上面的场景我们都可以通过【在命令行中输入参数，然后用例中接收这个参数，通过判断这个参数的值来做不同的逻辑】来实现。

那么我们的需求就变为pytest中如何自定义一个命令行参数呢？这时候我们就需要用到pytest的钩子函数： pytest_addoption 。

pytest.addoption() 钩子函数的参数说明：

①name：自定义命令行参数的名字，可以是："foo"， "-foo" 或 "--foo"；

②action：在命令行中遇到此参数时要采取的存储该参数对应的参数值的基本操作类型；

③nargs：应该使用的命令行参数的数量；

④const：某些操作和nargs选择所需的常量值；

⑤default：如果参数不在命令行中，则生成的默认值。

⑥type：注册的自定义到pytest配置对象中的命令行参数对应的参数值应该转换为的类型；

⑦choices：参数允许值的容器；

⑧required：命令行选项是否可以省略（仅可选）；

⑨help：对参数作用的简要说明；

⑩metavar：用法消息中参数的名称；

①①dest：要添加到 parse_args() 返回的对象中的属性的名称；

对pytest.addoption()钩子函数的参数解释：

1、组合使用一：

action ： action="store" ：默认只存储参数的值【命令行参数添加到pytest配置对象中的参数的参数值】；可以存储任何数据类型的值；

default ：可以是任何数据类型的值；而且在pytest命令行方式执行测试用例时pytest命令行参数中多次传递该参数也只能生效一个参数值；最后一个值覆盖之前的值；【即当出现命令行参数中添加到pytest配置对象中的参数的参数值多个时，默认最后一个将会被传递到程序内】

【注意】当pytest命令行方式运行测试用例没有传递指定参数对应的参数值时，程序中默认读取默认值。如果命令行参数中包含自定义注册的参数且注册参数存在对应的参数值时，则该参数值会覆盖之前的参数默认值

实例1：当 action="store" 时，pytest命令行方式执行且不传递自定义参数值

image

实例2：当 action="store" 时，在pytest命令行方式执行测试用例时pytest命令行参数中多次传递该参数也只能生效一个参数值：最后一个值覆盖之前的值（首先覆盖默认值，然后后面的覆盖前面的）

image

实例3：当 action="store" 时，pytest命令行方式执行且传递自定义参数值

实现步骤：

①注册一个自定义参数，并为其命名为【--cmdopt】，添加到pytest配置对象。

②定义一个fixture函数，作用是从pytest配置对象中读取自定义参数【--cmdopt】的值。该fixture函数的返回值是 request.config.getoption("--cmdopt") 。（即从pytest配置对象中获取的【--cmdopt】参数值）

③再次定义一个fixture函数，调用②中定义的fixture函数，用来接收②中定义的fixture函数的返回值。

④在测试方法中调用③中定义的fixture函数，获取【--cmdopt】参数值到测试用例中使用。

⑤pytest命令行方式执行测试用例并带上【--cmdopt=输入到程序中的值】获取我们想传入到程序内的值。

conftest.py

import pytest


@pytest.fixture(scope="session")
def login():
    print("输入账号密码")
    yield
    print("清理数据完成")


# 注册自定义参数 cmdopt 添加到配置对象
def pytest_addoption(parser):
    parser.addoption("--cmdopt",
                     action="store",
                     default="默认参数值",
                     help="将命令行参数'--cmdopt'添加到pytest配置对象中")


# 从配置对象中读取自定义参数的值
@pytest.fixture(scope="session")
def cmdopt(request):
    return request.config.getoption("--cmdopt")


# 将自定义参数的值打印出来
@pytest.fixture(autouse=True)
def fix_1(cmdopt):
    print('\n --cmdopt参数的参数值：', cmdopt)

test_a.py

import pytest


@pytest.mark.usefixtures('login')
class TestDemo:
    def test_1(self):
        print('执行测试用例1')
        assert 1 == 1

执行命令：

pytest -s --cmdopt=98k

运行结果：

image

2、组合使用二：

action ： action="append" ：将参数值存储为一个列表，用 append 模式将可以在pytest命令行方式执行测试用例的同时多次向程序内部传递自定义参数对应的参数值；

default ：defalut默认值必须是一个列表类型，pytest会将default 默认参数值和多个自定义参数值放在一个列表中。

实例1：当 action="append" 时，pytest命令行方式执行且不传递自定义参数值

image

实例2：当 action="append" 时，pytest命令行方式执行且传递多个自定义参数值

conftest.py

import pytest


@pytest.fixture(scope="session")
def login():
    print("输入账号密码")
    yield
    print("清理数据完成")


# 注册自定义参数cmdopt到pytest配置对象
def pytest_addoption(parser):
    parser.addoption("--cmdopt",
                     action="append",
                     default=['默认值1', '默认值2', '默认值3'],
                     help="将命令行参数'--cmdopt'添加到pytest配置对象中")


# 从配置对象中读取自定义参数的值
@pytest.fixture(scope="session")
def cmdopt(request):
    return request.config.getoption("--cmdopt")


# 将自定义参数的值打印出来
@pytest.fixture(autouse=True)
def fix_1(cmdopt):
    print('\n --cmdopt参数的参数值：', cmdopt)

执行pytest命令行参数命令：

pytest -s --cmdopt=毛瑟小手枪 --cmdopt=UZI

运行结果：

image

3、组合使用三：

action ： action="store_const" ：为注册的自定义的命令行参数（cmdopt）指定一个常量值；同时使用 const参数（必须传该参数）（必须和 const 参数同时使用），使用该模式命令行注册的自定义参数不能重新赋值；（const单词的英文意思为常量，恒量）

default ：default默认值就是注册的自定义参数（--cmdopt）对应的参数值，且无法改变默认值。【指定 action="store_const" 时，无法通过pytest命令行执行方式为注册的自定义参数指定参数值传递到程序内】

实例1：当 action="store_const" 时，pytest命令行方式执行且传递自定义参数值

image

实例2：当 action="store_const" 时，pytest命令行方式执行且不传递自定义参数值

conftest.py

# -*- encoding:utf-8 -*-

import pytest


@pytest.fixture(scope="session")
def login():
    print("输入账号密码")
    yield
    print("清理数据完成")


# 注册自定义参数 cmdopt 添加到配置对象
def pytest_addoption(parser):
    parser.addoption("--cmdopt",
                     action="store_const",
                     default="const默认参数值",
                     const='这个是为cmdopt命令行参数指定的常量值',
                     help="将命令行参数'--cmdopt'添加到pytest配置对象中")


# 从配置对象中读取自定义参数的值
@pytest.fixture(scope="session")
def cmdopt(request):
    return request.config.getoption("--cmdopt")


# 将自定义参数的值打印出来
@pytest.fixture(autouse=True)
def fix_1(cmdopt):
    print('\n --cmdopt参数的参数值：', cmdopt)

pytest命令行执行方式命令：

pytest -s

运行结果：

image

4、组合使用四：

action ： action="append_const" ：将注册的自定义参数值存储为一个列表类型，同时使用 const 参数为自定义命令行参数指定一个常量值；并将 default 默认值和 const 常量值添加到列表中，这个模式可以同时多次使用自定义参数，但是还是不能赋值，只能使用常量；（无法通过pytest命令行执行使用'参数=参数值、参数=参数值、...'的方式将多个参数值传递到程序内）

default ：default默认值就是注册的自定义参数（--cmdopt）对应的参数值，且无法改变默认值。【deault是一个列表数据类型，列表中可以存储多个常量】

实例1：当 action="append_const" 时，pytest命令行方式执行且传递自定义参数的参数值

image

实例2：当 action="append_const" 时，pytest命令行方式执行且不传递自定义参数的参数值

conftest.py

# -*- encoding:utf-8 -*-

import pytest


@pytest.fixture(scope="session")
def login():
    print("输入账号密码")
    yield
    print("清理数据完成")


# 注册自定义参数 cmdopt 添加到配置对象
def pytest_addoption(parser):
    parser.addoption("--cmdopt",
                     action="append_const",
                     default=["const默认参数值1", "const默认参数值2", "const默认参数值3"],
                     const='这个是为cmdopt命令行参数指定的常量值',
                     help="将命令行参数'--cmdopt'添加到pytest配置对象中")


# 从配置对象中读取自定义参数的值
@pytest.fixture(scope="session")
def cmdopt(request):
    return request.config.getoption("--cmdopt")


# 将自定义参数的值打印出来
@pytest.fixture(autouse=True)
def fix_1(cmdopt):
    print('\n --cmdopt参数的参数值：', cmdopt)

pytest命令行执行命令：

pytest -s

运行结果：

image

5、钩子函数pytest_addoption()的参数type：

① type ：注册的自定义到pytest配置对象中的命令行参数对应的参数值应该转换的数据类型；

② 该参数对应的参数值的数据类型默认为python基础类型，比如：int，str，float，list 等类型；

③但是如果不指定该参数对应参数值的数据类型的话，pytest会把接收到的参数值都默认为str类型，所以我们有时需要指定参数值的数据类型保证接收到的参数值是我们想要得到的数据类型。

【注意】：在使用 type 参数指定该参数对应的参数值数据类型时，也需要把 default 参数中的默认参数值的数据类型修改为与注册的自定义到pytest配置对象中的命令行参数对应的参数值同样的类型！

实例：

conftest.py

# -*- encoding:utf-8 -*-

import pytest


@pytest.fixture(scope="session")
def login():
    print("输入账号密码")
    yield
    print("清理数据完成")


# 注册自定义参数 cmdopt 添加到配置对象
def pytest_addoption(parser):
    parser.addoption("--cmdopt",
                     action="store",
                     default=100,
                     type=int,
                     help="将命令行参数'--cmdopt'添加到pytest配置对象中")


# 从配置对象中读取自定义参数的值
@pytest.fixture(scope="session")
def cmdopt(request):
    return request.config.getoption("--cmdopt")


# 将自定义参数的值打印出来
@pytest.fixture(autouse=True)
def fix_1(cmdopt):
    print('\n --cmdopt参数的参数值：', cmdopt)
    print('\n --cmdopt参数的参数值的数据类型：', type(cmdopt))

pytest命令行方式执行命令：

pytest -s --cmdopt=999

运行结果：

image

6、钩子函数pytest_addoption的参数choices

choices 参数可以为该参数值指定几个值，在pytest命令行方式执行测试用例的时候传递到程序内的注册的自定义到pytest配置对象中的命令行参数对应的参数值必须在这几个值中选择一个，否则会报错。

实例1：自定义参数对应的参数值为一个不存在于钩子函数choices参数中的值

image

实例2：自定义参数对应的参数值为一个存在于钩子函数choices参数中的值

conftest.py

# -*- encoding:utf-8 -*-

import pytest


@pytest.fixture(scope="session")
def login():
    print("输入账号密码")
    yield
    print("清理数据完成")


# 注册自定义参数 cmdopt 添加到配置对象
def pytest_addoption(parser):
    parser.addoption("--cmdopt",
                     action="store",
                     default='默认测试环境',
                     type=str,
                     choices=['dev', 'test', 'uat'],
                     help="将命令行参数'--cmdopt'添加到pytest配置对象中")


# 从配置对象中读取自定义参数的值
@pytest.fixture(scope="session")
def cmdopt(request):
    return request.config.getoption("--cmdopt")


# 将自定义参数的值打印出来
@pytest.fixture(autouse=True)
def fix_1(cmdopt):
    print('\n --cmdopt参数的参数值：', cmdopt)
    print('\n --cmdopt参数的参数值的数据类型：', type(cmdopt))

pytest命令行方式执行命令：

pytest -s --cmdopt=uat

运行结果：

image

实战实例

①新建conftest.py文件，通过 pytest_addoption 钩子函数注册自定义参数添加到pytest配置对象中，并通过定义的fixture来获得参数的参数值。

# file_name: conftest.py

import pytest


def pytest_addoption(parser):
    parser.addoption(
        "--cmdopt", action="store", default="type1", help="my option: type1 or type2"
    )
    parser.addoption(
        "--env", action="store", default="dev", choices=["uat", "dev", "test"], help="env：表示测试环境，默认dev环境"
    )


# 从pytest配置对象中读取自定义参数的值（一）
@pytest.fixture()
def cmdopt(pytestconfig):
    return pytestconfig.getoption("cmdopt")


# 从pytest配置对象中读取自定义参数的值（二）
@pytest.fixture()
def env(request):
    return request.config.getoption("--env")

解释：上面conftest.py文件中自定义了两个命令行参数： --cmdopt 和 --env ；

　　　然后定义了两个fixture函数，在测试用例中想要获得参数 --cmdopt 的参数值，就可以调用 cmdopt 函数；调用 env 函数可以获取参数 --env 的参数值。

②编写测试用例。

# file_name: test_option.py

import pytest


def test_option(env):
    if env == 'dev':
        print("当前测试环境为：{}，域名切换为开发环境".format(env))
    elif env == 'test':
        print("当前测试环境为：{}，域名切换为测试环境".format(env))
    else:
        print("环境错误，当前环境{}不存在".format(env))


if __name__ == '__main__':
    pytest.main(['-s', 'test_option.py'])

③不带参数运行：

image

④带参数运行：

image

相关文章

Pytest框架 — 13、Pytest的标记(四)分组执行
目录1、前言2、mark的使用（一）注册自定义标记（二）在测试...
Pytest系列(2-1)-用例状态
用例执行状态用例执行完成后，每条用例都有自己的状态，常见...
Pytest系列(2-3)-conftest详解
什么是conftest.py可以理解成一个专门存放fixture的配置文件...
pytest系列——pytest_collection_modifyitems钩子函数修改测试用例执行顺序
前言pytest默认执行用例是根据项目下的文件名称按ascii码去收...
pytest系列——pytest_collection_modifyitems钩子函数修复参数化使用ids当测试用例描述有中文时控制台及报告中用例标题输出为Unicode编码问题
当我们对测试用例进行参数化时，使用@pytest.mark.parametri...
【pytest】元数据使用(pytest-metadata)
前言：什么是元数据？元数据是关于数据的描述，存储着关于数...