Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/python/301.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181

Warning: file_get_contents(/data/phpspider/zhask/data//catemap/4/matlab/16.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Python 单击:如何将操作应用于所有命令和子命令,但允许命令选择退出?_Python_Python Click - Fatal编程技术网

Python 单击:如何将操作应用于所有命令和子命令,但允许命令选择退出?

Python 单击:如何将操作应用于所有命令和子命令,但允许命令选择退出?,python,python-click,Python,Python Click,对于大多数单击命令和子命令,我希望自动运行一个公共函数,check_upgrade(),但也有一些情况我不想运行它。我在想我可以有一个装饰器,可以为不应该运行check\u upgrade()的命令添加(例如@bypass\u upgrade\u check) 我希望有这样的东西(谢谢你最初的想法): 不幸的是,这只适用于顶级命令,因为ctx.invoked_子命令指的是sub_cmd_组,而不是sub_cmd1或sub_cmd2 有没有一种方法可以递归地搜索子命令,或者可以使用自定义组通过顶级

对于大多数单击命令和子命令,我希望自动运行一个公共函数,
check_upgrade()
,但也有一些情况我不想运行它。我在想我可以有一个装饰器,可以为不应该运行
check\u upgrade()
的命令添加(例如
@bypass\u upgrade\u check

我希望有这样的东西(谢谢你最初的想法):

不幸的是,这只适用于顶级命令,因为
ctx.invoked_子命令
指的是
sub_cmd_组
,而不是
sub_cmd1
sub_cmd2


有没有一种方法可以递归地搜索子命令,或者可以使用自定义组通过顶级命令和子命令来实现此功能?

解决此问题的一种方法是构建一个自定义装饰器,该装饰器与自定义的
单击配对。组
类:

自定义装饰生成器: 使用装饰生成器: 要使用decorator,我们首先需要构建decorator,如:

bypass_upgrade_check = make_exclude_hook_group(do_upgrade)
然后我们需要将其用作自定义类,以
单击.group()
如下所示:

@click.group(cls=bypass_upgrade_check())
...
最后,我们可以将任何命令或子命令修饰为不需要使用回调的组,如:

@bypass_upgrade_check
@my_group.command()
def my_click_command_without_upgrade():
     ...
这是怎么回事? 这是因为click是一个设计良好的OO框架。
@click.group()
decorator通常实例化
click.group
对象,但允许使用
cls
参数过度处理此行为。因此,在我们自己的类中继承
click.Group
并超越所需的方法是一件相对容易的事情

在本例中,我们构建了一个decorator,它在任何不需要调用回调的click函数上设置一个属性。然后在我们的自定义组中,我们对上下文的
单击.Context.invoke()
,如果即将执行的命令尚未修饰,我们调用回调

测试代码: 结果:
很好!它肯定比不使用子命令的示例更复杂,但在这种情况下,灵活性是值得的。@agelter,它可能看起来很复杂,但实际上并不在这个库的上下文中。这是一个了解click库潜在复杂性的窗口。图书馆的辉煌之处在于,对于它设计的案例来说,从外观上看,它非常简单。这并不简单,只是看起来很简单,因为API设计得很好。但是,即使对于它不是为之设计的东西,如果您了解基本库,您通常也可以用相对较少的代码使它做您想要的事情。干杯,很高兴这是有用的。
@click.group(cls=bypass_upgrade_check())
...
@bypass_upgrade_check
@my_group.command()
def my_click_command_without_upgrade():
     ...
import click

def do_upgrade():
    print("Performing upgrade")

bypass_upgrade_check = make_exclude_hook_group(do_upgrade)

@click.group(cls=bypass_upgrade_check())
@click.pass_context
def cli(ctx):
    pass

@bypass_upgrade_check
@cli.command()
def top_cmd1():
    click.echo('cmd1')

@cli.command()
def top_cmd2():
    click.echo('cmd2')

@cli.group()
def sub_cmd_group():
    click.echo('sub_cmd_group')

@bypass_upgrade_check
@sub_cmd_group.command()
def sub_cmd1():
    click.echo('sub_cmd1')

@sub_cmd_group.command()
def sub_cmd2():
    click.echo('sub_cmd2')

if __name__ == "__main__":
    commands = (
        'top_cmd1',
        'top_cmd2',
        'sub_cmd_group sub_cmd1',
        'sub_cmd_group sub_cmd2',
        '--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)]
-----------
> top_cmd1
cmd1
-----------
> top_cmd2
Performing upgrade
cmd2
-----------
> sub_cmd_group sub_cmd1
sub_cmd_group
sub_cmd1
-----------
> sub_cmd_group sub_cmd2
Performing upgrade
sub_cmd_group
sub_cmd2
-----------
> --help
Usage: test.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  sub_cmd_group
  top_cmd1
  top_cmd2