在多个顶级命令之间共享一个子命令

Question

我有一个包含多个顶级入口点的 Python 项目，我们称它们为 foo 和 bar。两个入口点使用相同的代码库，我希望使用实现 version() 命令的完全相同的代码来实现 foo version 和 bar version 命令。

所以，在 foo.py 中，我会说

import click

@click.group()
def foo():

@foo.command
@option('--long', ...)
@option('--check', ...)
def version(long, check):
    ...

bar 相同。如何避免在两个文件中重复命令定义？

Answer 1

参考，您可以构建一个点击命令并将其作为两个单独的操作添加到多个组或命令中。

构建点击命令：

首先我们需要构建一个点击命令。我们将使用辅助函数来修饰可导入的命令，例如：

import click

def importable_command(*args, **kwargs):
    def decorator(f):
        return click.decorators.command(*args, **kwargs)(f)
    return decorator


@importable_command('version')
@click.option('--long')
@click.option('--check')
def version_cmd(long, check):
    click.echo('version long: {}'.format(long))
    click.echo('version check: {}'.format(check))

将命令添加到组：

然后我们可以导入命令并将其添加到组中：

from where-ever-we-defined-it import version_cmd

# Add our version command to this group
a_group.add_command(version_cmd)

测试代码：

import click

def importable_command(*args, **kwargs):
    def decorator(f):
        return click.decorators.command(*args, **kwargs)(f)
    return decorator


@importable_command('version')
@click.option('--long')
@click.option('--check')
def version_cmd(long, check):
    click.echo('version long: {}'.format(long))
    click.echo('version check: {}'.format(check))


@click.group()
def cli():
    """An Awesome CLI"""


# Add our version command to this group
cli.add_command(version_cmd)

if __name__ == "__main__":
    commands = (
        'version --long a_long',
        'version --help',
        '--help',
    )

    import sys, time

    time.sleep(1)
    print('Click Version: {}'.format(click.__version__))
    print('Python Version: {}'.format(sys.version))
    for cmd in commands:
        try:
            time.sleep(0.1)
            print('-----------')
            print('> ' + cmd)
            time.sleep(0.1)
            cli(cmd.split())

        except BaseException as exc:
            if str(exc) != '0' and \
                    not isinstance(exc, (click.ClickException, SystemExit)):
                raise

结果：

Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct  3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
> version --long a_long
version long: a_long
version check: None
-----------
> version --help
Usage: test.py version [OPTIONS]

Options:
  --long TEXT
  --check TEXT
  --help        Show this message and exit.
-----------
> --help
Usage: test.py [OPTIONS] COMMAND [ARGS]...

  An Awesome CLI

Options:
  --help  Show this message and exit.

Commands:
  version

在多个顶级命令之间共享一个子命令

Share a sub-command among multiple top level commands

python

command-line-interface

python-click

构建点击命令：

将命令添加到组：

测试代码：

结果：