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

Question

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

./myscript.py -h

谢谢！

杰米

Answer 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)

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

Answer 2

谷歌组的这个线程有以下代码片段，它似乎可以解决问题（略有修改）。

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

Answer 3

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

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

Answer 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

Answer 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://stackoverflow.com/a/60714163/10152015