如何隐藏 argparse 帮助信息中的 -h 和 --help 自身描述

老萱吖_5650

老萱吖_5650

2026-07-05

809人浏览

原创

通过 argparse.SUPPRESS 配合 action="help",可在保留 -h/--help 功能的同时,彻底从帮助文本中移除其自身条目,避免冗余显示。

通过 `argparse.suppress` 配合 `action="help"`,可在保留 `-h`/`--help` 功能的同时,彻底从帮助文本中移除其自身条目,避免冗余显示。

在使用 Python 的 argparse 模块构建命令行工具时,一个常见需求是:希望 --help 选项能正常触发帮助输出,但又不希望帮助文本中出现对 --help 自身的说明(例如 --help show this help message and exit 这一行)。默认行为会将 --help 作为普通参数列出,造成语义循环和视觉干扰。

直接设置 add_help=False 并不可行——它会完全禁用帮助机制,导致调用 --help 时抛出 error: unrecognized arguments: --help 或如示例中因必选参数缺失而报错,而非显示预期的帮助信息。

正确解法是显式添加帮助参数,并将其 help 属性设为 argparse.SUPPRESS,同时指定 action="help"。这样既保留了内置的帮助逻辑(自动打印用法、参数说明并退出),又让该参数在帮助文本中“隐形”。

以下是完整可运行示例:

大饼AI变声
大饼AI变声

大饼AI变声是一款AI音频处理工具,免费专业的AI变声软件,一键实时语音变声。

下载
import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser(add_help=False)  # 关闭自动添加 help 参数
    parser.add_argument("-h", "--help", action="help", help=argparse.SUPPRESS)
    parser.add_argument("--bar", type=str, required=True, help="the bar value")
    parser.add_argument("--verbose", action="store_true", help="enable verbose output")

    args = parser.parse_args()

✅ 运行效果:

  • 执行 python script.py --help → 显示完整帮助文本,不含 -h, --help 行
  • 执行 python script.py -h → 同样生效,且支持短选项;
  • 所有其他参数(如 --bar, --verbose)的说明均正常显示。

⚠️ 注意事项:

  • 必须同时指定 action="help" 和 help=argparse.SUPPRESS,缺一不可;
  • add_help=False 是前提,否则 argparse 会重复添加冲突的 --help;
  • argparse.SUPPRESS 是唯一被官方支持用于隐藏帮助项的值,不要用空字符串或 None;
  • 此方法兼容 Python 3.7+,包括问题中提到的 3.10 版本。

该方案简洁、稳定、无副作用,是官方推荐的定制化帮助输出方式。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1571

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

3724

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1569

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

21317

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2627

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2687

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1083

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

576

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2063

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.1万人学习