如何添加无短横线的pytest选项？IPython pytest魔法命令配置求助

首先得掰扯清楚一个关键：pytest里不带短横线的根本不是“选项”，而是属于位置参数（比如你平时指定测试文件、目录，或者用-m指定标记前的表达式都算这类）。如果你硬想用parser.addoption去加这类无短横线的“选项”，肯定会报错——因为这个API就是用来定义带--/-前缀的正式选项的。

要实现类似需求，有两种靠谱的方式：

• 方式一：手动解析命令行参数，把自定义参数“摘出来”
  你可以在项目根目录的conftest.py里，通过sys.argv抓取所有命令行参数，把那些不带短横线的自定义参数筛选出来，再把它们从sys.argv里移除（避免pytest把它们当成不存在的测试文件/目录报错），最后存到pytest的配置对象里供后续使用：

  # conftest.py
  import sys
  import pytest
  
  def pytest_addoption(parser):
      # 先正常定义你需要的带短横线的选项
      parser.addoption("--donttesti18n", action="store_true", help="跳过国际化相关测试")
      parser.addoption("--runstresstests", action="store_true", help="运行压力测试用例")
      # 其他选项同理添加
  
  def pytest_configure(config):
      # 收集所有不带短横线的自定义参数
      custom_targets = []
      new_argv = [sys.argv[0]]  # 保留命令本身（比如pytest或者%pytest）
      
      for arg in sys.argv[1:]:
          if not arg.startswith("-"):
              custom_targets.append(arg)
          else:
              new_argv.append(arg)
      
      # 更新命令行参数，防止pytest误判这些自定义参数为测试文件
      sys.argv = new_argv
      # 把自定义参数存到config里，后面的钩子函数或测试用例都能拿到
      config.custom_targets = custom_targets
  

  之后你可以用pytest_collection_modifyitems钩子，根据这些自定义参数过滤测试用例——比如假设你给对应子系统的测试打了标记，就可以只保留匹配标记的用例：

  def pytest_collection_modifyitems(config, items):
      if not config.custom_targets:
          return  # 没有指定目标就不做过滤
      
      # 遍历所有测试用例，只保留带有目标标记的
      for item in items[:]:
          has_matching_mark = any(mark.name in config.custom_targets for mark in item.iter_markers())
          if not has_matching_mark:
              items.remove(item)
  

• 方式二：用pytest原生标记替代（更推荐）
  其实pytest本身就支持用-m选项指定测试标记，完全能替代你要的自定义无短横线参数。比如先给测试用例打标记：

  @pytest.mark.potato_peeler
  def test_peeler_core():
      # 土豆削皮器核心逻辑测试
      pass
  

  然后直接运行：

  pytest -m potato_peeler --donttesti18n
  

  这种方式更贴合pytest的原生设计，不需要额外写太多自定义逻辑。

你遇到的parser.addoption报错，本质就是踩了刚才说的规则：这个API只能定义带--/-的选项，无短横线的字符串不符合要求。按照上面的方式一，就能完美解决你的场景——既不会报错，又能实现你想要的命令格式。

给你一个针对你的需求写的完整示例：

第一步：给测试用例打对应标记 #

比如土豆削皮器的测试：

# tests/test_potato.py
import pytest

@pytest.mark.potato_peeler
def test_peeler_functionality():
    # 测试削皮功能
    assert True

@pytest.mark.potato_peeler
@pytest.mark.stress
def test_peeler_long_running():
    # 削皮器压力测试
    assert True

大蒜压榨器的测试：

# tests/test_garlic.py
import pytest

@pytest.mark.garlic_squeezer
def test_squeezer_functionality():
    # 测试压榨功能
    assert True

@pytest.mark.garlic_squeezer
@pytest.mark.smell
def test_squeezer_smell():
    # 测试气味相关逻辑
    assert True

第二步：在conftest.py里处理参数和过滤测试 #

import sys
import pytest

def pytest_addoption(parser):
    # 定义你需要的所有带短横线选项
    parser.addoption("--donttesti18n", action="store_true", help="跳过国际化测试")
    parser.addoption("--runstresstests", action="store_true", help="运行压力测试")
    parser.addoption("--donttestsmell", action="store_true", help="跳过气味相关测试")
    parser.addoption("--logperfdata", action="store_true", help="记录性能数据")

def pytest_configure(config):
    # 提取无短横线的自定义目标参数
    config.custom_targets = []
    filtered_argv = [sys.argv[0]]
    
    for arg in sys.argv[1:]:
        if not arg.startswith("-"):
            config.custom_targets.append(arg)
        else:
            filtered_argv.append(arg)
    
    # 更新命令行参数，避免pytest误判
    sys.argv = filtered_argv

def pytest_collection_modifyitems(config, items):
    # 第一步：根据自定义目标过滤测试用例
    if config.custom_targets:
        kept_items = []
        for item in items:
            item_mark_names = {mark.name for mark in item.iter_markers()}
            if any(target in item_mark_names for target in config.custom_targets):
                kept_items.append(item)
        items[:] = kept_items
    
    # 第二步：处理带短横线的选项
    if config.getoption("--donttesti18n"):
        # 移除带i18n标记的测试
        items[:] = [item for item in items if "i18n" not in {mark.name for mark in item.iter_markers()}]
    
    if config.getoption("--runstresstests"):
        # 只保留带stress标记的测试
        items[:] = [item for item in items if "stress" in {mark.name for mark in item.iter_markers()}]
    
    if config.getoption("--donttestsmell"):
        # 移除带smell标记的测试
        items[:] = [item for item in items if "smell" not in {mark.name for mark in item.iter_markers()}]
    
    # 处理--logperfdata的逻辑，比如在这里初始化性能日志器
    if config.getoption("--logperfdata"):
        print("开启性能数据记录...")
        # 这里可以添加你的日志逻辑

第三步：运行测试（包括IPython魔法命令） #

现在你就可以像预期那样运行命令了：

# 普通命令行
pytest potato_peeler --donttesti18n --runstresstests

# IPython里用魔法命令
%pytest garlic_squeezer --donttestsmell --logperfdata

完全符合你的需求，而且不会再报错啦！

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