可变默认参数陷阱
快速摘要
你使用了 def f(x=[]) 或 def f(x={}) —— 默认值在定义时创建一次,在所有使用默认值的调用间共享。
为什么发生
列表、字典或集合用作默认参数值,在函数定义时求值一次
函数就地修改默认参数,修改持续到下一次调用
开发者假设默认值每次调用重新创建,但 Python 在定义时求值默认值
最小示例
✗ 错误代码
def add_item(item, items=[]): # mutable default!
items.append(item)
return items
print(add_item(1)) # [1]
print(add_item(2)) # [1, 2] — not [2]!✓ 修复代码
def add_item(item, items=None):
if items is None:
items = [] # fresh list each call
items.append(item)
return items
print(add_item(1)) # [1]
print(add_item(2)) # [2]使用 None 作为默认值并在函数内创建新列表,确保每次调用获得新列表,防止调用间状态泄漏。
如何诊断
多次不带参数调用函数,检查结果是否意外累积
用 print(func.__defaults__) 检查默认参数是否被修改
审查任何就地修改参数且有可变默认值的函数
如何修复
使用 None 作为默认值,在函数体内参数为 None 时创建可变对象
如果函数不需要修改默认值则使用不可变默认如元组或 frozenset
在函数内用 list(default) 或 dict(default) 创建默认值的副本
如何预防
永远不要使用可变对象(列表、字典、集合)作为默认参数值 —— 用 None 并在内部初始化
使用 flake8-bugbear (B006) 等代码检查器检测可变默认参数