nargs=* эквивалент для опций в Click

Есть ли эквивалент функции nargs='*' argparse для необязательных аргументов в Click?

Я пишу сценарий командной строки, и один из параметров должен иметь возможность принимать неограниченное количество аргументов, например:

foo --users alice bob charlie --bar baz

Таким образом, users будет ['alice', 'bob', 'charlie'], а bar будет 'baz'.

В argparse я могу указать несколько необязательных аргументов, чтобы собрать все аргументы. которые следуют за ними, установив nargs='*'.

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--users', nargs='*')
>>> parser.add_argument('--bar')
>>> parser.parse_args('--users alice bob charlie --bar baz'.split())
Namespace(bar='baz', users=['alice', 'bob', 'charlie'])

Я знаю, что Click позволяет указать аргумент для принятия неограниченных входных данных, установив nargs=-1 , но когда я пытаюсь установить для необязательного аргумента nargs значение -1, я получаю:

TypeError: Опции не могут иметь nargs ‹ 0

Есть ли способ заставить Click принять неопределенное количество аргументов для опции?

Обновлять:

Мне нужно иметь возможность указывать параметры после параметра, который принимает неограниченное количество аргументов.

Обновлять:

Ответ @Stephen Rauch отвечает на этот вопрос. Однако я не рекомендую использовать подход, о котором я прошу здесь. Мой запрос функции преднамеренно не реализован в Click, поскольку это может привести к неожиданному поведению. Click рекомендует использовать multiple=True:

@click.option('-u', '--user', 'users', multiple=True)

А в командной строке это будет выглядеть так:

foo -u alice -u bob -u charlie --bar baz

person jpyams    schedule 22.01.2018    source источник


Ответы (3)


Один из способов приблизиться к тому, что вам нужно, - это наследоваться от click.Option и настроить синтаксический анализатор.

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

import click

class OptionEatAll(click.Option):

    def __init__(self, *args, **kwargs):
        self.save_other_options = kwargs.pop('save_other_options', True)
        nargs = kwargs.pop('nargs', -1)
        assert nargs == -1, 'nargs, if set, must be -1 not {}'.format(nargs)
        super(OptionEatAll, self).__init__(*args, **kwargs)
        self._previous_parser_process = None
        self._eat_all_parser = None

    def add_to_parser(self, parser, ctx):

        def parser_process(value, state):
            # method to hook to the parser.process
            done = False
            value = [value]
            if self.save_other_options:
                # grab everything up to the next option
                while state.rargs and not done:
                    for prefix in self._eat_all_parser.prefixes:
                        if state.rargs[0].startswith(prefix):
                            done = True
                    if not done:
                        value.append(state.rargs.pop(0))
            else:
                # grab everything remaining
                value += state.rargs
                state.rargs[:] = []
            value = tuple(value)

            # call the actual process
            self._previous_parser_process(value, state)

        retval = super(OptionEatAll, self).add_to_parser(parser, ctx)
        for name in self.opts:
            our_parser = parser._long_opt.get(name) or parser._short_opt.get(name)
            if our_parser:
                self._eat_all_parser = our_parser
                self._previous_parser_process = our_parser.process
                our_parser.process = parser_process
                break
        return retval

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

Чтобы использовать пользовательский класс, передайте параметр cls декоратору @click.option(), например:

@click.option("--an_option", cls=OptionEatAll)

или если желательно, чтобы опция съела всю оставшуюся часть командной строки, не учитывая другие опции:

@click.option("--an_option", cls=OptionEatAll, save_other_options=False)

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

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

В этом случае мы перегружаем click.Option.add_to_parser(), и обезьяна исправляет синтаксический анализатор, чтобы при желании мы могли съесть более одного токена.

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

