Python argparse如何为子命令的-h帮助添加自定义描述内容

在使用add_parser创建子命令解析器时，额外传入description参数，参数值填入你需要展示的自定义描述文本即可。

修改后的完整代码如下：

#!/usr/bin/env python3

import argparse

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(help='子命令帮助说明')

# 创建子命令解析器，新增description参数填入自定义功能描述
parser_a = subparsers.add_parser(
    'do-stuff',
    help='do-stuff 子命令的帮助说明',
    description='该子命令可以实现非常棒的功能'
)

args = parser.parse_args()

修改后执行./arg_test.py do-stuff -h，输出效果如下：

usage: arg_test.py do-stuff [-h]

该子命令可以实现非常棒的功能

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

如果需要保留英文描述，直接把description的参数值改为你需要的英文文本即可。

内容的提问来源于stack exchange，提问作者dariober