乐趣区

当心Python函数可变默认参数(list,set,dict…)的陷阱

绝大多数情况下,Python 是一个干净具有一致性的语言。然而,有些少数情况会让初学者感到困惑。其中有些情况是有意识的但会成为潜在的莫名其妙,而有些可以说是语言赘肉。下面我们看看使用可变默认参数(Mutable default arguments)时会出现什么莫名其妙的状况。

你可能写了以下函数,它有一个默认参数是一个 list:

def append_to(element, to=[]):
    to.append(element)
    return to

然后调用该函数:

my_list = append_to(12)
print(my_list)

my_other_list = append_to(42)
print(my_other_list)
A new list is created each time the function is called if a second argument isn’t provided, so that the output is:

每次调用该函数,如果第二个参数没有提供(使用默认参数),一个新的 list 将会生成,所以输出应该是:

[12]
[42]

但是,结果并非上面那样,而是下面这样:

[12]
[12, 42]

当该函数被定义时,一次性生成一个 list 作为默认参数,后面每次成功调用都是使用的第一次生成的那个 list。

Python 的默认参数只在函数被定义时生成一次,而非每次调用时生成。这就意味着如果你使用可变默认参数并改变它,所有调用该函数的结果都是这个可变对象。

正确的做法应该是:

让默认参数为 None(None 通常是一个很好的选择),每次调用时创建一个新对象。

def append_to(element, to=None):
    if to is None:
        to = []
    to.append(element)
    return to


同时也有注意,该函数要传递一个 list 对象作为第二个参数,因为函数中对它进行了 append 操作。

文章都是我过往经验总结,我在我的博客:https://www.yuanrenxue.com/ 和 公众号【猿人学 Python】上会分享更多心得体会。

退出移动版