如何在 argparse 中显示所有子解析器的帮助？

Question

我做了一个 Python 脚本，它做了很多动作，所以它有很多选项，所以我把它分成了子解析器，这些子解析器也使用父解析器进行常见的选项分组。

我想要一个帮助选项来显示所有命令及其选项的帮助，是否可以不覆盖 format_help 方法？

我看到了similar question，但分组对我来说并不重要，我只想要那里的选项。

例如：

general_group = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter,add_help=False)
general_group.add_argument('--threads', action='store_true', default=False)
second_group = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter,add_help=False)
second_group.add_argument('--sleep', action='store', default=60, type=int)
parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)
subparsers=parser.add_subparsers(dest='action')
subparsers.add_parser('Restart',parents=[general_group,second_group])
subparsers.add_parser('Start',parents=[general_group])

args = parser.parse_args()

在这种情况下，如果有人运行 ./script.py -h，我希望他们会在帮助中看到线程选项。

Answer 1

问题在于：

subparsers=parser.add_subparsers(dest='action')
subparsers.add_parser('Restart',parents=[general_group,second_group])
subparsers.add_parser('Start',parents=[general_group])

您将general_group 作为父级添加到子解析器，因此主解析器不知道它们，这导致./script.py -h 不显示--threads。如果您打算将其作为所有子解析器的父级，那么您应该将其作为顶级解析器父级：

parser = argparse.ArgumentParser(parents=[general_group])
subparsers=parser.add_subparsers(dest='action')
subparsers.add_parser('Restart',parents=[second_group])
subparsers.add_parser('Start')

结果：

$ python script.py -h
usage: script.py [-h] [--threads] {Restart,Start} ...

positional arguments:
  {Restart,Start}

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

但请注意，在这种情况下，该选项仅是父解析器的一部分，而不是子解析器的一部分，这意味着：

$python script.py --threads Start

是正确的，而：

$ python script.py Start --threads
usage: script.py [-h] [--threads] {Restart,Start} ...
script.py: error: unrecognized arguments: --threads

因为--threads 没有被子解析器“继承”。如果您想在子解析器中也有--threads，则必须在其parents 参数中指定它：

parser = argparse.ArgumentParser(parents=[general_group])
subparsers=parser.add_subparsers(dest='action')
subparsers.add_parser('Restart',parents=[general_group, second_group])
subparsers.add_parser('Start', parents=[general_group])

这应该做你想做的：

$ python script.py -h
usage: script.py [-h] [--threads] {Restart,Start} ...

positional arguments:
  {Restart,Start}

optional arguments:
  -h, --help       show this help message and exit
  --threads
$ python script.py Start -h
usage: script.py Start [-h] [--threads]

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