10

我正在尝试使用 Click 完成 CLI 解析不太标准的事情，它只能部分工作：

  • 主 CLI 有多个子命令（在“show”和“check”下面的示例中）
  • 这两个命令都可能有可选参数，但参数在它们之前而不是在它们之后
  • 我决定在“上方”组中处理该参数并在上下文中传递值

样本：

import click

@click.group()
@click.argument('hostname', required=False)
@click.pass_context
def cli(ctx, hostname=None):
    """"""
    ctx.obj = hostname
    click.echo("cli: hostname={}".format(hostname))

@cli.command()
@click.pass_obj
def check(hostname):
    click.echo("check: hostname={}".format(hostname))

@cli.command()
@click.pass_obj
def show(hostname):
    click.echo("check: hostname={}".format(hostname))

if __name__ == '__main__':
    cli()

带有主机名的部分有效：

> pipenv run python cli.py  localhost check
cli: hostname=localhost
check: hostname=localhost
> pipenv run python cli.py  localhost show
cli: hostname=localhost
check: hostname=localhost

但是没有主机名的部分不会：

> pipenv run python cli.py show
Usage: cli.py [OPTIONS] [HOSTNAME] COMMAND [ARGS]...

Error: Missing command.

有人知道我应该开始研究的方向吗？

4

1 回答 1

17

这可以通过覆盖click.Group参数解析器来完成，例如：

自定义类：

class MyGroup(click.Group):
    def parse_args(self, ctx, args):
        if args[0] in self.commands:
            if len(args) == 1 or args[1] not in self.commands:
                args.insert(0, '')
        super(MyGroup, self).parse_args(ctx, args)

使用自定义类：

然后使用自定义组，将其作为cls参数传递给group装饰器，如：

@click.group(cls=MyGroup)
@click.argument('hostname', required=False)
@click.pass_context
def cli(ctx, hostname=None):
    ....

如何？

这是有效的，因为click它是一个设计良好的 OO 框架。@click.group()装饰器通常实例化一个对象click.Group，但允许使用cls参数覆盖此行为。因此，从click.Group我们自己的类中继承并覆盖所需的方法是一件相对容易的事情。

在这种情况下，我们覆盖click.Group.parse_args()并且如果第一个参数匹配命令而第二个参数不匹配，那么我们插入一个空字符串作为第一个参数。这会将所有内容放回解析器期望的位置。

于 2017-05-18T19:45:43.013 回答