如何自定义Click框架默认--help选项的提示文本

click.command 没有提供直接覆盖默认帮助提示文本 "Show this message and exit" 的内置配置参数，可通过以下两种方案实现自定义效果：

方案一：替换默认自动生成的帮助选项 #

这是最轻量的实现方式，先关闭Click自动添加帮助选项的默认逻辑，再手动声明帮助选项并传入自定义提示文本，同时支持自定义帮助参数的触发名称：

import click

# 关闭默认帮助选项，手动添加自定义配置的帮助选项
@click.command(add_help_option=False)
@click.help_option('-h', '--help', help='查看命令使用指南后退出程序')
def main():
    click.echo('运行成功！')

if __name__ == '__main__':
    main()

携带--help参数运行的输出效果如下：

$ python file.py --help
Usage: file.py [OPTIONS]

Options:
  -h, --help  查看命令使用指南后退出程序

如果是对命令组做配置，只需要把相同的参数加在@click.group装饰器上，组下所有子命令会自动继承该配置。

方案二：自定义命令基类实现全局统一配置 #

如果项目中存在大量命令，不想逐个给每个命令加装饰器配置，可以自定义继承click.Command的基类，重写帮助选项的生成逻辑，所有使用该基类的命令都会自动应用自定义的帮助提示：

import click

class CustomCmd(click.Command):
    def add_help_option(self, ctx):
        # 统一配置所有命令的帮助提示文本
        help_opt = click.help_option(
            *ctx.help_option_names,
            help='显示命令帮助信息并退出'
        )
        self.params.append(help_opt(self))

# 所有命令指定cls参数使用自定义基类即可
@click.command(cls=CustomCmd)
def main():
    click.echo('运行成功！')

if __name__ == '__main__':
    main()

提示：不建议通过直接修改Click安装包源码的方式修改提示文本，会导致项目依赖不可控，后续升级Click版本后自定义配置会直接失效。

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