Python 对象当函数使及动态添加方法

继续阅读 《Python Tricks: The Book》,书中说到 "Objects Can Behave Like Functions", 就是把对象当成函数来调用,在普通对象后加个括号就能调用相应的 __call__ 函数。下面是书中的例子

class Adder:
    def __init__(self, n):
        self.n = n

    def __call__(self, x):
        return self.n + x

然后是应用类 Adder 的代码

plus_3 = Adder(3)
plus_3(4)  # 普通对象 plus_3 当成函数来用

上面 plus_3 是一个普能的对象,并非一个函数,但如果把它当成函数来看待,那么 plus_3(4) 就会去寻找相应的 __call__ 函数。

这种行为与 Scala 的 case class 或  apply() 函数很类似。来一段 Scala 代码的演示

1case class User(val id: Int) {
2  def apply(name: String) {
3    println(s"Id: ${id}, Hello ${name}")
4  }
5}
6
7val user = User(1)  # case class 实例的创建,其实是 new User(1) 的缩写形式
8user("Yanbin")

上面的 Scala 执行输出

Id: 1, Hello Yanbin

这里的对象 user 后直接加括号,当函数来对待实质是调用相应的 apply(name) 函数。

进一步延伸,对于自定义的类我们可以事先创建 __call__ 函数进行把对象当函数来用,但是对于别人创建的类是否能动态的添加 __call__ 方法呢?这一部分的内容或许与上面所介绍的无多大的关系,不过既然是观后感,不妨列在一块。

动态添加方法

比如说有一个没定义 __call__ 方法的类

1class Adder:
2    def __init__(self, n):
3        self.n = n

如何实现出与前面同样的效果来

1plus_3 = Adder(3)
2plus_3(4)

上面的 plus_3(4)  会报 TypeError: 'Adder' object is not callable,因为作为一个鸭子找不到 __call__ 方法。

其实也很简单,Python 的类或对象都是动态的,直接事后对 Adder 加个 __call__ 方法就成。下面写成 lambda 的形式

给类添加实例方法

这里我们定义一个 foo(self, x) 方法,后面的实例都使用相同的 foo 方法定义。

1>>> def foo(self, x):
2	self.n = self.n + x
3
4>>> Adder.__call__ = foo
5>>> plus_3 = Adder(3)
6>>> plus_3(4)
7>>> plus_3.n
8>>> plus_3.__call__
9<bound method foo of <__main__.Adder object at 0x7fac93f9e940>>

这里注意到 plus_3.__call__ 是一个 bound method.

给对象添加实例方法

如果持有的是一个 Adder 的对象 plus_3,不直接给 Adder 类增添 __call__ 属性,又该如何实现 plus_3(4) 的调用呢?用 plus_3.__class__ 就行。关键代码如下

1>>> plus_3.__class__.__call__ = foo
2>>> plus_3(4)          # 同样的效果

但是不能像下面那样直接给 plus_3 实例添加 __call__ 方法,比如下面的做法就有问题

1>>> plus_3.__call__ = foo
2>>> plus_3(4)      # 错误: TypeError: 'Adder' object is not callable
3>>> plus_3.__call__(4)  # 错误: TypeError: foo() missing 1 required positional argument: 'x'
4>>> plus_3.__call__
5<function foo at 0x7fac97d04598>

plus_3.__call__ 是一个 function, 即 unbound method

plus_3.__call__(4) 中的参数传递给了 foo(self, x) 的第一个参数 self 了,而 x 没得到参数。

因为这时候 foo 并未当作一个实例方法,更准确讲是 bound method, 即方法的第一个参数是实例本身,通过用 self 作为形参名。

那是否能直接用 plus_3.__call__ 的方式来添加新的 bound method 方法呢?这时候可以应用 types 模块,下面进行尝试

 1>>> plus_3 = Adder(3)
 2>>> import types
 3>>> plus_3.__call__ = types.MethodType(foo, plus_3)
 4>>> callable(plus_3)
 5False                   # 所以仍然不能用 plus_3(4) 的方式
 6>>> plus_3.__call__(4)  # 前面确实添加了 __call__ 方法
 7>>> plus_3.n
 86                       # 并且 self 也是凑效的
 9
10>>> plus_3.__call__
11<bound method foo of <__main__.Adder object at 0x7fac93fb0438>>

上面虽然是可以添加上一个  __call__ 方法,它确实是一个  bound method, 但是只能显式的用  __call__  来调用,有点特殊。再次尝试

1>>> from functools import partial
2>>> plus_3.__call = partial(foo, plus_3)
3>>> callable(plus_3)
4False                     # 仍然不是 callable
5>>> plus_3.__call__(4)    # 这样没问题
6>>> plus_3.__call__
7functools.partial(<function foo at 0x7fac97d04598>, <__main__.Adder object at 0x7fac93fb0438>)

types.MethodType 确实可以添加 bound method, 但是由它添加的  __call__ 方法后并不能改变 callable 为 False 的特征,所以无法用 plus_3(4) 的方式来调用 __call__ 方法。同时证明了有  __call__ bound method 的对象也不一定能当作函数来调用。

一个 Python 对象的 callable 为 True,直接当函数来调用也可能失败,但是 callable 为 False 的话,当函数调用必定失败。当有一个 bound __call__ 方法时,callable 仍然为 False 时就要深入 callable 的源代码来看判定规则了。

链接:

  1. Adding a Method to an Existing Object Instance
  2. callable(object)
永久链接 https://yanbin.blog/add-python-methods-dynamically/, 来自 隔叶黄莺 Yanbin's Blog
[版权声明] 本文采用 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) 进行许可。