python click子命令统一错误处理

Question

在有命令组的情况下，每个子命令都可能引发异常，我如何将它们集中在一个地方处理？

给出下面的例子:

import click


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

@cli.command()
def foo():
    pass

if __name__ == '__main__':
    cli()

cli 和 foo 都可以加注。我知道一种可能的解决方案是将 try-except 放在 if 子句中的 cli() 周围。但这在分发包时不起作用。在 setup.py 中，您必须指定一个入口点(在本例中为 cli)。 if 子句不会被执行。

Answer 1

您可以通过继承来创建自定义 click.Group。可以通过将自定义组作为 cls 参数传递给 click.group() 装饰器来使用自定义组。如果您覆盖 __call__ 方法，您可以插入一个异常处理程序，如:

代码:

class CatchAllExceptions(click.Group):

    def __call__(self, *args, **kwargs):
        try:
            return self.main(*args, **kwargs)
        except Exception as exc:
            click.echo('We found %s' % exc)

测试代码:

import click

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

@cli.command()
def foo():
    raise Exception('an exception!')

if __name__ == '__main__':
    cli('foo'.split())

结果:

We found an exception!