如何让typer接受短的"-h"和长的"-help"来输出帮助文本

Question

开箱即用，Typer CLI只识别长帮助选项--help以显示帮助文本。

我也想接受短选项-h，但我不知道怎么做。我查了一下那些文件，但没有结果。

我需要将-h别名为--help吗？如果需要，我该怎么做？

Answer 1

关键是使用context_settings={"help_option_names": ["-h", "--help"]})

正如@jvx8ss在评论中所建议的那样，需要将typer.run应用程序转换为使用@app.command()装饰器的应用程序。

下面是一个最小的工作示例：

import typer
app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})

@app.command()
def main(name: str):
print(f"Hello {name}")

if __name__ == "__main__":
app()