Python类函数默认变量是类对象吗？ [复制]

Question

可能重复：
“Least Astonishment” in Python: The Mutable Default Argument

今天下午我正在编写一些代码，偶然发现了我的代码中的一个错误。我注意到我新创建的一个对象的默认值是从另一个对象继承的！例如：

class One(object):
    def __init__(self, my_list=[]):
        self.my_list = my_list

one1 = One()
print(one1.my_list)
[] # empty list, what you'd expect.

one1.my_list.append('hi')
print(one1.my_list)
['hi'] # list with the new value in it, what you'd expect.

one2 = One()
print(one2.my_list)
['hi'] # Hey! It saved the variable from the other One!

所以我知道这样做可以解决：

class One(object):
    def __init__(self, my_list=None):
        self.my_list = my_list if my_list is not None else []

我想知道的是……为什么？为什么 Python 类是结构化的，以便跨类的实例保存默认值？

提前致谢！

Answer 1

这是 Python 默认值工作方式的一种已知行为，粗心的人通常会感到惊讶。空数组对象[] 在函数定义时创建，而不是在调用时创建。

要修复它，请尝试：

def __init__(self, my_list=None):
    if my_list is None:
        my_list = []
    self.my_list = my_list

Answer 2

Python 函数是对象。函数的默认参数是该函数的属性。因此，如果参数的默认值是可变的并且在您的函数内部进行了修改，则更改会反映在对该函数的后续调用中。

Answer 3

这是 Python 中任何地方的默认参数的标准行为，而不仅仅是在类中。
更多解释见Mutable defaults for function/method arguments。

Answer 4

基本上，python 函数对象存储一个默认参数元组，这对于像整数这样的不可变对象来说很好，但列表和其他可变对象通常会就地修改，从而导致您观察到的行为。

Answer 5

其他一些人指出这是 Python 中“可变默认参数”问题的一个实例。基本原因是默认参数必须存在于函数“外部”才能传递给它。

但作为一个问题的真正根源与与默认参数无关。任何时候如果修改了可变的默认值会很糟糕，你真的需要问自己：如果修改了显式提供的值会很糟糕吗？除非有人非常熟悉您的课程，否则以下行为也会非常令人惊讶（因此会导致错误）：

>>> class One(object):
...     def __init__(self, my_list=[]):
...         self.my_list = my_list
...
>>> alist = ['hello']
>>> one1 = One(alist)
>>> alist.append('world')
>>> one2 = One(alist)
>>> 
>>> print(one1.my_list) # Huh? This isn't what I initialised one1 with!
['hello', 'world']
>>> print(one2.my_list) # At least this one's okay...
['hello', 'world']
>>> del alist[0]
>>> print one2.my_list # What the hell? I just modified a local variable and a class instance somewhere else got changed?
['world']

10 次中有 9 次，如果您发现自己使用 None 作为默认值并使用 if value is None: value = default 的“模式”，那么您不应该这样做。你不应该修改你的论点！参数不应被视为由被调用代码拥有，除非它被明确记录为拥有它们的所有权。

在这种情况下（特别是因为您正在初始化一个类实例，所以可变变量将存在很长时间并被其他方法和可能从实例中检索它的其他代码使用）我会执行以下操作：

class One(object):
    def __init__(self, my_list=[])
        self.my_list = list(my_list)

现在您正在从作为输入提供的列表中初始化您的类的数据，而不是获取预先存在的列表的所有权。两个单独的实例最终共享同一个列表，也不存在与调用者可能希望继续使用的调用者中的变量共享该列表的危险。它还具有很好的效果，您的调用者可以提供元组、生成器、字符串、集合、字典、自制的自定义可迭代类等，并且您知道您仍然可以依靠 self.my_list 具有 append 方法，因为您自己做的。

这里还有一个潜在的问题，如果列表中包含的元素本身是可变的，那么调用者和这个实例仍然可能会意外地相互干扰。我发现它在我的代码实践中并不经常成为问题（所以我不会自动对所有内容进行深度复制），但你必须意识到这一点。

另一个问题是，如果 my_list 可能非常大，则副本可能会很昂贵。在那里你必须做出权衡。在这种情况下，也许最好只使用传入的列表，并使用if my_list is None: my_list = [] 模式来防止所有默认实例共享一个列表。但是，如果您这样做，则需要在文档或类的名称中明确说明，调用者正在放弃他们用于初始化实例的列表的所有权。或者，如果您真的想构建一个列表只是为了包装在 One 的实例中，也许您应该弄清楚如何将列表的创建封装在 inside 的初始化中One，而不是先构造它；毕竟，它实际上是实例的一部分，而不是初始化值。但有时这不够灵活。

有时你真的很想继续使用别名，并通过改变他们都可以访问的值来进行代码通信。然而，在我承诺这样的设计之前，我会非常努力地思考。它会让其他人感到惊讶（当你在 X 个月后回到代码中时你也会感到惊讶），所以文档再次成为你的朋友！

在我看来，就“可变默认参数”问题对新的 Python 程序员进行教育实际上（有点）有害。我们应该问他们“你为什么要修改你的论点？” （以及 then 指出默认参数在 Python 中的工作方式）。具有合理默认参数的函数这一事实通常是一个很好的指标，表明它不是旨在接收预先存在的值的所有权，因此它可能不应该修改参数是否获得默认值。

Answer 6

不是答案，但值得注意的是，对于在任何类函数之外定义的类变量，这也是正确的。

例子：

>>> class one:
...     myList = []
...
>>>
>>> one1 = one()
>>> one1.myList
[]
>>> one2 = one()
>>> one2.myList.append("Hello Thar!")
>>>
>>> one1.myList
['Hello Thar!']
>>>

请注意，不仅myList 的值保持不变，而且myList 的每个实例 都指向相同的列表。

我自己遇到了这个错误/功能，并花了大约 3 个小时试图弄清楚发生了什么。在获取有效数据时进行调试是相当具有挑战性的，但它不是来自本地计算，而是来自以前的计算。

这变得更糟了，因为这不仅仅是一个默认参数。您不能只将myList 放在类定义中，它必须 设置为等于某个值，尽管它设置为等于的值只评估一次。

至少对我来说，解决方案是简单地在 __init__ 中创建所有类变量。