python - SSH 或类似 sudo 的 python click 行为

Question

我使用 click 来处理我的 Python 脚本命令行。我想实现类似于 SSH 或 Sudo 的行为，即解析一些已知参数并按原样采用其他所有内容而不进行任何处理。

例如，考虑这个命令行:

ssh -v myhost echo -n -e foo bar

请注意 -v 将由 SSH 处理，但 echo 及其后的所有内容将不会作为选项处理。

这是我当前的实现:

@click.command()
@click.option('-v', '--verbose', is_flag=True)
@click.argument('target')
@click.argument('command', nargs=-1)
def my_command(verbose, target, command):
    print('verbose:', verbose)
    print('target:', target)
    print('command:', command)

它没有按预期工作:

$ python test.py -v hostname echo -e foo
Usage: test.py [OPTIONS] TARGET [COMMAND]...
Try "test.py --help" for help.

Error: no such option: -e

我可以添加 -- 分隔符来强制执行预期的行为:

$ python /tmp/test.py -v hostname -- echo -e foo
verbose: True
target: hostname
command: ('echo', '-e', 'foo')

但这不是我想要的。

我还可以添加ignore_unknown_options=True:

@click.command(context_settings=dict(ignore_unknown_options=True))
...

$ python /tmp/test.py -v hostname echo -e foo
verbose: True
target: hostname
command: ('echo', '-e', 'foo')

但它不适用于已知选项，例如本例中的-v。

所以问题是:如何在遇到特定的参数后指示click停止处理任何选项？

Answer 1

您可以使用自定义 click.Command 类在需要的地方自动插入 --，例如:

自定义类:

class RealNargsMinusOne(click.Command):

    def parse_args(self, ctx, args):
        orig_args = list(args)
        try:
            return super(RealNargsMinusOne, self).parse_args(ctx, args)
        except click.NoSuchOption as exc:
            first_unknown = str(exc).split()[-1]
            position_unknown = orig_args.index(first_unknown)
            orig_args.insert(position_unknown, '--')
            return super(RealNargsMinusOne, self).parse_args(ctx, orig_args)

使用自定义类:

要使用自定义类，将其作为 cls 参数传递给命令装饰器，例如:

@click.command(cls=RealNargsMinusOne)
....
def my_command():
    ....

这是如何运作的？

之所以可行，是因为 click 是一个设计良好的 OO 框架。 @click.command() 装饰器通常实例化一个 click.Command 对象，但允许使用 cls 参数覆盖此行为。因此，在我们自己的类中继承 click.Command 并覆盖所需的方法是一件相对容易的事情。

在这种情况下，我们越过 click.Command.parse_args() 并捕获 click.NoSuchOption 异常。然后我们在有问题的选项前面用 -- 修改参数列表并重试解析。

测试代码:

import click

@click.command(cls=RealNargsMinusOne)
@click.option('-v', '--verbose', is_flag=True)
@click.argument('target')
@click.argument('command', nargs=-1)
def my_command(verbose, target, command):
    print('verbose:', verbose)
    print('target:', target)
    print('command:', command)


if __name__ == "__main__":
    commands = (
        '-v hostname echo -e foo',
        '-v hostname -x echo -e foo',
        '-x hostname -x echo -e foo',
        '--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)
            my_command(cmd.split(), allow_extra_args=True)

        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)]
-----------
> -v hostname echo -e foo
verbose: True
target: hostname
command: ('echo', '-e', 'foo')
-----------
> -v hostname -x echo -e foo
verbose: True
target: hostname
command: ('-x', 'echo', '-e', 'foo')
-----------
> -x hostname -x echo -e foo
verbose: False
target: -x
command: ('hostname', '-x', 'echo', '-e', 'foo')
-----------
> --help
Usage: test.py [OPTIONS] TARGET [COMMAND]...

Options:
  -v, --verbose
  --help         Show this message and exit.
-----------
> 
Usage: test.py [OPTIONS] TARGET [COMMAND]...

Error: Missing argument "target".