Python中可变默认参数的陷阱：避免令人惊讶的陷阱

2024-03-18 08:06:30

“最小惊讶”原则与可变默认参数：Python 中的陷阱

Python 中一个鲜为人知但令人困惑的特性是其处理可变默认参数的方式。这可能导致令人惊讶的结果，特别是在使用空列表等可变类型作为默认参数的情况下。本文旨在解决这种行为，解释背后的原因，并提供一些技巧和最佳实践以避免意外。

最小惊讶原则 是一个软件设计准则，它指出软件应该尽可能地以用户最不惊讶的方式运行。当调用 Python 函数时，如果函数的行为与预期的不同，可能会导致惊讶，这会阻碍开发人员的理解和调试过程。

在 Python 中，函数参数可以具有默认值，这些默认值是在函数定义时指定的。如果在调用函数时未提供参数，则使用默认值。问题产生于当默认值是可变类型（例如列表或字典）时。

def foo(a=[]):
    a.append(5)
    return a

此函数定义了一个名为 foo 的函数，它将接受一个可变参数列表 a，其中默认值为一个空列表。当调用此函数时，a 始终引用相同的列表，这意味着该列表的内容在每次函数调用后都会累积。

以下是一个演示函数行为的示例：

>>> foo()
[5]
>>> foo()
[5, 5]
>>> foo()
[5, 5, 5]
>>> foo()
[5, 5, 5, 5]

如您所见，每次调用 foo 都会追加一个 5 到 a 列表中，导致每次调用返回的列表不断增长。这与人们的预期相反，人们通常希望每次调用函数时都能获得一个全新的空列表。

此行为背后的原因是 Python 在函数定义时绑定默认参数，而不是在函数调用时。这意味着当函数定义被执行时，a 将指向一个空列表，然后每次函数被调用时，该列表将被修改。

避免可变默认参数是解决此问题的最简单方法。相反，使用不可变类型（例如元组或字符串）或在函数内部创建新列表作为默认值。

def foo():
    return [5]

为了避免可变默认参数带来的惊讶，请遵循以下最佳实践：

为什么 Python 在函数定义时绑定默认参数？
因为在函数调用时绑定它们会使函数行为不一致，因为在调用函数之前，默认值可能已被修改。
有没有一种方法可以强制 Python 在函数调用时绑定默认参数？
没有。
为什么有人会使用可变默认参数？
可变默认参数在某些情况下可能很有用，例如当您希望函数以累积方式工作时。
这个问题是 Python 设计中的一个缺陷吗？
这是一个设计选择，有其优点和缺点。一些开发人员认为这是一个缺陷，而另一些开发人员则认为它是一个有用的功能。
如果我无法避免使用可变默认参数，我该怎么办？
确保在函数文档中明确记录函数的行为，并告知用户使用不可变默认值或在函数内部创建新实例。