python - 单击 - 基于其他选项的提示的动态默认值
问题描述
我正在使用Click来构建 CLI 界面。Click为提示提供动态默认值,这很棒。此示例还提供了一些关于如何使用自定义点击类实现动态默认值的见解,从而在评估默认值时提供更灵活的选项。
我现在要做的是根据另一个提供的点击选项来设置动态默认值,例如
python mymodule --param1 something --param2 somethingelse
现在如果param2
为空,我想尝试根据提供的param1
输入获取动态默认值,例如:
@click.command()
@click.option('--param1', prompt=True)
@click.option('--param2', prompt=True, default=lambda: myfunct(param1))
def cmd(param1, param2):
pass
myfunct(param1:str=None):
param2 = None
#get param2 based on param1 input
return param2
关于什么是完成这项工作的最佳方法的任何想法?并且是否保证param1
在之前评估(并提示)param2
?
解决方案
扩展您引用所需功能的示例可以如下完成:
自定义类:
import click
class OptionPromptNull(click.Option):
_value_key = '_default_val'
def __init__(self, *args, **kwargs):
self.default_option = kwargs.pop('default_option', None)
super(OptionPromptNull, self).__init__(*args, **kwargs)
def get_default(self, ctx):
if not hasattr(self, self._value_key):
if self.default_option is None:
default = super(OptionPromptNull, self).get_default(ctx)
else:
arg = ctx.params[self.default_option]
default = self.type_cast_value(ctx, self.default(arg))
setattr(self, self._value_key, default)
return getattr(self, self._value_key)
def prompt_for_value(self, ctx):
default = self.get_default(ctx)
# only prompt if the default value is None
if default is None:
return super(OptionPromptNull, self).prompt_for_value(ctx)
return default
使用自定义类:
要使用自定义类,您需要将三个参数传递给click.option
装饰器,例如:
@click.option('--param3', cls=OptionPromptNull, default_option='param1',
default=lambda x: get_a_value(x), prompt="Enter Param3")
cls
需要引用自定义类。default_option
需要指定将哪个选项传递给default
可调用对象。default
指定用于获取默认值的可调用对象。
这是如何运作的?
这是有效的,因为click
它是一个设计良好的 OO 框架。@click.option()
装饰器通常实例化一个对象click.Option
,但允许使用cls
参数覆盖此行为。因此,从click.Option
我们自己的类中继承并覆盖所需的方法是一件相对容易的事情。
在这种情况下,我们覆盖了click.Option.get_default()
和click.Option.prompt_for_value()
方法。在prompt_for_value()
我们只提示默认是否为None
. 然后在get_default()
我们调用default
传递所需(先前输入的)参数的函数。
为了澄清问题的一部分,首先评估选项:按照它们在命令行上传递的顺序,其次:按照它们为那些没有在命令行上传递的选项声明的顺序。
测试代码:
@click.command()
@click.option('--param1', prompt="Enter Param1")
@click.option('--param2', cls=OptionPromptNull,
default=lambda: get_value_none(), prompt="Enter Param2")
@click.option('--param3', cls=OptionPromptNull, default_option='param1',
default=lambda x: get_a_value(x), prompt="Enter Param3")
def cli(param1, param2, param3):
click.echo("param1: '{}'".format(param1))
click.echo("param2: '{}'".format(param2))
click.echo("param3: '{}'".format(param3))
def get_value_none():
return None
def get_a_value(val):
return val
if __name__ == "__main__":
commands = (
r'',
r'--param3 5',
'--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)
cli(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.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
>
Enter Param1: 3
Enter Param2: 4
param1: '3'
param2: '4'
param3: '3'
-----------
> --param3 5
Enter Param1: 3
Enter Param2: 4
param1: '3'
param2: '4'
param3: '5'
-----------
> --help
Usage: test.py [OPTIONS]
Options:
--param1 TEXT
--param2 TEXT
--param3 TEXT
--help Show this message and exit.
推荐阅读
- reactjs - redux 的类型 / 像装饰器一样连接
- asp.net-mvc - 从外部类返回视图
- javascript - 在具有特定键的特定值的数组中查找对象的索引
- wix - 您如何在每次启动时检测已安装的产品版本?
- facebook - Facebook JS SDK 和分享按钮错误
- intellij-idea - IntelliJ Ultimate 无法从 SAP PI WSDL 文件生成代码
- pandas - 熊猫分组并从列表的行转换为大文件的列(无转置)
- jsp - 通过自定义标签从 JSP 获取应用程序字段
- autodesk-forge - 有没有办法知道 Forge API 中文件夹何时有子文件夹?
- swift - Firebase downloadUrl() 已弃用