时间戳

首页 > 解决方案 > Python Click：如何打印有关使用错误的完整帮助详细信息？

python - Python Click：如何打印有关使用错误的完整帮助详细信息？

问题描述

我正在为我的 CLI 使用 python click。当我传入错误的参数或标志集时，会弹出一条使用消息。但是，当我使用该--help标志时，会弹出一个更详细的使用消息，其中包含所有选项和参数的列表。有没有办法更改默认行为，以便使用错误打印完整的详细帮助？

例如，缺少的参数打印

mycli foo
Usage: mycli foo [OPTIONS] MY_ARG

Error: Missing argument "my_arg".

但添加--help打印

mycli foo --help
Usage: mycli foo [OPTIONS] MY_ARG

  Long and useful description of the command and stuff.

Options:
  -h, --help  Show this message and exit.

该命令的实现大致如下

@click.group()
@click.pass_context
def cli(ctx):
    ctx.obj = {}

@cli.command()
@click.argument('my_arg')
@click.pass_context
@report_errors
def foo(ctx, my_arg):
  # some stuff here

标签： pythonpython-click

解决方案

可以通过猴子补丁来完成UsageError

import click
from click.exceptions import UsageError
from click._compat import get_text_stderr
from click.utils import echo


def _show_usage_error(self, file=None):
    if file is None:
        file = get_text_stderr()
    color = None
    if self.ctx is not None:
        color = self.ctx.color
        echo(self.ctx.get_help() + '\n', file=file, color=color)
    echo('Error: %s' % self.format_message(), file=file, color=color)


UsageError.show = _show_usage_error


@click.group()
@click.pass_context
def cli(ctx):
    ctx.obj = {}

@cli.command()
@click.argument('my_arg')
@click.pass_context
@report_errors
def foo(ctx, my_arg):
  # some stuff here

推荐阅读