pytest 命令行注册函数之 pytest_addoption
简介
pytest_addoption 允许用户自定义注册一个命令行参数,方便用户通过命令行参数的形式给 pytest 传递不同的参数进行不同测试场景的切换。
通常与内置 fixture 之 pytestconfig 配合使用。即 pytest_addoption 负责注册命令行参数,pytestconfig 负责读取命令行参数传入的值。
参数说明
pytest_addoption 注册函数中 parser.addoption(*args, **kwargs) 的参数:
name: 自定义命令行参数的名字,可以是:'foo', '-foo', '--foo'
action:在命令行中遇到此参数时要采取的基本操作类型
nargs: 应该使用的命令行参数的数量
const: 某些操作和 nargs 选择所需的常量值
default:默认参数值。如果不在命令行中给当前注册的命令传递参数,则使用默认值
type: 命令行参数应该接收的参数类型
choices:参数允许值的容器
required:命令行选项是否可以省略(仅可选)
help: 对当前命令参数的简要说明
metavar:用法消息中参数的名称
dest: 要添加到 parse_args() 返回的对象中的属性的名称
参数举例演示
action=‘store’
action=‘store’:默认,只存储参数的值,可以存储任何类型的值,此时的 default 也可以是任何类型的值。并且命令行参数即使重复多次也只会生效一个,最后一个覆盖之前传入的值
''' conftest.py '''
import pytest
def pytest_addoption(parser):
parser.addoption(name='--env',
action='store',
default='test_env',
help='test_env:表示测试环境,默认值为 test_env')
@pytest.fixture
def env(pytestconfig):
env = pytestconfig.getoption('--env')
return env
''' test_01.py '''
def test_env(env):
print('当前测试环境为:{}'.format(env))
''' main.py '''
if __name__ == '__main__':
pytest.main('-vs')
========== output ========
.当前测试环境为:test env
或
if __name__ == '__main__':
pytest.main(['--env=http://www.baidu.com'])
========== output ========
.当前测试环境 env: http://www.baidu.com
action=‘append’
action=‘append’:存储的是一个 list 列表值,与此同时,default 也要求传入一个列表值。用例运行时,pytest 会将 default 中的默认参数与传入的自定义参数放在一个列表中
''' conftest.py '''
import pytest
def pytest_addoption(parser):
parser.addoption(name='--input_args',
action='append',
default=[1, 2, 3],
help='input_args:表示测试数据