@click.command()
@click.option('-g', 'greedy', cls=OptionEatAll, save_other_options=False)
@click.option('--polite', cls=OptionEatAll)
@click.option('--other')
def foo(polite, greedy, other):
    click.echo('greedy: {}'.format(greedy))
    click.echo('polite: {}'.format(polite))
    click.echo('other: {}'.format(other))


if __name__ == "__main__":
    commands = (
        '-g a b --polite x',
        '-g a --polite x y --other o',
        '--polite x y --other o',
        '--polite x -g a b c --other o',
        '--polite x --other o -g a b c',
        '-g a b c',
        '-g a',
        '-g',
        'extra',
        '--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)
            foo(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)]
-----------
> -g a b --polite x
greedy: ('a', 'b', '--polite', 'x')
polite: None
other: None
-----------
> -g a --polite x y --other o
greedy: ('a', '--polite', 'x', 'y', '--other', 'o')
polite: None
other: None
-----------
> --polite x y --other o
greedy: None
polite: ('x', 'y')
other: o
-----------
> --polite x -g a b c --other o
greedy: ('a', 'b', 'c', '--other', 'o')
polite: ('x',)
other: None
-----------
> --polite x --other o -g a b c
greedy: ('a', 'b', 'c')
polite: ('x',)
other: o
-----------
> -g a b c
greedy: ('a', 'b', 'c')
polite: None
other: None
-----------
> -g a
greedy: ('a',)
polite: None
other: None
-----------
> -g
Error: -g option requires an argument
-----------
> extra
Usage: test.py [OPTIONS]

Error: Got unexpected extra argument (extra)
-----------
> --help
Usage: test.py [OPTIONS]

Options:
  -g TEXT
  --polite TEXT
  --other TEXT
  --help         Show this message and exit.
person Stephen Rauch    schedule 23.01.2018
comment
Это замечательно. Большое спасибо, что нашли время опубликовать этот ответ! - person ffej; 12.07.2020

Вы можете использовать этот трюк.

import click

@click.command()
@click.option('--users', nargs=0, required=True)
@click.argument('users', nargs=-1)
@click.option('--bar')
def fancy_command(users, bar):
    users_str = ', '.join(users)
    print('Users: {}. Bar: {}'.format(users_str, bar))

if __name__ == '__main__':
    fancy_command()

Добавьте поддельный option с нужным именем и без аргументов nargs=0, затем добавьте «аргумент» с неограниченным количеством аргументов nargs=-1.

$ python foo --users alice bob charlie --bar baz
Users: alice, bob, charlie. Bar: baz

Но будьте осторожны с дополнительными опциями:

$ python foo --users alice bob charlie --bar baz faz
Users: alice, bob, charlie, faz. Bar: baz
person Nikita Malovichko    schedule 19.02.2019
comment
Но в этой настройке флаг --users можно будет вообще опустить. Не уверен, что это ожидается. - person MarSoft; 23.04.2019
comment
Спасибо, @MarSoft! Пропустил это! Измененный код выше, добавление required=True. Теперь невозможно опустить ---users. К сожалению, строку флага можно опустить. Те же результаты: $ python foo --users alice bob charlie --bar baz faz и $ python foo alice bob charlie --bar baz faz - person Nikita Malovichko; 13.05.2019

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

https://click.palletsprojects.com/en/7.x/options/#multiple-options

вот пример того, что я говорю:

вместо передачи одного строкового аргумента разделение на разделитель:

commit -m foo:bar:baz

Я решил использовать это:

commit -m foo -m bar -m baz

вот исходный код:

@click.command()
@click.option('--message', '-m', multiple=True)
def commit(message):
    click.echo('\n'.join(message))

Это больше для ввода, но я думаю, что это делает интерфейс командной строки более удобным и надежным.

person Aidan Melen    schedule 21.01.2020
comment
Это правильный ответ для интерфейса, и тот, который я в конечном итоге выбрал. nargs=+ — хороший хак, но обычно он поощряет плохой дизайн интерфейса командной строки. - person jpyams; 24.03.2020