如何为click库的option选项设置重命名的参数接收变量
Click选项自定义接收变量名解决方案
Click原生支持为命令行选项指定和选项名不同的接收变量,不需要使用不存在的alias参数,有两种常用实现方式:
方式1:位置参数指定变量名
在@click.option的位置参数中,除了带--前缀的选项声明外,额外传入一个不带横杠的字符串,即可直接指定对应的接收变量名:
@click.command() @click.option( "--all", "use_all", # 此处为指定的接收变量名 is_flag=True, help="This will use all of it.", ) def mycode(use_all): # 业务逻辑 ...
方式2:显式使用dest参数声明
如果需要更清晰的语义,可以用dest参数显式声明接收变量名:
@click.command() @click.option( "--all", is_flag=True, dest="use_all", # 显式指定接收参数的变量名 help="This will use all of it.", ) def mycode(use_all): # 业务逻辑 ...
补充说明
- 两种方式效果完全一致,都可以完美避免参数名和Python内置函数、保留关键字冲突的问题
- 修改后命令行调用方式不变,仍然通过传入
--all来设置该标志位 - 你之前尝试使用的
alias参数是用于定义命令的别名,不属于@click.option的有效参数,因此无法实现需求
内容的提问来源于stack exchange,提问作者Alex
相关产品推荐
相关产品推荐

