Используйте команду python click с классом с переменными аргументами - PullRequest
Новая
       25

Используйте команду python click с классом с переменными аргументами

0 голосов
/ 15 февраля 2019

У меня есть класс, который инициализируется с ранее неизвестным числом аргументов, и я хочу, чтобы это было сделано в cli с использованием пакета python click.Моя проблема в том, что мне не удается инициализировать его и выполнить команду щелчка: 

$ python mycode.py arg1 arg2 ... argN click_command

, потому что с параметром с переменными аргументами nargs=-1 щелчок не распознает click_command как команду.

Как я могу ввести N аргументов, а затем выполнить команду с помощью щелчка?

Установка определенного количества аргументов, например nargs=5, решает проблему с отсутствующей командой, но обязывает меня ввести 5 аргументов домоя команда. 

import click

class Foo(object):
    def __init__(self, *args):
        self.args = args

    def log(self):
        print('self.args:', self.args)

pass_foo = click.make_pass_decorator(Foo)

@click.group()
@click.argument('myargs', nargs=-1)
@click.pass_context
def main(ctx, myargs):
    ctx.obj = Foo(myargs)
    print("arguments: ", myargs)

@main.command()
@pass_foo
def log(foo):
    foo.log()

main()

Я ожидаю, что смогу выполнить команду щелчка после передачи N аргументов моему классу Foo(), чтобы я мог инициализировать его и запустить его метод log() в качестве команды на cli,но вывод:

Ошибка: отсутствует команда

1 Ответ

0 голосов
/ 15 февраля 2019

Я не совсем уверен, что вы пытаетесь сделать это лучший способ решить эту проблему.Я думаю, что размещение переменных аргументов после команды будет более логичным и определенно будет лучше соответствовать тому, как работает click.Но вы можете делать то, что вам нужно, с помощью этого:

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

class CommandAfterArgs(click.Group):

    def parse_args(self, ctx, args):
        parsed_args = super(CommandAfterArgs, self).parse_args(ctx, args)
        possible_command = ctx.params['myargs'][-1]
        if possible_command in self.commands:
            ctx.protected_args = [possible_command]
            ctx.params['myargs'] = ctx.params['myargs'][:-1]

        elif possible_command in ('-h', '--help'):
            if len(ctx.params['myargs']) > 1 and \
                    ctx.params['myargs'][-2] in self.commands:
                ctx.protected_args = [ctx.params['myargs'][-2]]
                parsed_args = ['--help']
                ctx.params['myargs'] = ctx.params['myargs'][:-2]
                ctx.args = [possible_command]

        return parsed_args

Использование пользовательского класса:

Затем, чтобы использовать пользовательский класс, передайте его какcls аргумент для декоратора группы, такой как: 

@click.group(cls=CommandAfterArgs)
@click.argument('myargs', nargs=-1)
def main(myargs):
    ...

Код теста: 

import click

class Foo(object):
    def __init__(self, *args):
        self.args = args

    def log(self):
        print('self.args:', self.args)


pass_foo = click.make_pass_decorator(Foo)


@click.group(cls=CommandAfterArgs)
@click.argument('myargs', nargs=-1)
@click.pass_context
def main(ctx, myargs):
    ctx.obj = Foo(*myargs)
    print("arguments: ", myargs)


@main.command()
@pass_foo
def log(foo):
    foo.log()


if __name__ == "__main__":
    commands = (
        'arg1 arg2 log',
        'log --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)
            main(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)]
-----------
> arg1 arg2 log
arguments:  ('arg1', 'arg2')
self.args: ('arg1', 'arg2')
-----------
> log --help
arguments:  ()
Usage: test.py log [OPTIONS]

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

Options:
  --help  Show this message and exit.

Commands:
  log
...