python - 如何在单击中为组操作创建例外
问题描述
我有一个案例,我想check_upgrade()
为我的大多数点击命令运行一个通用函数 ( ),但在少数情况下我不想运行它。与其依赖开发人员记住添加装饰器或函数调用来显式运行此检查,我更愿意默认运行它,然后拥有一个装饰器,可以为不应运行@bypass_upgrade_check
的命令添加(例如) 。check_upgrade()
我希望有类似的东西:
class State(object):
def __init__(self):
self.bypass_upgrade_check = False
pass_state = click.make_pass_decorator(State, ensure=True)
def bypass_upgrade_check(func):
@pass_state
def wrapper(state, *args, **kwargs):
state.bypass_upgrade_check = True
func(*args, **kwargs)
return wrapper
@click.group()
@pass_state
def common(state):
if not state.bypass_upgrade_check:
check_upgrade()
@common.command()
def cmd1():
# check_upgrade() runs here
pass
@bypass_upgrade_check
@common.command()
def cmd2():
# don't run check_upgrade() here
pass
但这不起作用。它实际上并没有调用该bypass_upgrade_check()
函数。
有没有办法以这样的方式装饰命令,以便我可以在组代码运行之前修改状态?还是另一种完全可以做到这一点的方法?
解决方案
为了跟踪哪些命令绕过了升级检查,我建议在绕过标记装饰器中将该状态存储在click.Command
对象上。然后,如果您将 传递click.Context
给您的组,则可以查看命令对象以查看它是否标记为允许跳过升级,例如:
代码:
def bypass_upgrade_check(func):
setattr(func, 'do_upgrade_check', False)
@click.group()
@click.pass_context
def cli(ctx):
sub_cmd = ctx.command.commands[ctx.invoked_subcommand]
if getattr(sub_cmd, 'do_upgrade_check', True):
check_upgrade()
测试代码:
import click
def check_upgrade():
click.echo('Checking Upgrade!')
def bypass_upgrade_check(func):
setattr(func, 'do_upgrade_check', False)
@click.group()
@click.pass_context
def cli(ctx):
sub_cmd = ctx.command.commands[ctx.invoked_subcommand]
if getattr(sub_cmd, 'do_upgrade_check', True):
check_upgrade()
@cli.command()
def cmd1():
# check_upgrade() runs here
click.echo('cmd1')
@bypass_upgrade_check
@cli.command()
def cmd2():
# don't run check_upgrade() here
click.echo('cmd2')
if __name__ == "__main__":
commands = (
'cmd1',
'cmd2',
)
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)]
-----------
> cmd1
Checking Upgrade!
cmd1
-----------
> cmd2
cmd2
推荐阅读
- vue.js - Vue-cli 3.x 监视和编译 scss 文件
- python-3.x - 如何更改图像的通道尺寸?
- ansible - Ansible 没有转义 Windows 路径第一个参数
- html - 内部导航链接在谷歌浏览器中不起作用
- twitter-bootstrap - 将按钮附加到输入组的底部
- java - 后缀中缀优化
- mysql - 如何找到具有特定天数的开始日期的每个用户的收入数量
- javascript - `npm install` 和 `npm audit` 计数之间的区别?
- python - 拼接航拍无人机图像时出现单应性问题?
- java - sort subdocument in mogodb4.0 by java driver