Question

我有一个我开发的大型点击应用程序，但浏览不同的命令/子命令变得越来越粗糙。如何将命令组织到单独的文件中？是否可以将命令及其子命令组织到单独的类中？

以下是我想如何分开它的一个例子：

的初始化

import click

@click.group()
@click.version_option()
def cli():
    pass #Entry Point

command_cloudflare.py

@cli.group()
@click.pass_context
def cloudflare(ctx):
    pass

@cloudflare.group('zone')
def cloudflare_zone():
    pass

@cloudflare_zone.command('add')
@click.option('--jumpstart', '-j', default=True)
@click.option('--organization', '-o', default='')
@click.argument('url')
@click.pass_obj
@__cf_error_handler
def cloudflare_zone_add(ctx, url, jumpstart, organization):
    pass

@cloudflare.group('record')
def cloudflare_record():
    pass

@cloudflare_record.command('add')
@click.option('--ttl', '-t')
@click.argument('domain')
@click.argument('name')
@click.argument('type')
@click.argument('content')
@click.pass_obj
@__cf_error_handler
def cloudflare_record_add(ctx, domain, name, type, content, ttl):
    pass

@cloudflare_record.command('edit')
@click.option('--ttl', '-t')
@click.argument('domain')
@click.argument('name')
@click.argument('type')
@click.argument('content')
@click.pass_obj
@__cf_error_handler
def cloudflare_record_edit(ctx, domain):
    pass

command_uptimerobot.py

@cli.group()
@click.pass_context
def uptimerobot(ctx):
    pass

@uptimerobot.command('add')
@click.option('--alert', '-a', default=True)
@click.argument('name')
@click.argument('url')
@click.pass_obj
def uptimerobot_add(ctx, name, url, alert):
    pass

@uptimerobot.command('delete')
@click.argument('names', nargs=-1, required=True)
@click.pass_obj
def uptimerobot_delete(ctx, names):
    pass

Answer 1

使用CommandCollection的缺点是它合并了命令并且只能与命令组一起使用。更好的选择是使用add_command来获得相同的结果。

我有一个包含以下树的项目：

cli/
├── __init__.py
├── cli.py
├── group1
│   ├── __init__.py
│   ├── commands.py
└── group2
    ├── __init__.py
    └── commands.py

每个子命令都有自己的模块，这使得使用更多辅助类和文件管理复杂的实现变得非常容易。在每个模块中，commands.py文件包含@click注释。示例group2/commands.py：

import click


@click.command()
def version():
    """Display the current version."""
    click.echo(_read_version())

如果有必要，您可以在模块中轻松创建更多类，import并在此处使用它们，从而为您的CLI提供Python类和模块的全部功能。

我的cli.py是整个CLI的入口点：

import click

from .group1 import commands as group1
from .group2 import commands as group2

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

entry_point.add_command(group1.command_group)
entry_point.add_command(group2.version)

通过此设置，可以非常轻松地按关注点分隔命令，还可以围绕它们构建可能需要的其他功能。到目前为止，它对我很有帮助......

参考： http://click.pocoo.org/6/quickstart/#nesting-commands

Answer 2

假设您的项目具有以下结构：

def my_func(str):
    symbols = ['_', '-']
    return reduce(lambda x, y: ' ' + y if x in symbols else x + y, str)

my_func('foo_bar-baz')  # 'foo_bar-baz'

组只不过是可以嵌套的多个命令和组。您可以将组分成模块并将其导入'foo bar baz'文件，然后使用add_command将它们添加到project/ ├── __init__.py ├── init.py └── commands ├── __init__.py └── cloudflare.py组。

以下是init.py示例：

cli

您必须导入位于cloudflare.py文件中的cloudflare组。您的init.py将如下所示：

import click
from .commands.cloudflare import cloudflare


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


cli.add_command(cloudflare)

然后你可以像这样运行cloudflare命令：

commands/cloudflare.py

这些信息在文档上并不是非常明确，但是如果你看一下评论得很好的源代码，就可以看到如何嵌套组。

Answer 3

我现在正在寻找类似的东西，在你的情况下很简单，因为你在每个文件中都有组，你可以解决这个问题，如documentation中所述：

在init.py文件中：

import click

from command_cloudflare import cloudflare
from command_uptimerobot import uptimerobot

cli = click.CommandCollection(sources=[cloudflare, uptimerobot])

if __name__ == '__main__':
    cli()

此解决方案的最佳部分是完全符合pep8和其他短绒，因为您不需要导入您不会使用的东西而且您不需要从任何地方导入*

Answer 4

花了我一段时间才能弄清楚但我想当我忘记如何做时，我会把它放在这里以提醒自己我认为部分问题是在click的github页面上提到了add_command函数，但没有在主要示例页面上提及

