如何让Typer同时支持短选项-h与长选项--help输出帮助文本?
给Typer CLI添加-h短帮助选项的方法
没错,你需要给--help设置-h别名,具体操作很简单,在初始化Typer实例时通过context_settings参数配置即可:
- 全局配置(所有命令和子命令都会生效):
在创建Typer app的时候,传入context_settings字典,指定help_option_names为包含--help和-h的列表,示例代码如下:import typer # 初始化app时配置帮助选项别名 app = typer.Typer(context_settings={"help_option_names": ["--help", "-h"]}) @app.command() def greet(name: str): typer.echo(f"Hi, {name}!") if __name__ == "__main__": app()
这样配置后,不管是执行python your_script.py --help还是python your_script.py -h,都会正常显示帮助文本。如果有子命令,子命令也会自动继承这个设置,不用单独给每个子命令配置。
内容的提问来源于stack exchange,提问作者Cornelius Roemer
相关产品推荐
相关产品推荐

