如何在Python Click库中传递自定义类型作为命令行参数

核心问题：命令行传入的所有参数默认都是字符串类型，无法直接对应自定义的Param dataclass实例，需要额外添加解析逻辑，以下是两种常用可行方案：

方案1：通过JSON字符串传参（保留单--param参数的写法） #

第一步：修改cli.py代码 #

修正原代码的导入错误、添加JSON解析逻辑、补充参数类型校验：

import click
import json
# 替换为你实际定义Param和MyClass的模块名
from your_module import Param, MyClass

@click.command(name="run")
# 默认传空JSON，自动使用Param的默认值
@click.option("--param", required=False, default="{}", help="Param类的JSON格式配置，示例：{\"param1\": 1.5, \"param2\": 25}")
# 用Click内置的BOOL类型自动处理布尔值转换，也支持--no-plot直接传参
@click.option("--plot", required=False, type=click.BOOL, default=True)
def run(param, plot):
    # 解析JSON字符串为字典，解包构造Param实例
    param_dict = json.loads(param)
    param_instance = Param(**param_dict)
    myclass = MyClass(param_instance, plot)
    myclass.run()

if __name__ == "__main__":
    run()

第二步：终端调用方式 #

• Linux/Mac 环境：

run --param '{"param1": 1.5, "param2": 30}' --plot True

如果要使用Param的默认值，直接不传--param参数即可。

• Windows 环境（引号转义规则不同）：

run --param "{\"param1\": 1.5, \"param2\": 30}" --plot True

方案2：拆分Param字段为独立参数（更友好的交互方式） #

如果不想让用户手动写JSON，可以把Param的两个字段拆成单独的命令行参数，无需传--param：

cli.py修改后代码： #

import click
from your_module import Param, MyClass

@click.command(name="run")
@click.option("--param1", required=False, type=float, default=5, help="对应Param.param1，默认值5")
@click.option("--param2", required=False, type=int, default=20, help="对应Param.param2，默认值20")
@click.option("--plot", required=False, type=click.BOOL, default=True)
def run(param1, param2, plot):
    param_instance = Param(param1=param1, param2=param2)
    myclass = MyClass(param_instance, plot)
    myclass.run()

if __name__ == "__main__":
    run()

终端调用方式： #

run --param1 1.5 --param2 30 --plot True

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