如何将filename2与data_var2定义为Python函数的可选参数？

我尝试查找类似问题的解决方案，但无法将现有答案应用到当前场景。我有一个Python函数，接收data_dir、filename、data_var及**kwargs参数，默认读取data_dir/filename路径下文件中的data_var数据。现在希望添加filename2和data_var2作为可选参数，当kwargs中的lflag设为True时，需读取这两个参数对应的额外数据进行计算，但不清楚如何将filename2和data_var2定义为可省略的可选参数。

原函数定义：

def function(data_dir, filename, data_var, **kwargs):
    # some code

我尝试修改后的函数（存在问题，filename2和data_var2变成了必传参数）：

def function(data_dir, filename, data_var, filename2, data_var2, **kwargs):
  
    # default flag
    opt_dic = {"lflag"  : False}

    for key in kwargs:
        opt_dic[key] = kwargs[key]

    # load in filename and read data_var
    ds = Dataset(data_dir + filename)
    var = ds.variables[data_var][...]
    ds.close()

    # load in filename2 and read data_var2
    if opt_dic["lflag"]:
        ds2 = Dataset(data_dir + filename2)
        var2 = ds2.variables[data_var2][...]
        ds2.close()

    # some more code

原默认调用方式：

kwargs = {}
output = function(data_dir, filename, data_var, **kwargs)

期望的带额外数据的调用方式：

kwargs = {"lflag" : True}
output = function(data_dir, filename, data_var, filename2, data_var2, **kwargs)

解决方案 #

方法一：给可选参数设置默认值 #

将filename2和data_var2设为可选参数，默认值设为None，同时在lflag=True时校验参数是否传入：

def function(data_dir, filename, data_var, filename2=None, data_var2=None, **kwargs):
    # 合并默认配置与传入的kwargs（替代循环更简洁）
    opt_dic = {"lflag": False}
    opt_dic.update(kwargs)

    # 读取主数据
    ds = Dataset(data_dir + filename)
    var = ds.variables[data_var][...]
    ds.close()

    # 读取额外数据（仅当lflag为True且参数齐全时）
    var2 = None
    if opt_dic["lflag"]:
        if filename2 is None or data_var2 is None:
            raise ValueError("当lflag设为True时，必须传入filename2和data_var2参数")
        ds2 = Dataset(data_dir + filename2)
        var2 = ds2.variables[data_var2][...]
        ds2.close()

    # 后续处理逻辑
    # some more code

调用方式：

• 默认调用（无需额外参数）：

output = function(data_dir, filename, data_var)
# 或保留原有kwargs写法
kwargs = {}
output = function(data_dir, filename, data_var, **kwargs)

• 带额外数据的调用：

# 直接传入参数
output = function(data_dir, filename, data_var, filename2="file2.nc", data_var2="var2", lflag=True)
# 或用kwargs传递lflag
kwargs = {"lflag": True}
output = function(data_dir, filename, data_var, "file2.nc", "var2", **kwargs)

方法二：将可选参数放入kwargs中 #

如果不想修改原有位置参数结构，可以把filename2和data_var2整合到kwargs里，天然实现可选性：

def function(data_dir, filename, data_var, **kwargs):
    # 合并默认配置与传入的kwargs
    opt_dic = {"lflag": False, "filename2": None, "data_var2": None}
    opt_dic.update(kwargs)

    # 读取主数据
    ds = Dataset(data_dir + filename)
    var = ds.variables[data_var][...]
    ds.close()

    # 读取额外数据
    var2 = None
    if opt_dic["lflag"]:
        filename2 = opt_dic["filename2"]
        data_var2 = opt_dic["data_var2"]
        if filename2 is None or data_var2 is None:
            raise ValueError("当lflag设为True时，必须在kwargs中传入filename2和data_var2")
        ds2 = Dataset(data_dir + filename2)
        var2 = ds2.variables[data_var2][...]
        ds2.close()

    # 后续处理逻辑
    # some more code

调用方式：

• 默认调用：

output = function(data_dir, filename, data_var)

• 带额外数据的调用：

kwargs = {
    "lflag": True,
    "filename2": "file2.nc",
    "data_var2": "var2"
}
output = function(data_dir, filename, data_var, **kwargs)

方案对比 #

• 方法一参数直观，IDE能自动提示参数，适合需要明确参数的场景；
• 方法二更灵活，不改变原有函数参数结构，适合保持代码兼容性的场景；
• 两种方案都需要在lflag=True时做参数校验，避免因缺失参数导致运行错误。

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