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的输出中的某处看到文本“发出命令”。

是否可以在子命令的帮助输出中包含此文本？是否有另一个subparser属性可用于提供子命令的描述？

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
...

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

1 个答案: