来自文本文件的 Argparse 自定义帮助

我想使用 argparse 库，因为它的灵活性，但我在禁用默认帮助对话框以显示文本文件中的自定义帮助对话框时遇到问题。我想做的就是在传递“-h”或“--help”选项时显示文本文件中的文本。这是我如何尝试的示例：

parser = argparse.ArgumentParser(add_help=False)
parser.add_argument("file", type=str, nargs='+')
parser.add_argument("-xmin", type=float)
parser.add_argument("-xmax", type=float)
parser.add_argument("-ymin", type=float)
parser.add_argument("-ymax", type=float)
parser.add_argument("-h", "--help", action="store_true")

args = parser.parse_args()

if args.help is True:
    print isip_get_help()
    exit(-1)

但它仍然输出：

nedc_[1]: python isip_plot_det.py -h
usage: isip_plot_det.py [-xmin XMIN] [-xmax XMAX] [-ymin YMIN] [-ymax YMAX]
                        [-h]
                        file [file ...]
isip_plot_det.py: error: too few arguments

有任何想法吗？

您收到的是错误消息，而不是帮助（即它不是由您的-h).

isip_plot_det.py: error: too few arguments

错误消息显示了正常帮助的用法部分。你可以用一个来改变它usage范围：

parser = ArgumentParser(usage = 'my custom usage line')

您还可以使用以下命令测试使用情况显示

parser.print_usage()

or

astr = parser.format_usage()

获得可打印的字符串。

正常的help参数使用特殊的help动作类。它是call方法是：

def __call__(self, parser, namespace, values, option_string=None):
    parser.print_help()
    parser.exit()

请注意，它显示的帮助parser.print_help()，然后退出。一旦它解析了，就会发生这种情况-h细绳。这样就不会产生任何错误，例如too few arguments or unrecognized arguments（在解析结束时产生）。

因此，自定义帮助的另一种方法是子类化ArgumentParser，并定义您自己的print_help方法。您还可以自定义exit and error方法。

默认print_help is:

def print_help(self, file=None):
    if file is None:
        file = sys.stdout
    self._print_message(self.format_help(), file)

您可以定制format_help反而。

 class MyParser(argparse.ArgumentParser):
     def format_help(self):
         return 'my custom help message\n   second line\n\n'

使用示例：

In [104]: parser=MyParser(usage='custom usage')
In [105]: parser.parse_args(['-h'])
my custom help message
   second line
   ...

In [106]: parser.parse_args(['unknown'])
usage: custom usage
ipython3: error: unrecognized arguments: unknown
...