Question

Python click允许指定一些命令行选项作为＆＃34;功能开关＆＃34;。 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，并自定义解析器。

自定义类：

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.

禁止在python点击中传递几个功能开关

1 个答案:

自定义类：

使用自定义类：

这是如何工作的？

测试代码：

测试结果：