Python argparse：サブラインにヘルプテキストを挿入するには？

Question

この質問はquestion asked earlierに関連していますが、無関係かもしれません。問題は、下の与えられた（動作中の）例のヘルプテキストに改行をどのように使うのですか？

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()方法はargparse.ArgumentParser()と同じArgumentParserコンストラクタ引数を取ります。したがって、サブパーサーにRawTextHelpFormatterを使用するには、サブパーサーを追加するときに明示的にformatter_classを設定する必要があります。

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

変更subparserの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