Python Click 如何通过配置文件传递全局选项、子命令及子命令参数

你之前修改ctx.args无效的根本原因是：eager回调的执行时机在Click完整解析命令行参数之前，后续流程会用原始输入的未解析参数覆盖ctx.args。我们可以把注入子命令参数的逻辑后移到Group回调执行阶段，此时全局选项已经解析完成，剩余待解析的子命令参数就存储在ctx.args中，此时修改不会被覆盖，Click后续会直接用修改后的ctx.args解析子命令。

完整修改后的代码如下：

# commandline.py
import click
import json


def read_config(ctx, param, value):
    if value is None:
        return

    with open(value) as fh:
        config = json.load(fh)

    new_defaults = {}
    if ctx.default_map:
        new_defaults.update(ctx.default_map)
    
    # 提取配置中的子命令及选项，转换为Click可识别的参数列表
    subcmd_args = []
    for cmd_name, cmd_params in list(config.items()):
        # 判断是否为已定义的子命令
        if isinstance(cmd_params, dict) and cmd_name in ctx.command.commands:
            subcmd_args.append(cmd_name)
            # 把子命令选项转换为 --参数名 参数值 的格式
            for opt_name, opt_val in cmd_params.items():
                subcmd_args.append(f"--{opt_name}")
                subcmd_args.append(str(opt_val))
            # 子命令配置不需要进入全局默认值映射
            del config[cmd_name]

    # 处理全局选项默认值
    config = {key: val if isinstance(val, (list, dict)) else str(val) for key, val in config.items()}
    new_defaults.update(config)
    ctx.default_map = new_defaults

    # 把解析好的子命令参数存入ctx，供后续注入
    ctx.config_subcmd_args = subcmd_args

    return value


@click.option(
    "--opt_a",
)
@click.option(
    "--config",
    is_eager=True,
    callback=read_config,
)
@click.group(
    chain=True,
    no_args_is_help=True,
    invoke_without_command=True,
)
@click.pass_context
def cli(ctx, opt_a, config):
    # 核心逻辑：命令行未传入子命令时，注入配置文件中的子命令参数
    if not ctx.args and hasattr(ctx, "config_subcmd_args"):
        ctx.args = ctx.config_subcmd_args

    click.echo(f"opt_a was '{opt_a}'")
    click.echo(f"config was '{config}'")


@click.option(
    "--sub_opt_a",
)
@cli.command("sub_cmd_a")
def sub_cmd_a(sub_opt_a):
    click.echo(f"sub_cmd_a called with '{sub_opt_a}'")


@click.option(
    "--sub_opt_b",
)
@cli.command("sub_cmd_b")
def sub_cmd_b(sub_opt_b):
    click.echo(f"sub_cmd_b called with '{sub_opt_b}'")


if __name__ == "__main__":
    cli()

效果验证 #

使用你提供的config_file.json，执行命令：

python commandline.py --config "config_file.json"

输出结果和完全使用命令行参数的输出完全一致：

opt_a was 'Test Opt A'
config was 'config_file.json'
sub_cmd_a called with 'Test SubOpt A'

优先级说明 #

如果命令行同时传入了子命令，会优先使用命令行的子命令及选项，忽略配置文件中的子命令配置，符合参数优先级预期。

内容的提问来源于stack exchange，提问作者ross-g