Python默认参数陷阱（Dangerous default value [] as argument.）引用传递（建议列表、字典等使用None作为默认参数，不要使用空列表、空字典）

Python中的默认参数陷阱及其解决方案

在Python编程中，函数的默认参数是一个非常有用但易于误用的特性。这篇文章将深入探讨Python中默认参数的工作原理、常见的陷阱、其背后的原理以及如何避免这些问题。

默认参数的工作原理

在Python中，函数参数可以有默认值。当调用函数时没有提供相应的参数，函数会使用定义时指定的默认值。这使得函数调用更加灵活，能够适应不同的使用场景而不必每次都提供所有参数。

基本示例

def print_message(count=1, message="Hello, World!"):
    for _ in range(count):
        print(message)

print_message()
print_message(3)
print_message(message="Goodbye, World!")

在这个例子中，print_message 函数可以在不需要每次都指定 count 和 message 的情况下调用，极大地增加了灵活性。

默认参数的陷阱

虽然默认参数非常有用，但在使用可变类型（如列表、字典等）作为默认参数时，可能会遇到一些问题。

陷阱示例

def add_item(name, item_list=[]):
    item_list.append(name)
    return item_list

print(add_item("Apple"))
print(add_item("Banana"))

可能期望的输出是：

['Apple']
['Banana']

但实际输出是：

['Apple']
['Apple', 'Banana']

这是因为item_list是在函数定义时创建的同一个列表，每次调用add_item都会修改这个列表。

背后的原理

Python中的函数默认值是在函数定义时评估并创建的，而不是在函数调用时。如果默认值是可变对象，那么每次函数调用时对这个默认值的修改都会累积。

深入解释

这种行为源于Python中对象引用的管理方式。在Python中，对象通过引用传递，这意味着当将列表作为默认参数时，实际上是传递了对同一个列表的引用，而不是每次调用都创建一个新列表。

解决方案

避免这个问题的最佳方法是使用不可变类型作为默认参数。如果需要使用列表、字典等可变类型，可以采取如下策略。

使用None作为默认参数

def add_item(name, item_list=None):
    if item_list is None:
        item_list = []
    item_list.append(name)
    return item_list

print(add_item("Apple"))
print(add_item("Banana"))

现在的输出将符合预期：

['Apple']
['Banana']

这种方法通过使用None作为默认参数，并在函数内部检查其值，确保每次调用函数时都会创建一个新的列表。

使用None作为参数可能函数注释不清晰，使用者可能不知道该传什么参数，可以使用typing类型注释一下

from typing import List


# def add_item(name, item_list: List = None):
def add_item(name, item_list: List[str] = None):
    if item_list is None:
        item_list = []
    item_list.append(name)
    return item_list


print(add_item("Apple"))
print(add_item("Banana"))
print(add_item(2))  # 不会报错

但类型注释归根结底只是注释，不会代码检查，运行时传入参数类型对不上更不会报错。

结论

在Python中正确地使用默认参数，尤其是对于可变类型，需要理解其背后的工作原理。通过采用None作为默认参数值，并在函数内部进行条件初始化，可以避免许多由此引起的bug和问题。这不仅使代码更安全，也使其更容易理解和维护。