Python Click 如何为多个子命令复用定义通用公共选项

你遇到的TypeError本质是Click的默认参数传递规则导致的：

• 定义在@click.group()装饰的回调上的选项，默认只会把解析到的参数值传给group本身的回调函数，不会自动透传给挂在组下的子命令
• 你当前的cli回调没有声明verbose、path两个形参，自然会抛出不认识verbose关键字的错误
• 之前尝试加@click.pass_context没生效，是因为没有通过上下文建立组和子命令之间的参数共享通道，只是拿到了上下文对象，实际通用参数的值根本没被接住、没被存储透传。

核心是依托Click内置的上下文obj共享机制完成参数透传，全程只需要在group层定义一次通用选项，不用在每个子命令里重复写选项逻辑，改造后的完整可运行代码如下：

import click


@click.group()
@click.option(
    "-v",
    "--verbose",
    count=True,
    default=0,
    help="-v for DEBUG",
)
@click.option(
    "--path",
    help="Main Path."
)
@click.pass_context  # 让group回调拿到上下文对象
def cli(ctx, verbose, path):
    # 初始化上下文共享存储字典
    ctx.ensure_object(dict)
    # 把通用参数值存在共享存储里，供所有子命令读取
    ctx.obj["verbose"] = verbose
    ctx.obj["path"] = path


@click.command("list")
@click.option(
    "--list-option",
    help="Special option for list command.",
)
@click.pass_context  # 子命令也绑定上下文，读取共享的通用参数
def my_list_command(ctx, list_option):
    # 从共享存储里取之前存的通用参数
    verbose = ctx.obj["verbose"]
    path = ctx.obj["path"]
    print(verbose, path, list_option)

@click.command("find")
@click.option(
    "--find-option",
    help="Special option for find command.",
)
@click.pass_context
def my_find_command(ctx, find_option):
    verbose = ctx.obj["verbose"]
    path = ctx.obj["path"]
    print(verbose, path, find_option)

cli.add_command(my_list_command)
cli.add_command(my_find_command)

if __name__ == '__main__':
    cli()

• 通用选项的逻辑只需要在group层级写一次，所有挂载在这个group下的子命令，都会自动支持命令行传入-v/--verbose、--path参数，完全不需要在子命令里重复写对应的@click.option定义
• 命令行调用方式完全符合预期，比如执行以下命令都能正常被解析：
  • python script.py -vv --path /your/path list --list-option test
  • python script.py list --list-option test -vv --path /your/path
• 所有通用参数值都是通过ctx.obj这个Click官方推荐的父子命令共享通道传递的，没有自定义的额外逻辑，完全符合Click的开发规范

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