如何判断Click框架中flag是用户传入还是默认值？

一、判断参数的True是默认值还是用户传入的 #

Click没有直接提供判断参数是否被用户显式传入的方法，但可以通过设置特殊默认值实现：

1. 给参数的default设一个唯一的特殊对象（比如object()），而非直接设True
2. 在函数内判断参数值是否等于这个特殊对象：
   • 相等则说明是使用默认值
   • 不等则说明是用户显式传入的（无论传的是-f还是-F）

示例代码：

import click

# 定义唯一的默认标记
DEFAULT_FLAG = object()

@click.command()
@click.option('-f/-F', 'var', default=DEFAULT_FLAG)
def main(var):
    if var is DEFAULT_FLAG:
        # 应用默认值
        var = True
        print("var是默认设置的True")
    else:
        print(f"var是用户传入的，值为{var}")
    click.echo(var)

if __name__ == '__main__':
    main()

测试效果：

• 直接运行脚本：输出var是默认设置的True和True
• 运行python script.py -f：输出var是用户传入的，值为True和True
• 运行python script.py -F：输出var是用户传入的，值为False和False

二、实现多flag需求：无传入时全True，传入至少一个时仅传入的为True #

结合特殊默认值和参数状态检查即可实现，步骤如下：

1. 给所有flag参数设置同一个特殊默认标记
2. 在函数内收集所有flag的状态，判断是否有参数被用户显式传入
3. 根据判断结果赋值：
   • 无任何参数传入：所有flag设为True
   • 有参数传入：仅保留用户传入的参数值，其余未传入的设为False

示例代码（以3个flag为例）：

import click

DEFAULT_FLAG = object()

@click.command()
@click.option('-f/-F', 'flag_f', default=DEFAULT_FLAG)
@click.option('-g/-G', 'flag_g', default=DEFAULT_FLAG)
@click.option('-h/-H', 'flag_h', default=DEFAULT_FLAG)
def main(flag_f, flag_g, flag_h):
    # 收集所有flag的键值对
    flags = {
        'flag_f': flag_f,
        'flag_g': flag_g,
        'flag_h': flag_h
    }
    # 判断是否存在用户传入的flag
    has_user_input = any(val is not DEFAULT_FLAG for val in flags.values())
    
    if not has_user_input:
        # 无输入时全设为True
        flag_f = flag_g = flag_h = True
        print("无用户传入flag，所有flag设为True")
    else:
        # 有输入时，未传入的flag设为False
        for name, val in flags.items():
            if val is DEFAULT_FLAG:
                locals()[name] = False
        print("有用户传入flag，仅传入的flag保留原值，其余设为False")
    
    # 输出最终结果
    click.echo(f"flag_f: {flag_f}, flag_g: {flag_g}, flag_h: {flag_h}")

if __name__ == '__main__':
    main()

测试效果：

• 直接运行脚本：输出无用户传入flag，所有flag设为True和flag_f: True, flag_g: True, flag_h: True
• 运行python script.py -f -G：输出有用户传入flag，仅传入的flag保留原值，其余设为False和flag_f: True, flag_g: False, flag_h: False
• 运行python script.py -H：输出有用户传入flag，仅传入的flag保留原值，其余设为False和flag_f: False, flag_g: False, flag_h: False

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