设置自动日志，任何时间单击CLI命令？

Question

我当前在代码中使用单击来设置大量命令行工具，但是我想运行相当于click.echo（“ Cli Function X”）任何时间函数x被调用。有没有办法在我的项目中进行一般设置？还是我必须为每个CLI功能分别添加此功能？

Answer 1

我需要这个并修改这个答案以获取解决方案。给定此基本单击组：

import click

@click.group()
def cli():
    pass

@cli.command()
@click.argument("name", default="World")
def hello(name):
    print(f"Hello, {name}!")

if __name__ == "__main__":
    cli()

我添加了一个函数，该函数采用上下文并调用方法：

def _invoke(self, ctx, invoke):
    command = getattr(ctx, "command", ctx).name
    print(f"Running {command}: {ctx.params}")
    result = invoke(self, ctx)
    print(f"Completed {command}")
    return result

然后，我创建了一些自定义类，覆盖Invoke命令以调用上述函数：

class _Group(click.Group):
    def invoke(self, ctx):
        return _invoke(self, ctx, click.Group.invoke)

class _Command(click.Command):
    def invoke(self, ctx):
        return _invoke(self, ctx, click.Command.invoke)

将功能添加到现有脚本中很简单，将类通过cls参数将类传递到装饰符中，即：

@click.group(cls=_Group)
def cli():
    pass

@cli.command(cls=_Command)
@click.argument("name", default="World")
def hello(name):
    print(f"Hello, {name}!")

运行Hello命令现在在命令执行之前和之后打印到控制台：

$ python3 cli.py hello StackOverflow
Running cli: {}
Running hello: {'name': 'StackOverflow'}
Hello, StackOverflow!
Completed hello
Completed cli