禁止在python中传递多个功能开关单击
Python单击允许将一些命令行选项指定为“功能开关”。示例来自: 顾名思义,它用于某些功能有多个备选方案,并且只能选择一个的情况。上面的代码允许按如下方式运行脚本禁止在python中传递多个功能开关单击,python,python-click,Python,Python Click,Python单击允许将一些命令行选项指定为“功能开关”。示例来自: 顾名思义,它用于某些功能有多个备选方案,并且只能选择一个的情况。上面的代码允许按如下方式运行脚本 $ test.py --upper LINUX2 $ test.py --lower linux2 $ test.py LINUX2 但是,相同的脚本允许用户在命令行上指定这两个选项。单击将以静默方式使用最后指定的选项: $ test.py --upper --lower linux2 有没有办法强制单击以检查在命令行上传递的此
$ test.py --upper
LINUX2
$ test.py --lower
linux2
$ test.py
LINUX2
但是,相同的脚本允许用户在命令行上指定这两个选项。单击将以静默方式使用最后指定的选项:
$ test.py --upper --lower
linux2
有没有办法强制单击以检查在命令行上传递的此类选项不超过一个?一种方法是继承
单击.option
,并自定义解析器
自定义类:
使用自定义类:
要使用自定义类,请将cls
参数传递给@click.option()
装饰器,如:
@click.option("--an_option", 'option-name', cls=OnceSameNameOption)
字符串选项名称
用于检查同一选项的其他调用
这是怎么回事?
这是因为click是一个设计良好的OO框架。@click.option()
装饰程序通常实例化
click.Option
对象,但允许使用cls
参数覆盖此行为。所以这是一个相对的问题
很容易在我们自己的类中继承click.Option
,并超越所需的方法
在本例中,我们跳过了单击.Option.将\u添加到\u parser()
,然后猴子修补解析器,这样我们就可以
验证以前未看到相同的名称参数
测试代码:
测试结果:
@Petr,随着时间的推移,一般解决方案通常更有用。希望其他人会发现它有用。干杯
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
@click.option("--an_option", 'option-name', cls=OnceSameNameOption)
@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.