python argparse:如何在出错时自动显示帮助?

时间:2010-09-03 14:58:40

标签: python argparse

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

./myscript.py -h

谢谢!

杰米

5 个答案:

答案 0 :(得分:29)

要打印帮助,您可能需要在print_help实例

上使用ArgumentParser功能
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)

当此解析器遇到不可解析的参数行时,它将打印帮助。

答案 1 :(得分:15)

Google群组中的thread以上代码片段似乎可以解决这个问题(略有修改)。

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

答案 2 :(得分:1)

我只是使用以下语法解决了同一问题:

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

答案 3 :(得分:0)

禁止使用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

答案 4 :(得分:0)

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

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