web-dev-qa-db-ja.com

nargs = * Clickのオプションと同等

Clickのオプションの引数に対応するargparseのnargs='*'機能はありますか？

私はコマンドラインスクリプトを書いていて、オプションの1つは次のように無制限の数の引数を取ることができる必要があります。

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 to -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
pythonpython-3.xpython-click
15
jpyams

目的を達成するための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()デコレータに渡します。

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

または、オプションが他のオプションを考慮せずにコマンドラインの残りの部分全体を食べることが望ましい場合：

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

これはどのように作動しますか？

これは、クリックが適切に設計されているため機能します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.
_
12
Stephen Rauch

このトリックを使用できます。

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
3
Nikita Malovichko