如何避免Python中默认参数带来的陷阱

简介: Python编程中,我们有时会给函数或方法提供默认参数。然而,这种做法在某些情况下可能会导致意想不到的行为,尤其是当默认参数是可变对象(例如列表、字典或类实例对象)时。本文将通过几个具体的例子来解释这个问题,并提供解决方案。

Python编程中,我们有时会给函数或方法提供默认参数。然而,这种做法在某些情况下可能会导致意想不到的行为,尤其是当默认参数是可变对象(例如列表、字典或类实例对象)时。本文将通过几个具体的例子来解释这个问题,并提供解决方案。

问题示例

示例一:HauntedBus

首先,考虑以下HauntedBus类:

class HauntedBus:
    """A bus model haunted by ghost passengers"""

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

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

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

在这个类中,passengers参数有一个默认值[]。现在,我们创建两个HauntedBus实例,并向第一个实例添加乘客:

bus1 = HauntedBus()
bus1.pick("小明")
bus1.pick("小红")
print(bus1.passengers)  # 输出: ['小明', '小红']

bus2 = HauntedBus()
print(bus2.passengers)  # 输出: ['小明', '小红']

你可能会预期bus2的乘客列表应该是空的,但实际输出表明它包含了bus1的乘客。这是为什么呢?

示例二:使用字典作为默认参数

def add_entry(key, value, dictionary={}):
    dictionary[key] = value
    return dictionary

d1 = add_entry('name', 'Alice')
print(d1)  # 输出: {'name': 'Alice'}

d2 = add_entry('age', 30)
print(d2)  # 输出: {'name': 'Alice', 'age': 30}

在这个例子中,dictionary参数的默认值是一个空字典。第一次调用add_entry函数时,向字典中添加了键值对'name': 'Alice'。第二次调用时,字典中已经有了之前添加的键值对,所以又添加了键值对'age': 30。发现两次调用共享了同一个字典。

示例三:使用自定义类对象作为默认参数

class DefaultObject:
    def __init__(self):
        self.data = []
        print("DefaultObject Init")

def add_to_default(obj=DefaultObject()):
    obj.data.append(1)
    return obj.data

result1 = add_to_default()
print(result1)  # 输出: [1]

result2 = add_to_default()
print(result2)  # 输出: [1, 1]

在这个例子中,obj参数的默认值是一个DefaultObject实例。第一次调用add_to_default函数时,向data列表中添加了数字1。第二次调用时,data列表中已经有了一个1,所以又添加了一个1。发现两次调用共享了同一个DefaultObject实例。

原因解析

在Python中,默认参数是在函数定义的时候只初始化一次的,而不是每次调用函数时重新初始化。如果默认参数是一个可变类型/对象,那么后续对这个函数的调用将共享同一个默认参数对象。

解决方案

为了解决这个问题,我们可以使用None作为默认参数值,并在函数内部进行检查和初始化。这样每次创建新实例时都会创建一个新的可变对象,从而避免不同实例或调用之间共享同一个默认参数对象。

修复后的HauntedBus

class HauntedBus:
    """A bus model haunted by ghost passengers"""

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

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

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

现在,我们再次创建两个HauntedBus实例并测试:

bus1 = HauntedBus()
bus1.pick("小明")
bus1.pick("小红")
print(bus1.passengers)  # 输出: ['小明', '小红']

bus2 = HauntedBus()
print(bus2.passengers)  # 输出: []

这样,每个实例都有自己独立的乘客列表,不会相互影响。

修复后的add_entry函数

def add_entry(key, value, dictionary=None):
    if dictionary is None:
        dictionary = {}
    dictionary[key] = value
    return dictionary

d1 = add_entry('name', 'Alice')
print(d1)  # 输出: {'name': 'Alice'}

d2 = add_entry('age', 30)
print(d2)  # 输出: {'age': 30}

通过将默认参数设置为None并在函数内部进行初始化,每次调用add_entry函数时都会创建一个新的字典,从而避免不同调用之间共享同一个字典。

修复后的add_to_default函数

class DefaultObject:
    def __init__(self):
        self.data = []
        print("DefaultObject Init")

def add_to_default(obj=None):
    if obj is None:
        obj = DefaultObject()
    obj.data.append(1)
    return obj.data

result1 = add_to_default()
print(result1)  # 输出: [1]

result2 = add_to_default()
print(result2)  # 输出: [1]

通过将默认参数设置为None并在函数内部进行初始化,每次调用add_to_default函数时都会创建一个新的DefaultObject实例,从而避免不同调用之间共享同一个实例。

结论

在Python中使用默认参数时,尤其是可变对象,必须小心处理。通过使用None作为默认值并在函数内部进行初始化,可以避免默认参数带来的潜在陷阱。希望这些例子能帮助你理解并避免类似的问题。

相关文章
|
开发者 Python 容器
python函数基础以及函数参数简解
python函数基础以及函数参数简解
|
7天前
|
JSON 缓存 开发者
淘宝商品详情接口(item_get)企业级全解析:参数配置、签名机制与 Python 代码实战
本文详解淘宝开放平台taobao.item_get接口对接全流程,涵盖参数配置、MD5签名生成、Python企业级代码实现及高频问题排查,提供可落地的实战方案,助你高效稳定获取商品数据。
|
3月前
|
算法 数据可视化 数据挖掘
基于EM期望最大化算法的GMM参数估计与三维数据分类系统python源码
本内容展示了基于EM算法的高斯混合模型(GMM)聚类实现,包含完整Python代码、运行效果图及理论解析。程序使用三维数据进行演示,涵盖误差计算、模型参数更新、结果可视化等关键步骤,并附有详细注释与操作视频,适合学习EM算法与GMM模型的原理及应用。
|
4月前
|
XML JSON 安全
分析参数顺序对Python requests库进行POST请求的影响。
最后,尽管理论上参数顺序对POST请求没影响,但编写代码时仍然建议遵循一定的顺序和规范,比如URL总是放在第一位,随后是data或json,最后是headers,这样可以提高代码的可读性和维护性。在处理复杂的请求时,一致的参数顺序有助于调试和团队协作。
133 9
|
12月前
|
存储 人工智能 开发工具
AI助理化繁为简,速取代码参数——使用python SDK 处理OSS存储的图片
只需要通过向AI助理提问的方式输入您的需求,即可瞬间获得核心流程代码及参数,缩短学习路径、提升开发效率。
1675 5
AI助理化繁为简,速取代码参数——使用python SDK 处理OSS存储的图片
|
开发者 Python
Python函数参数的魔法:揭秘如何用它们施展代码的无限可能!
【8月更文挑战第22天】Python函数参数展现了语言的强大与灵活。本文涵盖位置参数、默认参数、可变参数(*args)、关键字参数(**kwargs)及参数解包等,通过实例展示如何利用这些特性增强函数复用性与扩展性。类型注解的加入进一步提升了代码的可读性和健壮性。掌握这些技巧能帮助开发者写出更高效优雅的Python代码。
123 0
|
10月前
|
分布式计算 MaxCompute 对象存储
|
12月前
|
存储 C++ Python
[oeasy]python037_ print函数参数_sep分隔符_separator
本文介绍了Python中`print`函数的`sep`参数,即分隔符。通过回顾上文内容,解释了类型与`type`的概念,并强调了参数类型的重要性。文章详细探讨了`print`函数如何使用`sep`参数来分隔输出值,默认分隔符为空格(序号32)。还讨论了如何修改分隔符为其他字符,如冒号,并解释了为何反斜杠需要使用双反斜杠表示。最后,文章追溯了`sep`名称的由来,以及相关词汇的历史背景,如盎格鲁-萨克逊人的武器和语言。
342 1
|
算法 计算机视觉 Python
python利用opencv进行相机标定获取参数,并根据畸变参数修正图像附有全部代码(流畅无痛版)
该文章详细介绍了使用Python和OpenCV进行相机标定以获取畸变参数,并提供了修正图像畸变的全部代码,包括生成棋盘图、拍摄标定图像、标定过程和畸变矫正等步骤。
python利用opencv进行相机标定获取参数,并根据畸变参数修正图像附有全部代码(流畅无痛版)
|
12月前
|
Java 程序员 C++
【Python】链式、嵌套调用、递归、函数栈帧、参数默认值和关键字参数
【Python】链式、嵌套调用、递归、函数栈帧、参数默认值和关键字参数
131 0
【Python】链式、嵌套调用、递归、函数栈帧、参数默认值和关键字参数

推荐镜像

更多