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

Question

Click 的 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 中引入了一个命令组作为最高级别的元素，但它允许我们在一个地方处理所有异常，而无需在每个命令中重复我们的错误处理。

Answer 2

如果您只想处理某些 CLI 命令的异常。您可以使用另一个装饰器来处理异常。

这是一个例子：

import click
from functools import wraps, partial


class NumberTooLarge(Exception):
    pass

def catch_exception(func=None, *, handle):
    if not func:
        return partial(catch_exception, handle=handle)

    @wraps(func)
    def wrapper(*args, **kwargs):
        try:
            return func(*args, **kwargs)
        except handle as e:
            raise click.ClickException(e)

    return wrapper

@click.command()
@click.option("--count", default=1, help="Number of greetings.")
@catch_exception(handle=(NumberTooLarge, ValueError))
def hello(count):
    """Simple program that greets NAME for a total of COUNT times."""
    if count > 100:
        raise NumberTooLarge('count cannot be greater than 100')
    if count < 0:
        raise ValueError('count too small')
    click.echo('Great choice!')


if __name__ == "__main__":
    hello()

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

Is there a way to handle exceptions automatically with Python Click?

python

python-3.x

exception

exception-handling

python-click