Click CliRunner多CLI测试状态被覆盖，求可行解决方案

我用click库开发CLI命令项目，测试阶段写了如下pytest fixture：

@pytest.fixture(scope="module", name="runner")
def fixture_cli_runner():
    """Fixture for CLIRunner."""
    return CliRunner()

单CLI场景下该fixture运行正常，但新增第二个CLI后，测试开始持续失败。当前项目目录结构：

command_one:
- command_one.py
command_two:
- command_two.py

每个CLI结构类似（以command_two.py为例）：

@click.group()
def main():
    """Command two CLI."""
    configure_log()


@main.command
def do_thing():
    """Do a thing."""
    pass

比如test_command_two.py中的测试：

def test_main(cli_runner):
    """Test the main function."""
    result = cli_runner.invoke(command_two.main)
    assert result.exit_code == 0
    print(result.output)
    assert (
        result.output
        == """Usage: main [OPTIONS] COMMAND [ARGS]...

  Command two CLI.

Options:
  --help  Show this message and exit.

Commands:
  do-thing  Do a thing.
"""
    )

该测试失败，输出的是command_one.py的帮助信息。问题根源是测试并行执行时，CliRunner无法为每个CLI维持独立状态。

1. 重构CLI代码，避免全局状态污染 #

Click的@group和@command装饰器会直接修改全局命令对象，模块导入时的状态会被并行测试互相覆盖。可以改用工厂函数延迟创建CLI实例：

修改command_two.py：

def create_main():
    @click.group()
    def main():
        """Command two CLI."""
        configure_log()

    @main.command
    def do_thing():
        """Do a thing."""
        pass
    return main

测试时调用工厂函数生成独立实例：

def test_main(cli_runner):
    result = cli_runner.invoke(command_two.create_main())
    # 后续断言逻辑保持不变

2. 让不同CLI的测试串行执行 #

如果不想修改CLI代码，可以通过pytest控制测试执行顺序：

• 方法一：使用pytest-order插件（需先安装），给测试标记执行顺序：
  在test_command_one.py中：

  @pytest.mark.order(1)
  def test_command_one_main(cli_runner):
      # 测试逻辑
  

  在test_command_two.py中：

  @pytest.mark.order(2)
  def test_command_two_main(cli_runner):
      # 测试逻辑
  

  运行测试时添加--order参数即可按标记顺序执行。

• 方法二：直接通过命令行分批次运行测试：

  pytest test_command_one/ -xvs && pytest test_command_two/ -xvs
  

  先完成第一个CLI的所有测试，再执行第二个，从根本上避免并行状态冲突。

3. 缩小Fixture作用域 #

将原来的module级fixture改为function级，确保每个测试都拿到全新的CliRunner实例：

@pytest.fixture(scope="function", name="runner")
def fixture_cli_runner():
    """Fixture for CLIRunner."""
    return CliRunner()

注意：此方法仅能隔离CliRunner实例，无法解决模块导入时的全局命令对象污染问题，仅作为辅助方案配合前两种方法使用。

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