python argparse：如何在错误时自动显示帮助？

Posted 2023-03-25

【中文标题】python argparse：如何在错误时自动显示帮助？

【英文标题】：python argparse: How can I display help automatically on error?

【发布时间】：2011-04-07 21:49:00

【问题描述】：

目前，当我输入无效选项或省略位置参数时，argparse 会将我踢回提示并显示我的应用程序的使用情况。这没关系，但我宁愿自动显示完整的帮助列表（解释选项等）而不是要求用户输入

./myscript.py -h

谢谢！

杰米

【问题讨论】：

另请参阅此 SO 问题以获取更多信息：[***.com/questions/4042452][1] [1]: ***.com/questions/4042452

【参考方案1】：

要打印您可能想要使用的帮助：ArgumentParser 实例上的 print_help 函数

parser = argparse.ArgumentParser()
(...)
parser.print_help()

要打印错误帮助消息，您需要创建自己的 ArgumentParser 实例的子类，它会覆盖 error() 方法。比如这样：

class MyParser(argparse.ArgumentParser): 
   def error(self, message):
      sys.stderr.write('error: %s\n' % message)
      self.print_help()
      sys.exit(2)

当此解析器遇到无法解析的参数行时，它将打印帮助。

【参考方案2】：

这个thread 在谷歌组有以下代码 sn-p 似乎可以解决问题（稍作修改）。

class DefaultHelpParser(argparse.ArgumentParser):
    def error(self, message):
        sys.stderr.write('error: %s\n' % message)
        self.print_help()
        sys.exit(2)

【讨论】：

在这里使用self.print_help(sys.stderr)不是有意义吗？

如果不是很清楚，你应该在创建这个类之后使用DefaultHelpParser而不是你通常使用的argparse.ArgumentParser

【参考方案3】：

我自己使用以下语法解决了同样的问题：

parser = ArgumentParser()
... add arguments ...
parser.usage = parser.format_help()
args = parser.parse_args()

【参考方案4】：

使用usage=argparse.SUPPRESS 禁止打印使用情况。然后捕获 ArgumentParser 在错误时引发的 SystemExit 异常，打印帮助，然后再次引发异常退出。

parser = argparse.ArgumentParser(usage=argparse.SUPPRESS)
parser.add_argument(...)
try:
    args = parser.parse_args()
except SystemExit:
    parser.print_help()
    raise

【讨论】：

@GerhardBarnard 阅读 :)

【参考方案5】：

您也可以在不使用类或异常的情况下打印帮助：

def _error(parser):
    def wrapper(interceptor):
        parser.print_help()

        sys.exit(-1)

    return wrapper

def _args_get(args=sys.argv[1:]):
    parser = argparser.ArgumentParser()

    parser.error = _error(parser)

    parser.add_argument(...)
    ...

。只需将ArgumentParser.error 函数包装在您的并拦截message 参数即可。我之前回答过：

https://***.com/a/60714163/10152015