pytest自定义命令行选项配置、使用及config引用相关问题咨询

同一选项同时配置长、短名称的实现方式 #

完全支持给同一个选项配置多个触发别名，底层依赖的argparse解析逻辑本身支持一次传入多个参数名的写法，但需要避开一个非常容易踩的解析坑：

• 单横杠前缀的短选项，规范要求必须是单个字符，类似-srv这种多字符挂单横杠的写法，会被argparse自动拆分为-s、-r、-v三个独立短选项解析，根本不会把-srv识别为一个完整的选项名，完全达不到预期效果。想要多字符的短别名，要么就老老实实写双横杠的--srv，要么就用单字符的短选项。
• 写短选项的时候要注意避开pytest已占用的内置选项（比如pytest本身就使用-s作为关闭输出捕获的内置选项，重复定义会直接触发解析冲突）。

合规的写法示例：

def pytest_addoption(parser):
    # 同时支持 --server 长选项 和 -S 短选项
    parser.addoption(
        "--server",
        "-S",
        action="store",
        default="127.0.0.1",
        help="测试服务的访问地址"
    )

你提到的手动设置dest = 'SERVER'的写法语法上是合法的，设置后选项对应的属性名会被强制改为你指定的SERVER，后续访问的时候需要用config.option.SERVER取值，但pytest社区的通用规范是不手动修改默认dest——默认dest会自动取第一个长选项去掉双横杠后的小写形式（比如--server对应的默认dest就是server），全大写的自定义dest容易和模块常量混淆，不推荐使用。

命令行选项的访问方式及PyCharm引用报错的解决 #

你当前的代码有两个核心问题，也是导致访问失败、IDE报引用无法解析的根源：

• 注册自定义选项的方式不对。pytest只会自动识别名为pytest_addoption的钩子函数来加载自定义命令行参数，你当前写的普通函数environment_options(parser)不会被pytest调度执行，相当于根本没有把--server选项注册到解析器里。
• config不是可直接导入的全局变量。config是pytest提供的内置fixture，存储了当前测试运行的所有配置信息，必须通过函数传参的方式注入到你的fixture、测试用例里才能访问，不能直接在函数内部无参数直接引用。

正确的实现流程非常简单：

1. 在项目的conftest.py文件里实现pytest_addoption钩子，完成自定义选项的注册
2. 在需要读取选项值的fixture里，把config作为入参传入，通过config.option.对应选项名取值

完整的可运行示例：

# conftest.py
def pytest_addoption(parser):
    parser.addoption(
        "--server",
        action="store",
        default="",
        help="目标测试服务地址"
    )

@pytest.fixture()
def environment_set_up(config):  # 传入内置的config fixture
    target_server = config.option.server  # 按照注册的选项名取值
    if target_server == "some value":
        # 对应分支的测试初始化操作
        pass

关于PyCharm的报错：

• 报错的直接原因是你没有把config作为fixture参数传入，直接把它当成已定义的全局变量使用，IDE自然无法识别未声明的变量
• pytest的内置fixture不需要手动import，只要按照fixture的传参规则正确注入，IDE在安装pytest官方插件后会自动识别config的类型，后续不会再弹出引用无法解析的提示
• 注意不要尝试手动从pytest模块导入config，它是pytest运行时动态初始化的实例，不是模块级的公开对象，强行导入会直接触发报错。

内容的提问来源于stack exchange，提问作者Akop Akopov