对 argparse 子命令的更好帮助答案

【问题标题】：Better help for argparse subcommands对 argparse 子命令的更好帮助
【发布时间】：2021-11-14 13:04:09
【问题描述】：

给定以下代码sn-p：

import argparse
import sys

parser = argparse.ArgumentParser()

subparsers = parser.add_subparsers(help="subcommand help")

command1 = subparsers.add_parser("foo", description="Run foo subcommand")
command2 = subparsers.add_parser("bar", description="Run bar subcommand")
opts = parser.parse_args(sys.argv[1:])

当我为此打印帮助时，我得到以下信息：

usage: test.py [-h] {foo,bar} ...

positional arguments:
  {foo,bar}   subcommand help

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

有没有办法让它打印这样的东西：

usage: test.py [-h] {foo,bar} ...

subcommands:
  foo         Run foo subcommand
  bar         Run bar subcommand

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

不提供自定义格式化程序？如果我更改格式化程序，那么它也会更改有关如何打印帮助的所有其他内容，但在我的情况下，我只想更改从父（子）命令打印子命令帮助的方式。

【问题讨论】：

我发现click 对用户更加友好
我也很喜欢Typer'CLI 的 fastAPI'。

标签： python argparse

【解决方案1】：

您需要设置help parameter，而不是description parameter，以获得您想要的输出：

import argparse
import sys

parser = argparse.ArgumentParser()

subparsers = parser.add_subparsers(help="subcommand help")

command1 = subparsers.add_parser("foo", help="Run foo subcommand")
command2 = subparsers.add_parser("bar", help="Run bar subcommand")
opts = parser.parse_args(sys.argv[1:])

输出：

usage: test.py [-h] {foo,bar} ...

positional arguments:
  {foo,bar}   subcommand help
    foo       Run foo subcommand
    bar       Run bar subcommand

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

argparse 文档对帮助值有这样的说法：

帮助值是一个包含参数简要描述的字符串。当用户请求帮助时（通常在命令行中使用 -h 或 --help），这些帮助描述将与每个参数一起显示。

关于描述值：

该参数简要描述了程序的作用和工作方式。在帮助消息中，描述显示在命令行使用字符串和各种参数的帮助消息之间。

【讨论】：