8．3 不要用可变值作为默认参数-Python编程轻松进阶(三)

当前位置:　首页>> 技术小册>> Python编程轻松进阶(三)

8.3 不要用可变值作为默认参数

在Python编程中，函数定义时可以为参数指定默认值，这是Python提供的一种便利特性，允许在调用函数时省略某些参数，从而使用预定义的默认值。然而，当这些默认值被设置为可变类型（如列表、字典、集合等）时，就可能引发一系列意想不到的问题。这一章节将深入探讨为何应避免将可变值用作默认参数，并展示其潜在的问题及正确的做法。

8.3.1 问题的根源

在Python中，函数定义时如果指定了默认参数，这些参数在函数定义时就被计算一次，并在后续的函数调用中保持不变（对于不可变类型如整数、浮点数、字符串和元组等），但对于可变类型（如列表、字典、集合等），情况就有所不同。可变类型的默认参数在函数定义时创建，并在后续函数调用中共享同一个对象引用。这意味着，如果函数内部修改了这些默认参数，那么这些修改将在后续的所有调用中持续存在，因为实际上修改的是同一个对象。

8.3.2 示例说明

为了更清晰地说明这一点，让我们通过一个简单的例子来展示。

def append_to_list(x, my_list=[]):
    my_list.append(x)
    return my_list
# 第一次调用
print(append_to_list(1))  # 输出: [1]
# 第二次调用，期望是 [2]，但实际输出可能出人意料
print(append_to_list(2))  # 输出: [1, 2]
# 第三次调用，列表继续累积
print(append_to_list(3))  # 输出: [1, 2, 3]

在上述例子中，append_to_list函数旨在将传入的x添加到名为my_list的列表中，并返回这个列表。然而，由于my_list被设置为了一个默认参数且为可变类型（列表），因此每次调用append_to_list时，它都向同一个列表添加元素，而不是每次都从头开始。这通常不是我们想要的行为，因为它违反了函数调用的独立性原则。

8.3.3 潜在问题

难以追踪的bug：如上例所示，如果函数的逻辑较为复杂，或者该函数被多个地方调用，那么使用可变默认参数可能导致难以追踪的bug，因为调用者可能无法预料到他们的调用会如何影响其他调用。
代码可读性降低：使用可变默认参数会使函数的行为变得不那么直观，增加代码的阅读和理解难度。
测试困难：在编写单元测试时，如果函数依赖于可变默认参数，那么测试可能会变得复杂，因为测试之间可能会相互影响。

8.3.4 正确的做法

要避免这些问题，有几种方法可以采用：

使用None作为默认值：最常见的解决方法是将默认参数设置为None，然后在函数体内检查这个值，如果为None，则创建一个新的可变对象。
```
def append_to_list(x, my_list=None):
    if my_list is None:
        my_list = []
    my_list.append(x)
    return my_list
print(append_to_list(1))  # 输出: [1]
print(append_to_list(2))  # 输出: [2]
print(append_to_list(3))  # 输出: [3]
```
这种方法确保了每次调用append_to_list时，如果my_list没有被显式提供，就会创建一个新的空列表。
使用文档字符串明确说明：即使你决定不改变默认参数的类型，也应该在文档字符串中明确指出该函数的行为，特别是当默认参数是可变类型时。这有助于其他开发者（或未来的你）理解函数是如何工作的。
考虑函数设计：在设计函数时，考虑是否真的需要默认参数，或者是否有更好的方式来组织代码，比如使用类来封装状态和行为。