nargs = *等价于Click中的选项

小编典典

nargs = *等价于Click中的选项

python

Click中的可选参数是否具有等效于argparse的nargs='*'功能？

我正在编写命令行脚本，并且其中一个选项需要能够接受无限数量的参数，例如：

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

阅读 213

2020-12-20

共1个答案

小编典典

一种实现目标的方法是从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()decorator，如下所示：

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

或者如果希望该选项将占用整个命令行的其余部分，而不尊重其他选项：

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

这是如何运作的？

之所以可行，是因为click是一个设计良好的OO框架。该@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.

2020-12-20