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

Question

Python click 允许将一些命令行选项指定为“功能开关”。来自官方文档的示例：

@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

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

$ test.py --upper --lower
linux2

有没有办法强制单击以检查命令行上传递的此类选项不超过一个？

Answer 1

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

定制类：

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

使用自定义类：

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

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

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

这是如何运作的？

这是可行的，因为 click 是一个设计良好的 OO 框架。装饰@click.option()器通常会实例化一个 click.Option对象，但允许使用参数覆盖此行为cls。因此，在我们自己的类中继承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.