有没有办法用Python Click自动处理异常？

Question

点击exception handling documentation提到框架会自动优雅地处理某些类型的例外，例如Abort，EOFError和KeyboardInterrupt。

对于我正在编写的应用程序，有很多要点可以生成异常。终止应用程序是正确的步骤，但不打印堆栈跟踪。我总是可以手动执行此操作：

@cli.command()
def somecommand:
  try:
    # ...
  except Exception as e:
    click.echo(e)

但是，有没有办法让Click自动处理所有异常？

Answer 1

在我们的CLI中，所有命令都分组在一个命令组下。这使我们能够实现一些需要为每个命令执行的行为。其中一部分是异常处理。

我们的切入点如下所示：

 @click.group()
 @click.pass_context
 def entry_point(ctx):
      ctx.obj = {"example": "This could be the configuration"}

我们用它来运行全局代码，例如配置context，但您也可以定义一个不执行任何操作的空方法。可以使用@entry_point.command()装饰器或entry_point.add_command(cmd)将其他命令添加到此命令组。

对于异常处理，我们将entry_point包装在另一个处理异常的方法中：

 def safe_entry_point():
      try:
          entry_point()
      except Exception as e:
          click.echo(e)

在setup.py中，我们配置CLI的入口点并将其指向包装器：

 entry_points={
    'console_scripts': [
        'cli = my.package:safe_entry_point'
    ]
}

CLI的命令可以通过其命令组执行：例如cli command。

可能会有更优雅的解决方案，但这就是我们解决它的方法。虽然它引入了一个命令组作为CLI中的最高级元素，但它允许我们在一个地方处理所有异常，而无需在每个命令中复制我们的错误处理。