Python单击:自定义错误消息

Question

我使用优秀的Python Click库来处理我的工具中的命令行选项.这是我的代码的简化版本(这里是完整的脚本):

@click.command(
    context_settings = dict( help_option_names = ['-h', '--help'] )
)
@click.argument('analysis_dir',
                 type = click.Path(exists=True),
                 nargs = -1,
                 required = True,
                 metavar = "<analysis directory>"
)

def mytool(analysis_dir):
   """ Do stuff """

if __name__ == "__main__":
    mytool()

如果有人在没有任何标志的情况下运行命令,则会收到默认的单击错误消息:

$ mytool

Usage: mytool [OPTIONS] <analysis directory>

Error: Missing argument "analysis_dir".

这很好,但我非常想告诉(非常)新手用户使用help标志可以获得更多帮助.换句话说,当命令无效时,向错误消息添加自定义句子,告诉人们尝试mytool --help获取更多信息.

是否有捷径可寻？我知道我可以删除required属性并在main函数中处理这个逻辑,但是对于这样一个小的添加感觉有点hacky.

Answer 1

python-click 中大多数错误的消息构造是由UsageError 类的 show 方法处理的：click.exceptions.UsageError.show。

因此，如果您重新定义此方法，您将能够创建自己的自定义错误消息。下面是一个自定义示例，它将帮助菜单附加到回答此问题的任何错误消息中：

def modify_usage_error(main_command):
    '''
        a method to append the help menu to an usage error

    :param main_command: top-level group or command object constructed by click wrapper 
    :return: None
    '''

    from click._compat import get_text_stderr
    from click.utils import echo
    def show(self, file=None):
        import sys
        if file is None:
            file = get_text_stderr()
        color = None
        if self.ctx is not None:
            color = self.ctx.color
            echo(self.ctx.get_usage() + '\n', file=file, color=color)
        echo('Error: %s\n' % self.format_message(), file=file, color=color)
        sys.argv = [sys.argv[0]]
        main_command()

    click.exceptions.UsageError.show = show

定义主命令后，您就可以运行修改器脚本：

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

modify_usage_error(cli)

除了使用错误之外，我还没有探索是否存在 ClickException 的运行时调用。如果有，那么您可能需要修改自定义错误处理程序，以便在添加该行之前首先检查 ctx 是否是一个属性，click.exceptions.ClickException.show = show因为在初始化时似乎没有将 ClickException 提供给 ctx。