argparse 子解析器 --help 输出不显示子解析器的描述

Question

如果我使用特定的帮助字符串创建子解析器，则当用户运行myprog command --help时不会显示此字符串：

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(help="sub-command help")
parser_command = subparsers.add_parser("command", help="Issue a command")
parser.parse_args()

顶级帮助显示此command子命令，旁边有"发出命令"的描述：

$ python prog.py --help
usage: prog.py [-h] {command} ...
positional arguments:
{command}   sub-command help
command   Issue a command
optional arguments:
-h, --help  show this help message and exit

但是，子命令的帮助不显示以下描述：

$ python prog.py command --help
usage: prog.py command [-h]
optional arguments:
-h, --help  show this help message and exit

我期望的是子命令的帮助打印出子命令的实际用途。 即我希望在输出中的某处看到文本"发出命令"以python prog.py command --help.

有没有办法将此文本包含在子命令的帮助输出中？是否有另一个子解析器属性可用于提供子命令的描述？

Answer 1

add_parser方法接受ArgumentParser构造函数执行的(大多数(参数。

https://docs.python.org/3/library/argparse.html#sub-commands

在add_subparsers段中很容易忽略这句话：

此对象具有单个方法 add_parser((，该方法采用命令名称和任何 ArgumentParser 构造函数参数，并返回一个可以照常修改的 ArgumentParser 对象。

In [93]: parser=argparse.ArgumentParser()
In [94]: sp = parser.add_subparsers(dest='cmd',description='subparses description')
In [95]: p1 = sp.add_parser('foo',help='foo help', description='subparser description')
In [96]: p1.add_argument('--bar');

主解析器的帮助：

In [97]: parser.parse_args('-h'.split())
usage: ipython3 [-h] {foo} ...
optional arguments:
-h, --help  show this help message and exit
subcommands:
subparses description
{foo}
foo       foo help
...

子解析器的帮助：

In [98]: parser.parse_args('foo -h'.split())
usage: ipython3 foo [-h] [--bar BAR]
subparser description
optional arguments:
-h, --help  show this help message and exit
--bar BAR
...