自定义argparse帮助消息

我编写了以下示例代码来演示我的问题。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('-v', '--version', action='version',
                    version='%(prog)s 1.0')
parser.parse_args()

这会产生以下帮助消息。

$ python foo.py --help
usage: foo.py [-h] [-v]

optional arguments:
  -h, --help     show this help message and exit
  -v, --version  show program's version number and exit

我想自定义此帮助输出，使其将所有短语和句子大写，并在句子后面添加句点。换句话说，我希望像这样生成帮助消息。

$ python foo.py --help
Usage: foo.py [-h] [-v]

Optional arguments:
  -h, --help     Show this help message and exit.
  -v, --version  Show program's version number and exit.

这是我可以使用 argparse API 控制的东西吗？如果是这样，怎么办？您能否提供一个小例子来说明如何做到这一点？

首先：将这些短语大写与惯例背道而驰，并且argparse并没有真正的工具来帮助您轻松更改这些字符串。这里有三种不同类别的字符串：来自帮助格式化程序的样板文本、章节标题以及每个特定选项的帮助文本。所有这些字符串都是可本地化的；你could只需通过以下方式为所有这些字符串提供“大写”翻译gettext()模块支持 https://docs.python.org/3/library/gettext.html。也就是说，如果你有足够的决心，你可以伸手替换所有这些字符串稍微阅读一下源代码 https://hg.python.org/cpython/file/3.5/Lib/argparse.py.

The version操作包括默认值help文本，但您可以通过设置来提供自己的文本help争论。这同样适用于help行动;如果你设置add_help争论 https://docs.python.org/3/library/argparse.html#add-help to False您可以手动添加该操作：

parser = argparse.ArgumentParser(add_help=False)

parser.add_argument('-v', '--version', action='version',
                    version='%(prog)s 1.0', help="Show program's version number and exit.")
parser.add_argument('-h', '--help', action='help', default=argparse.SUPPRESS,
                    help='Show this help message and exit.')

接下来，optional arguments消息是一个组标题;每个解析器都有两个默认组，一组用于位置参数，另一组用于可选。您可以通过属性来达到这些_positionals and _optionals，两者都有一个title属性：

parser._positionals.title = 'Positional arguments'
parser._optionals.title = 'Optional arguments'

被警告，通过访问以下划线开头的名称，您正在冒险进入模块的未记录的私有 API，并且您的代码可能会在将来的更新中中断。

最后，要改变usage字符串，您必须对帮助格式化程序进行子类化；将子类作为formatter_class争论 https://docs.python.org/3/library/argparse.html#formatter-class:

class CapitalisedHelpFormatter(argparse.HelpFormatter):
    def add_usage(self, usage, actions, groups, prefix=None):
        if prefix is None:
            prefix = 'Usage: '
        return super(CapitalisedHelpFormatter, self).add_usage(
            usage, actions, groups, prefix)

parser = argparse.ArgumentParser(formatter_class=CapitalisedHelpFormatter)

演示，将这些放在一起：

>>> import argparse
>>> class CapitalisedHelpFormatter(argparse.HelpFormatter):
...     def add_usage(self, usage, actions, groups, prefix=None):
...         if prefix is None:
...             prefix = 'Usage: '
...         return super(CapitalisedHelpFormatter, self).add_usage(
...             usage, actions, groups, prefix)
...
>>> parser = argparse.ArgumentParser(add_help=False, formatter_class=CapitalisedHelpFormatter)
>>> parser._positionals.title = 'Positional arguments'
>>> parser._optionals.title = 'Optional arguments'
>>> parser.add_argument('-v', '--version', action='version',
...                     version='%(prog)s 1.0', help="Show program's version number and exit.")
_VersionAction(option_strings=['-v', '--version'], dest='version', nargs=0, const=None, default='==SUPPRESS==', type=None, choices=None, help="Show program's version number and exit.", metavar=None)
>>> parser.add_argument('-h', '--help', action='help', default=argparse.SUPPRESS,
...                     help='Show this help message and exit.')
_HelpAction(option_strings=['-h', '--help'], dest='help', nargs=0, const=None, default='==SUPPRESS==', type=None, choices=None, help='Show this help message and exit.', metavar=None)
>>> print(parser.format_help())
Usage: [-v] [-h]

Optional arguments:
  -v, --version  Show program's version number and exit.
  -h, --help     Show this help message and exit.