argparse
underを使用してpython3
、サブパーサーのヘルプ テキストとサブサブパーサーのヘルプ テキストをカスタマイズした方法で設定しようとしています。次のサンプル プログラムは、私の問題を示しています (サンプル プログラムのソース コードは、このメッセージの下部に表示されます)。このサンプル プログラムは、次のように実行する必要があります。
argtest cmd [ ... args ... ]
または
argtest special subcmd [ ... args ... ]
、「cmd」は「cmd00」、「cmd01」など、「subcmd」は「sub00」、「sub01」などです。
のように実行するとargtest cmd00 -h
、「cmd00」コマンドの特定のヘルプが表示されます。のように実行するとargtest special sub00 -h
、「sub00」特殊コマンドの特定のヘルプが表示されます。
ただし、これらのヘルプ値が得られません。以下のコードを考えると、このコマンドを実行すると:
% argtest special -h
...次の出力が得られます。
usage: argtest (toplevel) special [-h] [--debug] {sub00,sub01} ...
positional arguments:
{sub00,sub01}
sub00 sub00 toplevel help
sub01 sub01 toplevel help
optional arguments:
-h, --help show this help message and exit
--debug
ただし、私が欲しいのは次のとおりです。
special toplevel help
positional arguments:
{sub00,sub01}
sub00 sub00 toplevel help
sub01 sub01 toplevel help
optional arguments:
-h, --help show this help message and exit
--debug
同様に、これを実行すると:
% argtest special sub00 -h
...次の出力が得られます。
usage: argtest (toplevel) special sub00 [-h] [--debug] [--sub0 SUB0]
optional arguments:
-h, --help show this help message and exit
--debug
--sub0 SUB0 sub0-help
しかし、私はこれが欲しい:
sub00 toplevel help
optional arguments:
-h, --help show this help message and exit
--debug
--sub0 SUB0 sub0-help
下位レベルのヘルプ値が無視されるようで、ヘルプは常に最上位レベルのデフォルト ヘルプを使用するように強制され、すべてのサブパーサーのヘルプが生成されます。
サブパーサーのネストされたサブサブパーサーを使用している場合、必要なヘルプ メッセージを取得する方法はありますか? どうもありがとうございました。
サンプルプログラムは次のとおりです。
#!/usr/bin/python3
import os
import sys
import argparse
prog = None
def main():
parser = argparse.ArgumentParser(usage=f'{prog} (toplevel)')
parser.add_argument(
'--verbose',
dest='VERBOSE',
action='store_true',
help='verbose output'
)
globalopts = argparse.ArgumentParser(add_help=False)
globalopts.add_argument(
'--debug',
dest='DEBUG',
action='store_true'
)
command = parser.add_subparsers(
dest='CMD',
help=f'{prog} CMD [ ... args ... ]'
)
command_00 = command.add_parser('cmd00',
parents=[globalopts], help='cmd00 toplevel help')
command_00.add_argument('--a', dest='A',
default=None, required=0, help='cmd00-a-help')
command_01 = command.add_parser('cmd01',
parents=[globalopts], help='cmd01 toplevel help')
command_01.add_argument('--b', dest='B',
default=None, required=0, help='cmd00-b-help')
# etc. ... lots of others, up to up to command_99
special = command.add_parser('special',
parents=[globalopts], add_help='special toplevel help')
subparsers = special.add_subparsers(dest='SUBPARSERS')
special_00 = subparsers.add_parser('sub00',
parents=[globalopts], help='sub00 toplevel help')
special_00.add_argument('--sub0', dest='SUB0',
default=None, required=0, help='sub0-help')
special_01 = subparsers.add_parser('sub01',
parents=[globalopts], help='sub01 toplevel help')
special_01.add_argument('--sub1', dest='SUB1',
default=None, required=0, help='sub1-help')
args, unknowns = parser.parse_known_args()
print(f'args={vars(args)}')
return 0
if __name__ == '__main__':
prog = os.path.basename(sys.argv[0])
sys.exit(main())