Использование click.MultiCommand с методами класса - PullRequest
Новая
       16

Использование click.MultiCommand с методами класса

1 голос
/ 18 марта 2019

Как я могу использовать click.MultiCommand вместе с командами, определенными как методы класса?

Я пытаюсь настроить систему плагинов для конвертеров, где пользователи библиотеки могут предоставить свои собственные конвертеры.Для этой системы я настраиваю CLI, как показано ниже: 

$ myproj convert {converter} INPUT OUTPUT {ARGS}

Каждый конвертер имеет свой собственный класс и все наследуются от BaseConverter.В BaseConverter самая простая команда Click, которая принимает только ввод и вывод.

Для преобразователей, которым не нужно больше, им не нужно переопределять этот метод.Если конвертеру требуется нечто большее или требуется предоставить дополнительную документацию, его необходимо переопределить.

При использовании приведенного ниже кода я получаю следующую ошибку при попытке использовать cli:

TypeError: cli () отсутствует 1 обязательный позиционный аргумент: 'cls' 

conversion/

├── __init__.py
└── backends/
    ├── __init__.py
    ├── base.py
    ├── bar.py
    ├── baz.py
    └── foo.py

# cli.py

from pydoc import locate
import click
from proj.conversion import AVAILABLE_CONVERTERS

class ConversionCLI(click.MultiCommand):
    def list_commands(self, ctx):
        return sorted(list(AVAILABLE_CONVERTERS))

    def get_command(self, ctx, name):
        return locate(AVAILABLE_CONVERTERS[name] + '.cli')


@click.command(cls=ConversionCLI)
def convert():
    """Convert files using specified converter"""
    pass

# conversion/__init__.py

from django.conf import settings

AVAILABLE_CONVERTERS = {
    'bar': 'conversion.backends.bar.BarConverter',
    'baz': 'conversion.backends.baz.BazConverter',
    'foo': 'conversion.backends.foo.FooConverter',
}

extra_converters = getattr(settings, 'CONVERTERS', {})
AVAILABLE_CONVERTERS.update(extra_converters)


# conversion/backends/base.py

import click

class BaseConverter():
    @classmethod
    def convert(cls, infile, outfile):
        raise NotImplementedError

    @classmethod
    @click.command()
    @click.argument('infile')
    @click.argument('outfile')
    def cli(cls, infile, outfile):
        return cls.convert(infile, outfile)

# conversion/backends/bar.py

from proj.conversion.base import BaseConverter

class BarConverter(BaseConverter):
    @classmethod
    def convert(cls, infile, outfile):
        # do stuff


# conversion/backends/foo.py

import click
from proj.conversion.base import BaseConverter

class FooConverter(BaseConverter):
    @classmethod
    def convert(cls, infile, outfile, extra_arg):
        # do stuff

    @classmethod
    @click.command()
    @click.argument('infile')
    @click.argument('outfile')
    @click.argument('extra-arg')
    def cli(cls, infile, outfile, extra_arg):
        return cls.convert(infile, outfile, extra_arg)

1 Ответ

2 голосов
/ 26 апреля 2019

Чтобы использовать classmethod в качестве команды щелчка, необходимо иметь возможность заполнить параметр cls при вызове команды.Это можно сделать с помощью пользовательского класса click.Command, например:

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

import click

class ClsMethodClickCommand(click.Command):
    def __init__(self, *args, **kwargs):
        self._cls = [None]
        super(ClsMethodClickCommand, self).__init__(*args, **kwargs)

    def main(self, *args, **kwargs):
        self._cls[0] = args[0]
        return super(ClsMethodClickCommand, self).main(*args[1:], **kwargs)

    def invoke(self, ctx):
        ctx.params['cls'] = self._cls[0]
        return super(ClsMethodClickCommand, self).invoke(ctx)

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

class MyClassWithAClickCommand:

    @classmethod
    @click.command(cls=ClsMethodClickCommand)
    ....
    def cli(cls, ....):
        ....

И затем в click.Multicommand класс, вам нужно заполнить атрибут _cls, поскольку command.main не вызывается в этом случае: 

def get_command(self, ctx, name):
    # this is hard coded in this example but presumably
    #   would be done with a lookup via name
    cmd = MyClassWithAClickCommand.cli

    # Tell the click command which class it is associated with
    cmd._cls[0] = MyClassWithAClickCommand
    return cmd

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

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

В этом случае мы переопределяем click.Command.invoke() и затем добавляем содержащий класс к диктовке ctx.paramsкак cls перед вызовом обработчика команды.

Код теста: 

class MyClassWithAClickCommand:

    @classmethod
    @click.command(cls=ClsMethodClickCommand)
    @click.argument('arg')
    def cli(cls, arg):
        click.echo('cls: {}'.format(cls.__name__))
        click.echo('cli: {}'.format(arg))


class ConversionCLI(click.MultiCommand):
    def list_commands(self, ctx):
        return ['converter_x']

    def get_command(self, ctx, name):
        cmd = MyClassWithAClickCommand.cli
        cmd._cls[0] = MyClassWithAClickCommand
        return cmd


@click.command(cls=ConversionCLI)
def convert():
    """Convert files using specified converter"""



if __name__ == "__main__":
    commands = (
        'converter_x an_arg',
        'converter_x --help',
        'converter_x',
        '--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)
            convert(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)]
-----------
> converter_x an_arg
class: MyClassWithAClickCommand
cli: an_arg
-----------
> converter_x --help
Usage: test.py converter_x [OPTIONS] ARG

Options:
  --help  Show this message and exit.
-----------
> converter_x
Usage: test.py converter_x [OPTIONS] ARG

Error: Missing argument "arg".
-----------
> --help
Usage: test.py [OPTIONS] COMMAND [ARGS]...

  Convert files using specified converter

Options:
  --help  Show this message and exit.

Commands:
  converter_x
-----------
> 
Usage: test.py [OPTIONS] COMMAND [ARGS]...

  Convert files using specified converter

Options:
  --help  Show this message and exit.

Commands:
  converter_x
...