首先让我们创建一个名为root.py的初始python文件

import click
from cli_compile import cli_compile
from cli_tools import cli_tools

@click.group()
def main():
    """Demo"""

if __name__ == '__main__':
    main.add_command(cli_tools)
    main.add_command(cli_compile)
    main()

接下来，我们将一些工具命令放入一个名为cli_tools.py的文件中

import click

# Command Group
@click.group(name='tools')
def cli_tools():
    """Tool related commands"""
    pass

@cli_tools.command(name='install', help='test install')
@click.option('--test1', default='1', help='test option')
def install_cmd(test1):
    click.echo('Hello world')

@cli_tools.command(name='search', help='test search')
@click.option('--test1', default='1', help='test option')
def search_cmd(test1):
    click.echo('Hello world')

if __name__ == '__main__':
    cli_tools()

接下来，我们将一些编译命令放入名为cli_compile.py的文件中

import click

@click.group(name='compile')
def cli_compile():
    """Commands related to compiling"""
    pass

@cli_compile.command(name='install2', help='test install')
def install2_cmd():
    click.echo('Hello world')

@cli_compile.command(name='search2', help='test search')
def search2_cmd():
    click.echo('Hello world')

if __name__ == '__main__':
    cli_compile()

运行root.py现在应该给我们

Usage: root.py [OPTIONS] COMMAND [ARGS]...

  Demo

Options:
  --help  Show this message and exit.

Commands:
  compile  Commands related to compiling
  tools    Tool related commands

运行“ root.py编译”应该给我们

Usage: root.py compile [OPTIONS] COMMAND [ARGS]...

  Commands related to compiling

Options:
  --help  Show this message and exit.

Commands:
  install2  test install
  search2   test search

您还会注意到，您可以直接运行cli_tools.py或cli_compile.py，而且我在其中包含了一条主语句

Answer 5

我不是点击专家，但只需将文件导入主文件即可。我会将所有命令移到单独的文件中，并让一个主文件导入其他文件。这样就可以更容易地控制确切的顺序，以防它对您来说很重要。所以你的主文件看起来像：

import commands_main
import commands_cloudflare
import commands_uptimerobot

Answer 6

编辑：我刚刚意识到，我的回答/评论只不过是对Click自定义文档在“自定义多命令”部分提供的内容的重新表述：https://click.palletsprojects.com/en/7.x/commands/#custom-multi-commands

只需添加一个@jdno的出色答案，我想到了一个辅助功能，该功能可以自动导入和自动添加子命令模块，这些模块大大减少了我的cli.py中的样板： / p>

我的项目结构是这样：

projectroot/
    __init__.py
    console/
    │
    ├── cli.py
    └── subcommands
       ├── bar.py
       ├── foo.py
       └── hello.py

每个子命令文件如下所示：

import click

@click.command()
def foo():
    """foo this is for foos!"""
    click.secho("FOO", fg="red", bg="white")

（目前，每个文件只有一个子命令）

在cli.py中，我编写了一个add_subcommand()函数，该函数循环遍历“ subcommands / *。py”组成的每个文件路径，然后执行导入和添加命令。

这是cli.py脚本的主体简化为：

import click
import importlib
from pathlib import Path
import re

@click.group()
def entry_point():
    """whats up, this is the main function"""
    pass

def main():
    add_subcommands()
    entry_point()

if __name__ == '__main__':
    main()

这就是add_subcommands()函数的样子：


SUBCOMMAND_DIR = Path("projectroot/console/subcommands")

def add_subcommands(maincommand=entry_point):
    for modpath in SUBCOMMAND_DIR.glob('*.py'):
        modname = re.sub(f'/', '.',  str(modpath)).rpartition('.py')[0]
        mod = importlib.import_module(modname)
        # filter out any things that aren't a click Command
        for attr in dir(mod):
            foo = getattr(mod, attr)
            if callable(foo) and type(foo) is click.core.Command:
                maincommand.add_command(foo)

如果我要设计一个具有多层嵌套和上下文切换级别的命令，我不知道这有多健壮。但它似乎现在可以正常工作了：）

Answer 7

当您希望您的用户 pip install "your_module"，然后使用命令时，您可以将它们作为列表添加到 setup.py entry_points 中：

entry_points={
    'console_scripts': [
        'command_1 = src.cli:function_command_1',
        'command_2 = src.cli:function_command_2',
    ]

每个命令都必须在 cli 文件中运行。

如何将具有一组子命令的Click命令拆分为多个文件？

的初始化

command_cloudflare.py

command_uptimerobot.py

7 个答案: