0

0

argparse 如何让 --help 显示子命令的自定义描述

舞姬之光

舞姬之光

发布时间:2026-01-26 19:54:01

|

977人浏览过

|

来源于php中文网

原创

子命令 help 不显示是因为 add_parser() 未传 help 参数;需为每个子命令显式指定 help=字符串以控制汇总页说明,再用 description 和 RawDescriptionHelpFormatter 定制详情页格式。

argparse 如何让 --help 显示子命令的自定义描述

子命令 help 描述不显示?检查 help 参数是否传给了 add_parser()

默认情况下,add_subparsers() 创建的子命令解析器不会自动显示描述,除非你在调用 add_parser() 时显式传入 help= 字符串。很多人只给子命令设置了 descriptionepilog,但这些不影响 --help 汇总页里的那一行简短说明。

正确做法是:

  • subparsers = parser.add_subparsers(dest="command")
  • sub_a = subparsers.add_parser("train", help="训练模型(支持 CPU/GPU)") ← 这个 help 才控制汇总页显示
  • sub_a.add_argument("--lr", type=float, default=1e-3)

想让子命令详情页也更友好?用 descriptionformatter_class

子命令自身的 --help(比如运行 python script.py train --help)默认只显示参数,不带顶层描述。要让它显示说明文字,得在 add_parser() 里加 description

sub_a = subparsers.add_parser(
    "train",
    help="训练模型(支持 CPU/GPU)",
    description="使用指定数据集和超参训练深度学习模型,支持断点续训。",
    formatter_class=argparse.RawDescriptionHelpFormatter
)

注意:RawDescriptionHelpFormatter 能保留换行和缩进,否则多行 description 会被压成一行。

避免 help 文本被截断或重复?别在 add_subparsers() 里设 help

add_subparsers() 本身不接受 help 参数 —— 如果你强行写了,argparse 会静默忽略,还可能触发 TypeError: add_subparsers() got an unexpected keyword argument 'help'(取决于 Python 版本)。

ImgGood
ImgGood

免费在线AI照片编辑器

下载

常见误写:

# ❌ 错误:add_subparsers 不吃 help 参数
subparsers = parser.add_subparsers(help="可用操作", dest="command")
<h1>✅ 正确:help 只属于每个子解析器</h1><p>subparsers = parser.add_subparsers(dest="command")

中文 help 显示乱码?确认终端和 Python 文件编码

如果 help 字符串含中文但在终端里显示为 或空格,问题通常不在 argparse,而在环境:

  • Python 源文件开头没加 # -*- coding: utf-8 -*-
  • Windows cmd 默认编码是 gbk,而 Python 3.7+ 的 argparse 内部用 utf-8 渲染 help —— 此时需设置环境变量 chcp 65001 或改用 Windows Terminal / WSL
  • IDE(如 PyCharm)终端编码设置不是 UTF-8

验证方式:打印 sys.stdout.encoding,它应为 utf-8;如果不是,help 中文基本注定显示异常。

子命令 help 的定制关键就两点:每个 add_parser() 必须带 help=,且描述性文字要靠 description + 合适的 formatter_class 控制格式。漏掉前者,汇总页就空着;忽略后者,子命令详情页就干巴巴。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
css中float用法
css中float用法

css中float属性允许元素脱离文档流并沿其父元素边缘排列,用于创建并排列、对齐文本图像、浮动菜单边栏和重叠元素。想了解更多float的相关内容,可以阅读本专题下面的文章。

595

2024.04.28

C++中int、float和double的区别
C++中int、float和double的区别

本专题整合了c++中int和double的区别,阅读专题下面的文章了解更多详细内容。

108

2025.10.23

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1570

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

651

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1229

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1205

2024.04.29

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号