Это правильное поведение при нажатии на питоне? - PullRequest
Новая
       14

Это правильное поведение при нажатии на питоне?

1 голос
/ 02 апреля 2019

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

Одинаковое поведение как в Ubuntu 18.04 Python 3.6, так и в Windows 10 Python 3.7 с python-click версии 7.0.

Я сделал тестовый файл click_test.py: 

import click


@click.command()
@click.argument('src', nargs=-1, required=True)
@click.argument('dst', required=False)
def copy(src, dst):
    print(f'{src!r}')
    print(f'{dst!r}')


if __name__ == '__main__':
    copy()

Запуск python click_test.py first-argument выдайте этот вывод: 

Usage: click_test.py [OPTIONS] SRC... [DST]
Try "click_test.py --help" for help.

Error: Missing argument "SRC...".

Описание использования описывает, что я ожидаю. SRC требуется, но DST является необязательным. Но, тем не менее, в сообщении об ошибке говорится, что отсутствует SRC.

Это правильное поведение или это ошибка?

1 Ответ

1 голос
/ 02 апреля 2019

Ваша желаемая командная строка немного двусмысленна. Как бы клик знать, когда src был src или последним dst? Таким образом, с nargs=-1 парсер откладывает значение от src до dst.

Тем не менее, ожидание в вашем вопросе может быть достигнуто с помощью небольшого переоснащения в виде пользовательского click.Argument класса.

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

def take_empty_from(other_param_name):

    class EmptyFrom(click.Argument):

        def consume_value(self, ctx, opts):
            value = opts.get(self.name)
            if value == () and opts.get(other_param_name):
                value = opts[self.name] = (opts.get(other_param_name), )
                opts[other_param_name] = None
                return value
            else:
                return super(EmptyFrom, self).consume_value(ctx, opts)

    return EmptyFrom

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

@click.command()
@click.argument('src', nargs=-1, required=True, cls=take_empty_from('dst'))
@click.argument('dst', required=False)
def copy(src, dst):

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

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

В этом случае мы переопределяем click.Argument.consume_value(), а затем в случае только одного параметра берем аргумент из dst и помещаем его в src.

Примечание: хотя такое поведение соответствует запросу в вопросе, оно все равно оставляет без ответа, почему src не требуется только при наличии одного параметра dst.

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

import click


@click.command()
@click.argument('src', nargs=-1, required=True, cls=take_empty_from('dst'))
@click.argument('dst', required=False)
def copy(src, dst):
    click.echo('src: {}'.format(src))
    click.echo('dst: {}'.format(dst))


if __name__ == "__main__":
    commands = (
        '',
        'a',
        'a b',
        'a b c',
        '--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)
            copy(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.5 (v3.6.5:f59c0932b4, Mar 28 2018, 05:52:31) 
[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.57)]
-----------
> 
Usage: click_prog.py [OPTIONS] SRC... [DST]

Error: Missing argument "src".
-----------
> a
src: ('a',)
dst: None
-----------
> a b
src: ('a',)
dst: b
-----------
> a b c
src: ('a', 'b')
dst: c
-----------
> --help
Usage: click_prog.py [OPTIONS] SRC... [DST]

Options:
  --help  Show this message and exit.
...