如何调用click.command时排除指定参数，解决参数不兼容问题

解决方案 #

以下是两种可行的实现方式，优先推荐第一种方案：

方案1：复用Click内置参数解析器处理额外参数（最稳妥）

该方法直接调用目标命令的内置参数解析逻辑处理Context.args中的未识别参数，无需手动拆分原始参数列表，可完美适配任意目标命令的参数规则（支持选项、位置参数、默认值等所有Click参数特性）。

修改后的示例代码如下：

@click.group(name="wrapper-example")
def wrapper_cli():
    pass

@wrapper_cli.command("command")
@click.option("--path", type=str, help="example command arg")
def command(path):
    click.echo(path)


@wrapper_cli.command(
    "run",
    context_settings=dict(
        ignore_unknown_options=True,
        allow_extra_args=True,
    ),
)
@click.option("--period", type=int, help="minutes")
@click.pass_context
def run(ctx: click.Context, period):
    # 此处省略按周期循环调用的业务逻辑
    # 用目标命令的参数解析器解析ctx.args里的额外参数，传copy避免修改原上下文数据
    _, parsed_target_params = command.parse_args(ctx, ctx.args.copy())
    # 调用目标命令
    ctx.invoke(command, **parsed_target_params)

方案2：手动过滤参数后调用

如果场景简单，也可以手动过滤掉不需要传递的period参数，再自行解析Context.args列表组装参数：

@wrapper_cli.command(
    "run",
    context_settings=dict(
        ignore_unknown_options=True,
        allow_extra_args=True,
    ),
)
@click.option("--period", type=int, help="minutes")
@click.pass_context
def run(ctx: click.Context, period):
    # 此处省略按周期循环调用的业务逻辑
    params = {}
    # 手动解析ctx.args中的键值对参数
    for idx in range(0, len(ctx.args), 2):
        opt_key = ctx.args[idx].lstrip("-")
        opt_val = ctx.args[idx + 1]
        params[opt_key] = opt_val
    ctx.invoke(command, **params)

注意：该方案仅适用于参数规则简单的场景，复杂参数（如多值参数、标志位参数、位置参数）还是建议使用方案1的内置解析逻辑。

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