python - 我可以使用上下文值作为 click.option() 默认值吗?
问题描述
我想在我的配置(我加载到我的上下文中)中使用一个值作为单击命令选项的默认值。我已阅读文档的这一部分,但我认为我不了解我需要做什么。
这是我的示例脚本:
import sys
import click
@click.group()
@click.pass_context
def cli(ctx):
"""
CLI
"""
ctx.ensure_object(dict)
ctx.obj['DEFAULT_ENVIRONMENT'] = "dev"
@cli.command()
@click.option('-e', '--environment', required=True, default=click.get_current_context().obj['DEFAULT_ENVIRONMENT'])
def show_env(environment):
click.echo(environment)
if __name__ == '__main__':
cli()
如果我运行python cli.py show-env
,目标是让它输出dev
(因为我没有传递参数,因为它是从上下文加载的)。
这失败了
Traceback (most recent call last):
File "testcli.py", line 15, in <module>
@click.option('-e', '--environment', required=True, default=click.get_current_context().obj['DEFAULT_ENVIRONMENT'])
File "/home/devuser/.virtualenvs/cli/lib/python3.6/site-packages/click/globals.py", line 26, in get_current_context
raise RuntimeError('There is no active click context.')
RuntimeError: There is no active click context.
我也尝试过使用@pass_context
我的show_env
命令,如下所示:
@cli.command()
@click.option('-e', '--environment', required=True, default=ctx.obj['DEFAULT_ENVIRONMENT'])
@click.pass_context
def show_env(ctx, environment):
click.echo(environment)
失败ctx
是因为当时没有定义。
Traceback (most recent call last):
File "testcli.py", line 15, in <module>
@click.option('-e', '--environment', required=True, default=ctx.obj['DEFAULT_ENVIRONMENT'])
NameError: name 'ctx' is not defined
我可以使用我的上下文来设置命令选项默认值吗?
解决方案
正如您所指出的,在您尝试检查它时,上下文还不存在。您可以使用自定义类,例如:
自定义类
def default_from_context(default_name):
class OptionDefaultFromContext(click.Option):
def get_default(self, ctx):
self.default = ctx.obj[default_name]
return super(OptionDefaultFromContext, self).get_default(ctx)
return OptionDefaultFromContext
使用自定义类
要使用自定义类,请click.option
通过以下cls
参数将其传递给:
@click.option('-e', '--environment', required=True,
cls=default_from_context('DEFAULT_ENVIRONMENT'))
这是如何运作的?
这是因为 click 是一个设计良好的 OO 框架。@click.option()
装饰器通常实例化一个对象click.Option
,但允许使用cls
参数覆盖此行为。因此,从click.Option
我们自己的类中继承并覆盖所需的方法是一件相对容易的事情。
在这种情况下,我们覆盖click.Option.get_default()
. 在我们get_default()
中,我们检查上下文并设置默认值。然后我们调用父级get_default()
继续进一步处理。
测试代码:
import click
@click.group()
@click.pass_context
def cli(ctx):
"""
CLI
"""
ctx.ensure_object(dict)
ctx.obj['DEFAULT_ENVIRONMENT'] = "dev"
@cli.command()
@click.option('-e', '--environment', required=True,
cls=default_from_context('DEFAULT_ENVIRONMENT'))
def show_env(environment):
click.echo(environment)
if __name__ == "__main__":
commands = (
'show_env',
'--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.5 (v3.6.5:f59c0932b4, Mar 28 2018, 05:52:31)
[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.57)]
-----------
> show_env
dev
-----------
> --help
Usage: click_prog.py [OPTIONS] COMMAND [ARGS]...
CLI
Options:
--help Show this message and exit.
Commands:
show_env
推荐阅读
- mysql - 如何对父 ID 值求和并代替 null 显示
- java - 使用 ArrayAdapter 将视图添加到 GridView
- javascript - 根据Javascript中的日期计算数组中对象的数量
- android - 谷歌对赛门铁克的最后期限是否会影响应用直播
- node.js - 在 nodejs 和 socket.io 中的服务器关闭期间向客户端发送事件
- python - 嵌套在 dict 函数中的漂亮 for 循环:它是如何工作的?
- html - 从数组中的对象输出 JSON 数据。哈巴狗(翡翠)
- php - angularjs中的单个切换按钮可打开/关闭
- visual-studio - 在新品牌空 Xamarin 项目的当前上下文中不存在名称“InitializeComponent”
- javascript - 两个 Horizontol 滚动条