如何在Python的Typer中为命令实现可选的最后参数？

要实现你需要的命令语法（支持带--或不带--的可选最后参数），可以利用Typer基于Click的特性，通过Argument定义可变长度的位置参数，结合nargs=-1来捕获任意数量的剩余参数（包括0个）。

实现代码示例 #

import typer

app = typer.Typer()

@app.command()
def my_app(
    # 必填命名参数，用Option定义
    named_arg1: str = typer.Option(..., help="必填的命名参数"),
    # 可选的最后可变参数，nargs=-1表示接收0个或多个参数
    misc_args: list[str] = typer.Argument(None, nargs=-1, help="可选的杂项参数列表")
):
    typer.echo(f"命名参数1: {named_arg1}")
    typer.echo(f"杂项参数: {misc_args}")

if __name__ == "__main__":
    app()

测试两种语法场景 #

场景1：带--分隔的情况 #

执行命令：

python my_app.py --named_arg1=val1 -- misc_arg1 misc_arg2

输出结果：

命名参数1: val1
杂项参数: ['misc_arg1', 'misc_arg2']

场景2：不带--分隔的情况 #

执行命令：

python my_app.py --named_arg1=val1 misc_arg1 misc_arg2

输出结果和上面完全一致：

命名参数1: val1
杂项参数: ['misc_arg1', 'misc_arg2']

关键说明 #

1. nargs=-1的作用：这个参数告诉Typer/Click，该位置参数可以接收0个或任意多个输入值，自动打包成列表。如果没有输入杂项参数，misc_args会是空列表[]。
2. --的必要性：当杂项参数中包含类似--xxx的字符串时，必须用--分隔，否则解析器会把它当作命名参数处理。比如：

   python my_app.py --named_arg1=val1 -- --fake-option misc_arg
   

   此时misc_args会是['--fake-option', 'misc_arg']，不会被误解析为命名参数。
3. 布尔类型命名参数适配：如果命名参数是布尔flag（比如--verbose），直接在flag后跟上杂项参数也能正常捕获：

   python my_app.py --verbose misc_arg1 misc_arg2
   

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