如何显示自定义消息而不是 Argparse 生成的默认帮助消息？答案

【问题标题】：How to display a custom message instead of the default help message which Argparse generates?如何显示自定义消息而不是 Argparse 生成的默认帮助消息？
【发布时间】：2019-08-06 05:57:11
【问题描述】：

考虑以下示例代码

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('action', help='Action to take')
parser.add_argument('-b','--bar', help='Description for bar argument')
parser.parse_args()

使用--help 参数调用它的输出可能是这样的：

positional arguments:

action   Action to take


optional arguments:

-h, --help show this help message and exit
-b  --bar  Description for bar argument

我不想要 Argparse 生成的上述默认帮助文本。我想要一个完全由我写的消息

例如，使用--help 参数调用文件应显示以下帮助消息：

Please go to http://some_website.com/help to understand more about our software

那么如何向 Argparse 提供我的自定义消息？

【问题讨论】：

我认为以下链接可能会有所帮助：stackoverflow.com/questions/14591168/…。您可以隐藏不想显示的内容并保留说明。
stackoverflow.com/questions/45806664/…
在默认设置中，-h/--help 调用 parser.print_help() 并退出。 print_help 使用 parser.format_help。您可以自定义这些。来自文档：docs.python.org/3/library/argparse.html#printing-help
stackoverflow.com/questions/33906513/…
另一种选择是在调用parse_args 之前查看sys.argv。如果您看到help（以某种形式）打印消息并退出。

标签： python python-3.x argparse

【解决方案1】：

您需要覆盖print_help() 方法。所以，我创建了一个名为 MyArguementParser 的类，它会覆盖 ArgumentParser，就像这样：

import argparse
import sys as _sys

class MyArgumentParser(argparse.ArgumentParser):

    def print_help(self, file=None):
        if file is None:
            file = _sys.stdout
        message = "Please go to http://some_website.com/help to understand more about our software"
        file.write(message+"\n")

现在，您将调用MyArgumentParser，而不是调用ArgumentParser：

parser = MyArgumentParser() #THIS IS THE ONLY CHANGE YOU NEED TO MAKE
# parser = argparse.ArgumentParser()
parser.add_argument('action', help='Action to take')
parser.add_argument('-b','--bar', help='Description for bar argument')
parser.parse_args()

现在，当您使用 -h 或 --help 标志运行脚本时！

您还可以覆盖print_usage()，以在用户滥用任何提供的参数时显示相同的消息。

【讨论】：