Как обрабатывать справочное сообщение подгруппы - PullRequest
Новая
       26

Как обрабатывать справочное сообщение подгруппы

0 голосов
/ 02 марта 2019

Я пытаюсь понять некоторые детали реализации Click.У меня есть следующий пример кода: 

#cli.py

import click


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


@cli.group()
def show():
    """ Define the environment of the product """
    pass


@show.command()
def name():
    click.echo("run show name command")


@show.command()
def height():
    click.echo("run show height command")


if __name__ == "__main__":
    cli()

С этим кодом name и height являются под- командами группы show.Однако, семантически, это не имеет смысла.Это тем более аргументы команды 'show'.

Я знаю, что у меня может быть команда с аргументом «attribute», из которой я могу вызвать другую функцию, основанную на строковом значении «attribute».Тем не менее, я чувствую, что было бы утомительно поддерживать, когда есть несколько возможностей для «атрибута».

Я полагаю, что я все еще мог бы использовать вышеупомянутую структуру, если бы мог редактировать сообщение справки.Когда я запускаю cli.py show --help, я получаю сообщение справки по умолчанию для группы команд: 

Usage: cli.py show [OPTIONS] COMMAND [ARGS]...

  Define the environment of the product

Options:
  --help  Show this message and exit.

Commands:
  height
  name

Есть ли способ отредактировать сообщение справки, чтобы изменить «Команды» на «Аргументы»?Я знаю, как изменить оператор использования в декораторе click.group (), но я не уверен, как изменить само сообщение справки.

Сообщение справки, которое я хотел бы получить, выглядит следующим образом: 

Usage: cli.py show [OPTIONS] ARG

  Define the environment of the product

Options:
  --help  Show this message and exit.

Arguments:
  height
  name

Возможно ли что-то подобное?

Я использую python3 и Нажмите 6,7

1 Ответ

0 голосов
/ 04 марта 2019

Вы можете изменить сообщение, заданное справкой подкоманд, используя пользовательский класс для группы.Пользовательский класс может быть создан путем наследования от click.Group и изменения метода format_commands(), например:

Пользовательский класс: 

class HelpAsArgs(click.Group):
    # change the section head of sub commands to "Arguments"

    def format_commands(self, ctx, formatter):
        rows = []
        for subcommand in self.list_commands(ctx):
            cmd = self.get_command(ctx, subcommand)
            if cmd is None:
                continue

            help = cmd.short_help or ''
            rows.append((subcommand, help))

        if rows:
            with formatter.section('Arguments'):
                formatter.write_dl(rows)

Код теста: 

import click

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

@cli.group(cls=HelpAsArgs)
def show():
    """ Define the environment of the product """
    pass

@show.command()
def name():
    click.echo("run show name command")

@show.command()
def height():
    click.echo("run show height command")

if __name__ == "__main__":
    commands = (
        'show',
        'show --help',
        '--help',
    )

    import sys, time

    time.sleep(1)
    print('Click Version: {}'.format(click.__version__))
    print('Python Version: {}'.format(sys.version))
    for command in commands:
        try:
            time.sleep(0.1)
            print('-----------')
            print('> ' + command)
            time.sleep(0.1)
            cli(command.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)]
-----------
> show
Usage: test.py show [OPTIONS] COMMAND [ARGS]...

  Define the environment of the product

Options:
  --help  Show this message and exit.

Arguments:
  height
  name
-----------
> show --help
Usage: test.py show [OPTIONS] COMMAND [ARGS]...

  Define the environment of the product

Options:
  --help  Show this message and exit.

Arguments:
  height
  name
-----------
> --help
Usage: test.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  show  Define the environment of the product
...