Python3+Click框架跨命令调用时CLI参数异常拆分问题

被@click.command()装饰后的函数不再是你定义的原始普通Python函数，而是一个Click封装的Command实例。当你直接调用这个实例时，它默认会把传入的第一个位置参数当作命令行参数序列处理，会对该参数做迭代拆分解析：

• 你传入字符串"123"时，它会把字符串迭代拆为['1','2','3']三个参数，和inner声明的1个位置参数不匹配，因此抛出「存在额外参数2、3」的错误
• 你传入单字符"1"时，迭代后只有1个参数，刚好匹配，所以可以正常执行
• 你注释掉@click.command()相关代码后，inner恢复为普通函数，传入的参数会直接赋值给形参，因此不会出现拆分问题

根据你的需求可以选择以下三种实现方式：

方案1：抽离公共业务逻辑（最推荐） #

如果inner既需要作为独立命令被命令行调用，又需要在代码内部被其他逻辑调用，直接把业务逻辑抽为普通函数，命令层只做参数接收：

import click

@click.group()
def cli():
    pass

# 抽离inner的核心逻辑为普通函数
def inner_logic(id):
    print('inner id',id,type(id))

@click.command()
@click.argument('id')
def outer(id):
    print('outer id',id,type(id))
    # 直接调用普通函数传递参数
    inner_logic(id)

@click.command()
@click.argument('id')
def inner(id):
    # 命令层只做参数透传给核心逻辑
    inner_logic(id)

cli.add_command(outer)
cli.add_command(inner)

if __name__ == '__main__':
    cli()

方案2：按Command实例的要求传参 #

如果不需要修改现有结构，直接把参数包裹为列表传入即可，避免字符串被迭代拆分：

def outer(id):
    print('outer id',id,type(id))
    # 将参数放入列表，作为命令行参数序列传递
    inner([id])

方案3：使用Click原生的上下文调用（符合框架规范） #

通过Click的上下文invoke方法调用其他命令，参数会按形参自动匹配：

@click.command()
@click.argument('id')
@click.pass_context # 注入上下文对象
def outer(ctx, id):
    print('outer id',id,type(id))
    # 用invoke方法调用其他命令，按关键字传参
    ctx.invoke(inner, id=id)

Click的Command实例设计初衷是处理命令行输入的参数序列，直接调用实例时的传参逻辑和普通函数完全不同：普通函数是按形参位置/关键字匹配传参，Command实例是按命令行解析规则处理传入的参数序列。官方不推荐直接跨命令调用被装饰后的函数，优先推荐抽离业务逻辑或者用上下文invoke的方式实现。

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