资讯专栏INFORMATION COLUMN

陷阱!python参数默认值

Jason / 2116人阅读

摘要:所有默认参数值则存储在函数对象的属性中,它的值为一个列表,列表中每一个元素均为一个默认参数的值。你可以定义一个对象作为占位符,如下面例子虽然应该避免默认参数值为可变对象,不过有时候使用可变对象作为默认值会收到不错的效果。

原文地址

在stackoverflow上看到这样一个程序:

#! /usr/bin/env python
# -*- coding: utf-8 -*-

class demo_list:
    def __init__(self, l=[]):
        self.l = l

    def add(self, ele):
        self.l.append(ele)

def appender(ele):
    obj = demo_list()
    obj.add(ele)
    print obj.l

if __name__ == "__main__":
    for i in range(5):
        appender(i)

输出结果是

[0]
[0, 1]
[0, 1, 2]
[0, 1, 2, 3]
[0, 1, 2, 3, 4]

有点奇怪,难道输出不应该是像下面这样吗?

[0]
[1]
[2]
[3]
[4]

其实想要得到上面的输出,只需要将obj = intlist()替换为obj = intlist(l=[])

默认参数工作机制

上面怪异的输出简单来说是因为:

Default values are computed once, then re-used.

因此每次调用__init__(),返回的是同一个list。为了验证这一点,下面在__init__函数中添加一条语句,如下:

def __init__(self, l=[]):
    print id(l),
    self.l = l

输出结果为:

4346933688 [0]
4346933688 [0, 1]
4346933688 [0, 1, 2]
4346933688 [0, 1, 2, 3]
4346933688 [0, 1, 2, 3, 4]

可以清晰看出每次调用__init__函数时,默认参数l都是同一个对象,其id为4346933688。

关于默认参数,文档中是这样说的:

Default parameter values are evaluated when the function definition is executed. This means that the expression is evaluated once, when the function is defined, and that the same “pre-computed” value is used for each call.

为了能够更好地理解文档内容,再来看一个例子:

def a():
    print "a executed"
    return []

def b(x=a()):
    print "id(x): ", id(x)
    x.append(5)
    print "x: ", x

for i in range(2):
    print "-" * 15, "Call b()", "-" * 15
    b()
    print b.__defaults__
    print "id(b.__defaults__[0]): ", id(b.__defaults__[0])

for i in range(2):
    print "-" * 15, "Call b(list())", "-" * 15
    b(list())
    print b.__defaults__
    print "id(b.__defaults__[0]): ", id(b.__defaults__[0])

注意,当python执行def语句时,它会根据编译好的函数体字节码和命名空间等信息新建一个函数对象,并且会计算默认参数的值。函数的所有构成要素均可通过它的属性来访问,比如可以用func_name属性来查看函数的名称。所有默认参数值则存储在函数对象的__defaults__属性中,它的值为一个列表,列表中每一个元素均为一个默认参数的值。

好了,你应该已经知道上面程序的输出内容了吧,一个可能的输出如下(id值可能为不同):

a executed
--------------- Call b() ---------------
id(x): 4316528512
x: [5]
([5],)
id(b.__defaults__[0]): 4316528512
--------------- Call b() ---------------
id(x): 4316528512
x: [5, 5]
([5, 5],)
id(b.__defaults__[0]): 4316528512
--------------- Call b(list()) ---------------
id(x): 4316684872
x: [5]
([5, 5],)
id(b.__defaults__[0]): 4316528512
--------------- Call b(list()) ---------------
id(x): 4316684944
x: [5]
([5, 5],)
id(b.__defaults__[0]): 4316528512

我们看到,在定义函数b(也就是执行def语句)时,已经计算出默认参数x的值,也就是执行了a函数,因此才会打印出a executed。之后,对b进行了4次调用,下面简单分析一下:

第一次不提供默认参数x的值进行调用,此时使用函数b定义时计算出来的值作为x的值。所以id(x)和id(b.__defaults__[0])相等,x追加数字后,函数属性中的默认参数值也变为[5];

第二次仍然没有提供参数值,x的值为经过第一次调用后的默认参数值[5],然后对x进行追加,同时也对函数属性中的默认参数值追加;

传递参数list()来调用b,此时新建一个列表作为x的值,所以id(x)不同于函数属性中默认参数的id值,追加5后x的值为[5];

再一次传递参数list()来调用b,仍然是新建列表作为x的值。

如果上面的内容你已经搞明白了,那么你可能会觉得默认参数值的这种设计是python的设计缺陷,毕竟这也太不符合我们对默认参数的认知了。然而事实可能并非如此,更可能是因为:

Functions in Python are first-class objects, and not only a piece of code.

我们可以这样解读:函数也是对象,因此定义的时候就被执行,默认参数是函数的属性,它的值可能会随着函数被调用而改变。其他对象不都是如此吗?

可变对象作为参数默认值?

参数的默认值为可变对象时,多次调用将返回同一个可变对象,更改对象值可能会造成意外结果。参数的默认值为不可变对象时,虽然多次调用返回同一个对象,但更改对象值并不会造成意外结果。

