python 不要使用可变类型作为参数的默认值

最新推荐文章于 2023-06-09 09:03:27 发布

MZP_man

最新推荐文章于 2023-06-09 09:03:27 发布

阅读量592

点赞数

CC 4.0 BY-SA版权

分类专栏： python 文章标签： python

本文链接：https://blog.youkuaiyun.com/MZP_man/article/details/99096969

python 专栏收录该内容

107 篇文章

订阅专栏

探讨Python中使用可变对象作为函数默认参数的潜在问题，及如何避免此类陷阱，确保代码的健壮性和向后兼容性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

可选参数可以有默认值，这是 Python 函数定义的一个很棒的特性，这样我们的 API 在进化的同时能保证向后兼容。然而，我们应该避免使用可变的对象作为参数的默认值。
示例：

"""
不要使用可变类型作为函数的参数的默认值
"""


class HauntedBus:

    def __init__(self, passengers=[]):
        self.passengers = passengers

    def pick(self, name):
        self.passengers.append(name)

    def drop(self, name):
        self.passengers.remove(name)


if __name__ == "__main__":
    # 当给参数传入值得时候
    bus1 = HauntedBus(['Alice', 'Bill'])
    print(bus1.passengers)
    bus1.pick('Charlie')
    bus1.drop('Alice')
    print(bus1.passengers)
    # 当个函数没有传入默认值得时候
    bus2 = HauntedBus()
    bus2.pick('mo')
    print(bus2.passengers)

    bus3 = HauntedBus()
    print(bus3.passengers)

    print(bus3.passengers is bus2.passengers)

    print(dir(HauntedBus.__init__))
    print(HauntedBus.__init__.__defaults__)

运行结果：
在这里插入图片描述
这里就会发现问题：bus3 的 passengers 的熟悉和bus2 的passengers 一致。
问题在于，没有指定初始乘客的 HauntedBus 实例会共享同一个乘客列表。出现这个问题的根源是，默认值在定义函数时计算（通常在加载模块时），因此默认值变成了函数对象的属性。因此，如果默认值是可变对象，而且修改了它的值，那么后续的函数调用都会受到影响。