我正在尝试对我的第一个 Click CLI 应用程序进行一种递归调用。 重点是让子命令与第一个相关联，因此，我试图将其全部分离到不同的文件/模块中以提高其可维护性。

我有当前的目录:

root
|-commands
|-project
|---__init__
|---command1
|---command2
|-database
|---__init__
|---command1
|---command2

这是我的主文件:

import click
from commands.project import project
from commands.database import database


@click.group(help="Main command")
def main():
    pass


main.add_command(project)
main.add_command(database)

我的项目__init__文件:

from commands.project.command1 import *
from commands.project.command2 import *
import click


@click.group(help="Projects")
def project():
    pass


project.add_command(command1)
project.add_command(command2)

我的 commands.project.command1 文件:

import click


@click.command()
def command1():
    """
    Execute all the steps required to update the project.
    """
    pass

这里的要点是，每次我想添加一个新的子命令时，我需要:

1. 将包含所有代码的 .py 文件添加到相应的子命令/子模块文件夹中(显然!)

2. 在 __init__ 文件中添加 import 语句

3. 将此新命令与其父命令(在本例中为项目/数据库)相关联

有什么方法可以进行循环/动态加载来避免第 2 步和第 3 步？

编辑

在尝试了 Stephen Rauch 方法后，它成功地包含了所有提供的文件，但是没有一个命令适用于 - 仅适用于函数名称(例如:update-project -> update_project).

root
|-commands
|-project
|---update
|---install_project
|-database
|---command_one
|---command_two

主.py

# main command ----------------------------------------------------------- ###
@click.group(help="CLI tool!", context_settings=dict(max_content_width=120))
def main():
    pass


# PROJECT command group -------------------------------------------------------- ###
@main.group(cls=group_from_folder("commands/project"),
            short_help="Project installation and upgrade utils.",
            help="Project installation and upgrade.")
def project():
    pass

commands/project/install_project.py

import click    

@click.command(name="install-project",
               help="This options allows you to easily install project",
               short_help="Install a brand new project")
@click.pass_context
def install_project(ctx):

CLI 结果 main project --help (注意 install_project 而不是 install-project sub命令)

Usage: main project [OPTIONS] COMMAND [ARGS]...

  Project installation and upgrade.

Options:
  --help  Show this message and exit.

Commands:
  install_project                     Install a brand new project one

最佳答案

修改示例 from here ，您可以消除第二步和第三步。我建议通过闭包为每个文件夹创建一个自定义类。这完全消除了对命令文件夹中的 __init__.py 的需要。此外，无需导入文件夹(模块)或文件夹中的命令。

自定义组类创建者:

import click
import os

def group_from_folder(group_folder_name):

    folder = os.path.join(os.path.dirname(__file__), group_folder_name)

    class FolderCommands(click.MultiCommand):

        def list_commands(self, ctx):
            return sorted(
                f[:-3] for f in os.listdir(folder) if f.endswith('.py'))

        def get_command(self, ctx, name):
            namespace = {}
            command_file = os.path.join(folder, name + '.py')
            with open(command_file) as f:
                code = compile(f.read(), command_file, 'exec')
                eval(code, namespace, namespace)
            return namespace[name.replace('-', '_').lower()]

    return FolderCommands

使用自定义类:

要使用自定义类，首先将命令(按照问题中的结构)放入一个文件夹中。然后使用 cls 参数修饰组命令，并传递一个自定义类，该类已初始化并指向包含命令的文件夹。

@cli.group(cls=group_from_folder('project'))
def group():
    "command for grouping"

测试代码:

@click.group()
def cli():
    "My awesome script"


@cli.group(cls=group_from_folder('group'))
def group():
    "command for grouping"


if __name__ == "__main__":
    commands = (
        'group command-test',
        'group',
        'group --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

文件组/command-test.py

import click


@click.command('command-test')
def command_test():
    """
    Execute all the steps required to update the project.
    """
    click.echo('Command Test')

结果:

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)]
-----------
> group command-test
Command Test
-----------
> group
Usage: test.py group [OPTIONS] COMMAND [ARGS]...

  command for grouping

Options:
  --help  Show this message and exit.

Commands:
  command-test  Execute all the steps required to update the...
-----------
> group --help
Usage: test.py group [OPTIONS] COMMAND [ARGS]...

  command for grouping

Options:
  --help  Show this message and exit.

Commands:
  command-test  Execute all the steps required to update the...
-----------
> 
Usage: test.py [OPTIONS] COMMAND [ARGS]...

  My awesome script

Options:
  --help  Show this message and exit.

Commands:
  group  command for grouping

关于python - 单击时包含子模块，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/50751040/