python - Python argparse：如何在 subparser 中插入换行符帮助文本？

Question

这个问题与之前提出的问题有关，但可能无关。问题是：在使用子解析器时，如何在下面给定（工作）示例中的帮助文本中使用换行符？

import argparse

parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)

subparsers = parser.add_subparsers()

parser_start = subparsers.add_parser('stop')
parser_start.add_argument("file", help = "firstline\nnext line\nlast line")

print parser.parse_args()

我的输出如下：

tester.py  stop -h
usage: tester.py stop [-h] file

positional arguments:
  file        firstline next line last line

optional arguments:
  -h, --help  show this help message and exit

帮助的预期输出file应该是：

first line
next line
last line

Answer 1

该subparsers.add_parser()方法采用与 相同的ArgumentParser构造函数参数argparse.ArgumentParser()。因此，要使用RawTextHelpFormatter子解析器，您需要formatter_class在添加子解析器时显式设置。

>>> import argparse
>>> parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
>>> subparsers = parser.add_subparsers()

更改此行以设置formatter_class子解析器：

>>> parser_start = subparsers.add_parser('stop', formatter_class=argparse.RawTextHelpFormatter)

现在，您的帮助文本将包含换行符：

>>> parser_start.add_argument("file", help="firstline\nnext line\nlast line")
_StoreAction(option_strings=[], dest='file', nargs=None, const=None, default=None, type=None, choices=None, help='firstline\nnext line\nlast line', metavar=None)

>>> print parser.parse_args(['stop', '--help'])
usage:  stop [-h] file

positional arguments:
  file        firstline
              next line
              last line

optional arguments:
  -h, --help  show this help message and exit