
通过 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 时:
- 正常打印完整帮助信息(含 --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 工具专业发布场景。











