禁止在 python 单击中传递多个功能开关

Question

Python 单击允许将某些命令行选项指定为 "feature switches"。来自 official documentation 的示例：

@click.command()
@click.option('--upper', 'transformation', flag_value='upper',
              default=True)
@click.option('--lower', 'transformation', flag_value='lower')
def info(transformation):
    click.echo(getattr(sys.platform, transformation)())

顾名思义，用于某个特征有多种选择，而只能选择一种的情况。上面的代码允许运行脚本作为

$ test.py --upper
LINUX2
$ test.py --lower
linux2
$ test.py
LINUX2

但是，同一脚本允许用户在命令行上指定两个选项。单击将静默使用最后指定的选项：

$ test.py --upper --lower
linux2

有什么方法可以强制点击检查在命令行上传递的此类选项不超过一个吗？

Answer 1

实现您所追求的目标的一种方法是继承 click.Option，并自定义解析器。

自定义 Class:

import click


class OnceSameNameOption(click.Option):

    def add_to_parser(self, parser, ctx):

        def parser_process(value, state):
            # method to hook to the parser.process
            if self.name in state.opts:
                param_same_name = [
                    opt.opts[0] for opt in ctx.command.params
                    if isinstance(opt, OnceSameNameOption) and opt.name == self.name
                ]

                raise click.UsageError(
                    "Illegal usage: `{}` are mutually exclusive arguments.".format(
                        ', '.join(param_same_name))
                )

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

        retval = super(OnceSameNameOption, 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._previous_parser_process = our_parser.process
                our_parser.process = parser_process
                break
        return retval

使用自定义 Class:

要使用自定义 class，请将 cls 参数传递给 @click.option() 装饰器，例如：

@click.option("--an_option", 'option-name', cls=OnceSameNameOption)

字符串 option-name 用于检查同一选项的其他调用。

这是如何工作的？

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

在这种情况下，我们超越了 click.Option.add_to_parser() 并且猴子修补了解析器，这样我们就可以验证之前没有看到同名参数。

测试代码：

@click.command()
@click.option('--upper', 'transformation', flag_value='upper',
              cls=OnceSameNameOption, default=True)
@click.option('--lower', 'transformation', flag_value='lower',
              cls=OnceSameNameOption)
def info(transformation):
    """Show the transformed platform"""
    click.echo(getattr(sys.platform, transformation)())

if __name__ == "__main__":
    commands = (
        '--upper --lower',
        '--upper',
        '--lower',
        '',
        '--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)
            info(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.2 (default, Jul 17 2017, 23:14:31) 
[GCC 5.4.0 20160609]
-----------
> --upper --lower
Error: Illegal usage: `--upper, --lower` are mutually exclusive arguments.
-----------
> --upper
LINUX
-----------
> --lower
linux
-----------
> 
LINUX
-----------
> --help
Usage: test.py [OPTIONS]

  Show the transformed platform

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

禁止在 python 单击中传递多个功能开关

Prohibit passing several feature switches in python click

python

python-click

自定义 Class:

使用自定义 Class:

这是如何工作的？

测试代码：

测试结果：