Как динамически вызывать подкоманды команды несколько раз? - PullRequest
Новая
       30

Как динамически вызывать подкоманды команды несколько раз?

1 голос
/ 06 июня 2019

Приложение My Click 7.0 имеет одну группу с несколькими командами, вызываемыми основной функцией cli следующим образом:

Код: 

import sys
import click

@click.group()
def cli():
    """This is cli helptext"""
    click.echo('cli called')

@cli.group(chain=True, no_args_is_help=False)
@click.option('-r', '--repeat', default=1, type=click.INT, help='repeat helptext')
def chainedgroup(repeat):
    """This is chainedgroup helptext"""

    top = sys.argv[2]
    bottom = sys.argv[3:]
    click.echo('chainedgroup code called')

    for _ in range(repeat):
        chainedgroup.main(bottom, top, standalone_mode=False)

@chainedgroup.command()
def command1():
    """This is command1 helptext"""
    click.echo('command1 called')

@chainedgroup.command()
@click.option('-o', '--option')
def command2(option):
    """This is command2 helptext"""
    click.echo('command2 called with {0}'.format(option))

Пробег: 

$ testcli chainedgroup --repeat 2 command1
$ testcli chainedgroup -r 3 command1 command2 -o test

Ожидаемый результат: 

cli called
chainedgroup code called
command1 called
command1 called
----------
cli called
chainedgroup code called
command1 called
command2 called with test
command1 called
command2 called with test
command1 called
command2 called with test

Фактический результат:

Случай № 1 дает мне ошибку Missing command, тогда как случай № 2 заканчивается RecursionError.

Я уверен Я был уверен, Command.main() - правильный метод для вызова. Что я делаю не так?

1 Ответ

1 голос
/ 17 июня 2019

Если вы создаете собственный класс click.Group, вы можете переопределить метод invoke(), чтобы вызывать команды более одного раза.

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

class RepeatMultiCommand(click.Group):
    def invoke(self, ctx):
        old_callback = self.callback

        def new_callback(*args, **kwargs):
            # only call the group callback once
            if repeat_number == 0:
                return old_callback(*args, **kwargs)
        self.callback = new_callback

        # call invoke the desired number of times
        for repeat_number in range(ctx.params['repeat']):
            new_ctx = copy.deepcopy(ctx)
            super(RepeatMultiCommand, self).invoke(new_ctx)

        self.callback = old_callback

Чтобы использовать пользовательский класс:

Передайте декоратору .group() пользовательский класс с параметром cls, например: 

@cli.group(chain=True, no_args_is_help=False, cls=RepeatMultiCommand)
@click.option('-r', '--repeat', default=1, type=click.INT,
              help='repeat helptext')
def chainedgroup(repeat):
    ....

Как это работает?

Это работает, потому что click - это хорошо спроектированная OO-инфраструктура. Декоратор @click.group() обычно создает экземпляр объекта click.Group, но позволяет переопределить это поведение параметром cls. Так что относительно легко унаследовать от click.Group в нашем собственном классе и переопределить нужные методы.

В этом случае мы переопределяем click.Group.invoke(). В нашем invoke() мы перехватываем групповой обратный вызов, чтобы он мог вызываться только один раз, а затем мы вызываем super().invoke() a repeat количество раз.

Тестовый код: 

import click
import copy
import sys

@click.group()
def cli():
    """This is cli helptext"""
    click.echo('cli called')


@cli.group(chain=True, no_args_is_help=False, cls=RepeatMultiCommand)
@click.option('-r', '--repeat', default=1, type=click.INT,
              help='repeat helptext')
def chainedgroup(repeat):
    """This is chainedgroup helptext"""
    click.echo('chainedgroup code called')


@chainedgroup.command()
def command1():
    """This is command1 helptext"""
    click.echo('command1 called')


@chainedgroup.command()
@click.option('-o', '--option')
def command2(option):
    """This is command2 helptext"""
    click.echo('command2 called with {0}'.format(option))


if __name__ == "__main__":
    commands = (
        'chainedgroup --repeat 2 command1',
        'chainedgroup -r 3 command1 command2 -o test',
        'chainedgroup command1',
        'chainedgroup --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)]
-----------
> chainedgroup --repeat 2 command1
cli called
chainedgroup code called
command1 called
command1 called
-----------
> chainedgroup -r 3 command1 command2 -o test
cli called
chainedgroup code called
command1 called
command2 called with test
command1 called
command2 called with test
command1 called
command2 called with test
-----------
> chainedgroup command1
cli called
chainedgroup code called
command1 called
-----------
> chainedgroup --help
cli called
Usage: test.py chainedgroup [OPTIONS] COMMAND1 [ARGS]... [COMMAND2
                            [ARGS]...]...

  This is chainedgroup helptext

Options:
  -r, --repeat INTEGER  repeat helptext
  --help                Show this message and exit.

Commands:
  command1  This is command1 helptext
  command2  This is command2 helptext
-----------
> --help
Usage: test.py [OPTIONS] COMMAND [ARGS]...

  This is cli helptext

Options:
  --help  Show this message and exit.

Commands:
  chainedgroup  This is chainedgroup helptext
...