python argparse——自定义错误消息

Question

我想为使用argparse库的命令行程序中的特定使用错误生成自定义错误消息。我知道我可以通过子类化argparse.ArgumentParser:来覆盖错误的一般表示

class HelpParser(argparse.ArgumentParser):
    def error(self, message):
        sys.stderr.write('error: %sn' % message)
        sys.exit(2)
parser = HelpParser(... ...)
args = parser.parse_args()

但是当调用我的error方法时，message已经被库格式化了。例如，

> python prog.py old stuff
usage: prog [-h] {hot,cold,rain,snow} ...
prog: error: argument subparser: invalid choice: 'old' (choose from u'hot', u'cold', u'rain', u'snow')

如何更改error:之后的内容显示方式，例如

usage: prog [-h] {hot,cold,rain,snow} ...
error: 'old' is not a valid option. select from 'hot', 'cold', 'rain', 'snow'

Answer 1

查看源代码，您可以通过重写以下方法来覆盖this particular错误消息：

def _check_value(self, action, value):
    # converted value must be one of the choices (if specified)
    if action.choices is not None and value not in action.choices:
        args = {'value': value,
                'choices': ', '.join(map(repr, action.choices))}
        msg = _('invalid choice: %(value)r (choose from %(choices)s)')
        raise ArgumentError(action, msg % args)

问题是，如果你想覆盖所有可能的错误消息，你基本上必须重写这个模块。所有各种各样的错误消息都是预先格式化的——在检测每种类型错误的各种方法中。

Answer 2

添加到@Gerrat的答案中，_函数被导入为

from gettext import gettext as _, ngettext

它使用CCD_ 8模块，https://docs.python.org/2/library/gettext.html，实现国际化。我不熟悉这个模块，但大概你可以用它来进行一定量的英语转述。但可能没有你想要的那么多。

错误消息通过多个级别。像_check_values这样的函数编写基本消息。ArgumentError添加参数名称（在您的示例中为argument subparser:）。CCD_ 12将CCD_ 13和CCD_。CCD_ 15负责CCD_。

def error(self, message):
    ...
    self.print_usage(_sys.stderr)
    args = {'prog': self.prog, 'message': message}
    self.exit(2, _('%(prog)s: error: %(message)sn') % args)