如何隐藏 argparse 中 --help 选项在帮助文本中的自我描述

风强同学_7504

风强同学_7504

2026-07-05

638人浏览

原创

如何隐藏 argparse 中 --help 选项在帮助文本中的自我描述

通过 add_help=False 并手动添加一个 action="help" 且 help=argparse.SUPPRESS 的参数,可使 -h/--help 功能正常工作,同时不在帮助输出中显示该选项本身。

通过 `add_help=false` 并手动添加一个 `action="help"` 且 `help=argparse.suppress` 的参数,可使 `-h`/`--help` 功能正常工作,同时不在帮助输出中显示该选项本身。

默认情况下,argparse.ArgumentParser(add_help=True) 会自动添加 -h/--help 参数,并在运行 --help 时将其自身也列在帮助文本末尾(如 --help show this help message and exit)。若希望保留帮助功能但不显示该帮助选项的说明行,不能简单使用 add_help=False 后放任不管——否则 --help 将失效,甚至因缺少必需参数而直接报错(如示例中提示 the following arguments are required: --bar)。

正确做法是:禁用自动帮助机制,再显式注册一个被抑制显示的帮助参数。关键在于使用 action="help"(它触发内置帮助逻辑)配合 help=argparse.SUPPRESS(它从帮助文本中完全隐藏该参数的描述):

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser(add_help=False)
    parser.add_argument('-h', '--help', action='help', help=argparse.SUPPRESS)
    parser.add_argument('--bar', type=str, required=True, help='the bar value')

    args = parser.parse_args()

✅ 运行 python script.py --help 时:

剪映专业版
剪映专业版

剪映专业版是一款面向短视频和专业创作场景的 AI 视频剪辑工具。

下载
  • 正常打印完整帮助信息(含 --bar 描述、usage、description 等);
  • 不出现 -h, --help show this help message and exit 这一行;
  • -h 和 --help 均仍可触发帮助输出。

⚠️ 注意事项:

  • action='help' 是特殊动作,无需 nargs 或 type,调用即退出并打印帮助;
  • help=argparse.SUPPRESS 必须显式指定,仅 add_help=False 不足以实现目标;
  • 不要将 --help 与其他 store_* 类动作混用,否则行为不可预测;
  • 此方法兼容 Python 3.7+,包括问题中提到的 3.10 版本。

总结:这是 argparse 官方支持的“隐藏帮助参数自身描述”的标准方案,兼顾功能完整性与输出简洁性,适用于 CLI 工具专业发布场景。

相关文章

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

3744

7

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

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

2023.07.31

1589

3

python教程
python教程

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

2023.08.03

21457

23

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

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

2023.08.04

2647

5

python eval
python eval

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

2023.08.04

2707

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

2083

5

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.2万人学习