Question

假设我的CLI实用程序有三个命令：cmd1，cmd2，cmd3

我希望cmd3拥有与cmd1和cmd2相同的选项和标记。就像某种继承一样。

@click.command()
@click.options("--verbose")
def cmd1():
    pass

@click.command()
@click.options("--directory")
def cmd2():
    pass

@click.command()
@click.inherit(cmd1, cmd2) # HYPOTHETICAL
def cmd3():
    pass

因此cmd3会有标记--verbose和选项--directory。可以用Click做到这一点吗？也许我只是忽略了文档中的内容......

编辑：我知道我可以使用click.group()执行此操作。但是，必须在组命令之前指定所有组的选项。我想在命令之后通常拥有所有选项。

cli.py --verbose --directory /tmp cmd3 - ＆gt; cli.py cmd3 --verbose --directory /tmp

Answer 1

我找到了简单的解决方案！我从https://github.com/pallets/click/issues/108稍微修改了代码段：

import click


_cmd1_options = [
    click.option('--cmd1-opt')
]

_cmd2_options = [
    click.option('--cmd2-opt')
]


def add_options(options):
    def _add_options(func):
        for option in reversed(options):
            func = option(func)
        return func
    return _add_options


@click.group()
def group(**kwargs):
    pass


@group.command()
@add_options(_cmd1_options)
def cmd1(**kwargs):
    print(kwargs)


@group.command()
@add_options(_cmd2_options)
def cmd2(**kwargs):
    print(kwargs)


@group.command()
@add_options(_cmd1_options)
@add_options(_cmd2_options)
@click.option("--cmd3-opt")
def cmd3(**kwargs):
    print(kwargs)


if __name__ == '__main__':
    group()

Answer 2

此代码从其参数中提取所有选项

def extract_params(*args):
    from click import Command
    if len(args) == 0:
        return ['']
    if any([ not isinstance(a, Command) for a in args ]):
        raise TypeError('Handles only Command instances')

    params = [ p.opts() for cmd_inst in args for p in cmd_inst.params ]
    return list(set(params))

现在你可以使用它了：

@click.command()
@click.option(extract_params(cmd1, cmd2))
def cmd3():
    pass

此代码仅提取参数而不提取其默认值，您可以根据需要进行改进。

Answer 3

用通用参数定义一个类

class StdCommand(click.core.Command):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.params.insert(0, click.core.Option(('--default-option',), help='Every command should have one'))

然后在定义命令功能时将类传递给装饰器

@click.command(cls=StdCommand)
@click.option('--other')
def main(default_option, other):
  ...

Python / Click - 命令之间的共享选项和标志

3 个答案: