美文网首页
坑!当Python默认参数是可变对象时

坑!当Python默认参数是可变对象时

作者: 越大大雨天 | 来源:发表于2019-05-10 17:26 被阅读0次

    今天,看到一道python题,初始觉得很简单,但是看到最终答案的我一脸懵逼,先把题列出来看看:

    def func(n, li = []):
        for i in range(n):
            li.append(i)
        print(l)
    
    func(2)
    func(3,l=[1,2])
    func(2)
    

    看到这里的小伙伴可以先默算一下结果。
    我想的答案是三行分别打印:[0,1]、[1,2,0,1,2]、[0,1]
    但是:

    # 输出:
    [0, 1]
    [1, 2, 0, 1, 2]
    [0, 1, 0, 1]
    

    ???
    ???????
    最后一个什么情况?为什么是在第一次调用函数后的li列表中添加的?

    基于自己对内存地址的理解,我知道当前情况说明的是:第一次和第三次函数调用时,函数内部的li列表都是同一个内存地址,并未引用新的内存空间;而第二次调用函数时,指定了列表参数,此时li引用了新的内存空间。
    所以我在函数内打印了列表参数li的内存地址:

    def func(n, li = []):
        print(id(li))
        for i in range(n):
            li.append(i)
        print(li)
    
    func(2)
    func(3,li=[1,2])
    func(2)
    

    输出:

    2017077218568
    [0, 1]
    2017076682696
    [1, 2, 0, 1, 2]
    2017077218568
    [0, 1, 0, 1]
    

    果然,第一次调用和第三次调用时其操作的是同一个内存地址数据,因此造成了这样的追加结果。

    最可疑的原因是默认参数引起的,不过已经超过我的认知,为什么内部有这种现象,自己真想不明白,求助google找到了答案。

    原因解析

    源地址答案:Python函数参数默认值的陷阱和原理深究:http://cenalulu.github.io/python/default-mutable-arguments/
    这里首先需要理解python中变量的实质,了解其引用和内存地址的含义。

    Python’s default arguments are evaluated once when the function is defined, not each time the function is called (like it is in say, Ruby). This means that if you use a mutable default argument and mutate it, you will and have mutated that object for all future calls to the function as well. ——Python Common Gotchas

    其大意是说,Python的默认参数只在函数定义时被赋值一次,而不会每次调用函数时又创建新的引用。
    这意味着,函数定义完成后,默认参数已经存在固定的内存地址了,如果你使用一个可变的默认参数并对其进行改变,那么以后对该函数的调用都会改变这个可变对象。

    原文作者解释如下:

    可见如果参数默认值是在函数编译compile阶段就已经被确定。之后所有的函数调用时,如果参数不显示的给予赋值,那么所谓的参数默认值不过是一个指向那个在compile阶段就已经存在的对象的指针。如果调用函数时,没有显示指定传入参数值得话。那么所有这种情况下的该参数都会作为编译时创建的那个对象的一种别名存在。如果参数的默认值是一个不可变(Imuttable)数值,那么在函数体内如果修改了该参数,那么参数就会重新指向另一个新的不可变值。而如果参数默认值是和本文最开始的举例一样,是一个可变对象(Muttable),那么情况就比较糟糕了。所有函数体内对于该参数的修改,实际上都是对compile阶段就已经确定的那个对象的修改。

    Python官方文档中也有特别提示:Important warning: The default value is evaluated only once. This makes a difference when the default is a mutable object such as a list, dictionary, or instances of most classes. For example, the following function accumulates the arguments passed to it on subsequent calls:

    如何避免这个缺陷

    当然最好的方式是不要使用可变对象作为函数默认值。如果非要这么用的话,下面是一种解决方案。还是以文章开头的需求为例:

    def func(n, li = []):
        # 这里使用 is None判断不行
        if not li:
            li = []
        print(id(li))
        for i in range(n):
            li.append(i)
        print(li)
    
    func(2)
    func(3,li=[1,2])
    func(2)
    

    输出结果,能按照正常逻辑结果输出:

    2017078756808
    [0, 1]
    2017079467976
    [1, 2, 0, 1, 2]
    2017078756808
    [0, 1]
    

    结语

    这是设计python语言的时候就定义好的奇异之处,虽说有点违背编程逻辑,但记得避免就好,不用过多深究。

    2019.07.07更新:遇到类似的问题一并总结在这篇了

    函数可能会修改接收到的任何可变对象

    def f(a,b):
    
    

    相关文章

      网友评论

          本文标题:坑!当Python默认参数是可变对象时

          本文链接:https://www.haomeiwen.com/subject/omiaoqtx.html