使用mutable对象作为Python函数参数默认值潜在的危害(Default argument is mutable)

本文主要是介绍使用mutable对象作为Python函数参数默认值潜在的危害(Default argument is mutable)，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

参考自：
函数的缺省参数值(Default Argument Values)
Python函数参数默认值的陷阱和原理深究

问题

我们在Python里写函数时，常常会给一些参数赋初始值。我们把这些初始值叫作Default Argument Values。
一般情况下，我们可以很自由的给参数赋初值，而不需要考虑任何异常的情况或者陷阱。但是当你给这些参数
赋值为可变对象（mutable object)，比如list，dictionary，很多类的实例时，那么你要小心了，因为函数参数
的初值只能被计算一次（在函数定义的时间里）。怎么来理解呢？我们来看下面的例子。

def bad_foo(item, my_list=[]):my_list.append(item)return my_listprint bad_foo('a')print bad_foo('b')print bad_foo('c')

输出结果：

['a']
['a', 'b']
['a', 'b', 'c']

按我们常规的理解，上面的输出结果应该是[‘a’]，[‘b’]和[‘c’]，而不是[‘a’]，[‘a’, ‘b’]和[‘a’, ‘b’, ‘c’]。难道解释器
有问题？答案是解释器的输出结果完全正确。由于前面我们说了函数参数的初值只会在函数定义的时间里计
算一次。所以，你在第二次调用函数时，my_list=[]不会再被执行，此时my_list已经不在等于[]，而是等于
[‘a’]，以此类推。

原因

一句话来解释：Python函数的参数默认值，是在编译阶段就绑定的。
现在，我们先从一段摘录来详细分析这个陷阱的原因。下面是一段从Python Common Gotchas中摘录的原因解释：

Python’s default arguments are evaluated once when the function is defined, not each time the function is called (like it is in say, Ruby). This means that if you use a mutable default argument and mutate it, you will and have mutated that object for all future calls to the function as well.

可见如果参数默认值是在函数编译compile阶段就已经被确定。之后所有的函数调用时，如果参数不显示的给予赋值，那么所谓的参数默认值不过是一个指向那个在compile阶段就已经存在的对象的指针。如果调用函数时，没有显示指定传入参数值得话。那么所有这种情况下的该参数都会作为编译时创建的那个对象的一种别名存在。如果参数的默认值是一个不可变(Imuttable)数值，那么在函数体内如果修改了该参数，那么参数就会重新指向另一个新的不可变值。而如果参数默认值是和本文最开始的举例一样，是一个可变对象(Muttable)，那么情况就比较糟糕了。所有函数体内对于该参数的修改，实际上都是对compile阶段就已经确定的那个对象的修改。
对于这么一个陷阱在 Python官方文档中也有特别提示：

Important warning: The default value is evaluated only once. This makes a difference when the default is a mutable object such as a list, dictionary, or instances of most classes. For example, the following function accumulates the arguments passed to it on subsequent calls:

解决方法

最好的方式是不要使用可变对象作为函数默认值。如果非要这么用的话，下面是一种解决方案

>>> def good_foo(item, my_list=None):if my_list is None:my_list=[]my_list.append(item)return my_list>>> good_foo('a')
['a']
>>> good_foo('b')
['b']
>>> good_foo('c')
['c']
>>>