因此,在代码中我们应该避免将参数的默认值设为可变对象,上面例子中的初始化函数可以更改如下:

def __init__(self, l=None):
       if not l:
            self.l = []
       else:
            self.l = l

在这里将None用作占位符来控制参数l的默认值。不过,有时候参数值可能是任意对象(包括None),这时候就不能将None作为占位符。你可以定义一个object对象作为占位符,如下面例子:

sentinel = object()

def func(var=sentinel):
   if var is sentinel:
        pass
   else:
        print var

虽然应该避免默认参数值为可变对象,不过有时候使用可变对象作为默认值会收到不错的效果。比如我们可以用可变对象作为参数默认值来统计函数调用次数,下面例子中使用collections.Counter()作为参数的默认值来统计斐波那契数列中每一个值计算的次数。

def fib_direct(n, count=collections.Counter()):
    assert n > 0, "invalid n"
    count[n] += 1
    if n < 3:
        return n
    else:
        return fib_direct(n - 1) + fib_direct(n - 2)

print fib_direct(10)
print fib_direct.__defaults__[0]

运行结果如下:

89
Counter({2: 34, 1: 21, 3: 21, 4: 13, 5: 8, 6: 5, 7: 3, 8: 2, 9: 1, 10: 1})

我们还可以用默认参数来做简单的缓存,仍然以斐波那契数列作为例子,如下:

def fib_direct(n, count=collections.Counter(), cache={}):
    assert n > 0, "invalid n"
    count[n] += 1
    if n in cache:
        return cache[n]
    if n < 3:
        value = n
    else:
        value = fib_direct(n - 1) + fib_direct(n - 2)
    cache[n] = value
    return value

print fib_direct(10)
print fib_direct.__defaults__[0]

结果为:

89
Counter({2: 2, 3: 2, 4: 2, 5: 2, 6: 2, 7: 2, 8: 2, 1: 1, 9: 1, 10: 1})

这样就快了太多了,fib_direct(n)调用次数为o(n),这里也可以用装饰器来实现计数和缓存功能。

参考
Python instances and attributes: is this a bug or i got it totally wrong?
Default Parameter Values in Python
“Least Astonishment” in Python: The Mutable Default Argument
A few things to remember while coding in Python
Using Python"s mutable default arguments for fun and profit

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/37439.html

相关文章

  • 当心Python函数可变默认参数(list,set,dict…)的陷阱

    摘要:下面我们看看使用可变默认参数时会出现什么莫名其妙的状况。这就意味着如果你使用可变默认参数并改变它,所有调用该函数的结果都是这个可变对象。同时也有注意,该函数要传递一个对象作为第二个参数,因为函数中对它进行了操作。 showImg(https://segmentfault.com/img/bVbrFS3?w=762&h=505); 绝大多数情况下,Python是一个干净具有一致性的语言。...

    Integ 评论0 收藏0
  • Proxy 的巧用

    摘要:为了保证的可读性,本文采用意译而非直译。对象的所有用法,都是上面的这种形式。其中用来生成实例,是表示所要拦截的对象,是用来定制拦截行为的对象。虽然不同的创建模式支持类似的功能,但无法用隐式初始值包装对象。 为了保证的可读性,本文采用意译而非直译。 想阅读更多优质文章请猛戳GitHub博客,一年百来篇优质文章等着你! Proxy 介绍 使用Proxy,你可以将一只猫伪装成一只老虎。下面大...

    feng409 评论0 收藏0
  • Proxy 的巧用

    摘要:为了保证的可读性,本文采用意译而非直译。对象的所有用法,都是上面的这种形式。其中用来生成实例,是表示所要拦截的对象,是用来定制拦截行为的对象。虽然不同的创建模式支持类似的功能,但无法用隐式初始值包装对象。 为了保证的可读性,本文采用意译而非直译。 想阅读更多优质文章请猛戳GitHub博客,一年百来篇优质文章等着你! Proxy 介绍 使用Proxy,你可以将一只猫伪装成一只老虎。下面大...

    FreeZinG 评论0 收藏0
  • Python编程规范笔记(上)

    摘要:编程规范笔记上写在前面从语言开始,自己陆续学习了,但是自从研究生做毕设接触以来,就爱不释手,再也没有动力尝试其他语言。一与的一大优势就是具备优秀的可读性,而这基于一套较为完整的公认编程规范。如原本希望的结果是,结果却完全一样。 Python编程规范笔记(上) 写在前面: 从C语言开始,自己陆续学习了C++/Java,但是自从研究生做毕设接触Python以来,就爱不释手,再也没有动力尝试...

    Kross 评论0 收藏0
  • 使用Python和Java调用Shell脚本时的死锁陷阱

    摘要:一般使用或者调用外部脚本需要注意的是,这里的方向是相对于主程序的,所以就是子进程的输出,而是子进程的输入。基于同样的原因,假如调用了方法等待子进程执行完毕而没有及时处理输出的话,就会造成死锁。 最近有一项需求,要定时判断任务执行条件是否满足并触发 Spark 任务,平时编写 Spark 任务时都是封装为一个 Jar 包,然后采用 Shell 脚本形式传入所需参数执行,考虑到本次判断条件...

    freewolf 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<