类与对象之调用父类方法 - python3 cookbook
问题
你想在子类中调用父类的某个已经被覆盖的方法。
解决方案
为了调用父类(超类)的一个方法,可以使用 super()
函数,比如:
class A:
def spam(self):
print('A.spam')
class B(A):
def spam(self):
print('B.spam')
super().spam() # Call parent spam()
super()
函数的一个常见用法是在 __init__()
方法中确保父类被正确的初始化了:
class A:
def __init__(self):
self.x = 0
class B(A):
def __init__(self):
super().__init__()
self.y = 1
super()
的另外一个常见用法出现在覆盖Python特殊方法的代码中,比如:
class Proxy:
def __init__(self, obj):
self._obj = obj
# Delegate attribute lookup to internal obj
def __getattr__(self, name):
return getattr(self._obj, name)
# Delegate attribute assignment
def __setattr__(self, name, value):
if name.startswith('_'):
super().__setattr__(name, value) # Call original __setattr__
else:
setattr(self._obj, name, value)
在上面代码中,__setattr__()
的实现包含一个名字检查。 如果某个属性名以下划线(_)开头,就通过 super()
调用原始的__setattr__()
, 否则的话就委派给内部的代理对象 self._obj
去处理。 这看上去有点意思,因为就算没有显式的指明某个类的父类, super()
仍然可以有效的工作。
讨论
实际上,大家对于在Python中如何正确使用 super()
函数普遍知之甚少。 你有时候会看到像下面这样直接调用父类的一个方法:
class Base:
def __init__(self):
print('Base.__init__')
class A(Base):
def __init__(self):
Base.__init__(self)
print('A.__init__')
尽管对于大部分代码而言这么做没什么问题,但是在更复杂的涉及到多继承的代码中就有可能导致很奇怪的问题发生。 比如,考虑如下的情况:
class Base:
def __init__(self):
print('Base.__init__')
class A(Base):
def __init__(self):
Base.__init__(self)
print('A.__init__')
class B(Base):
def __init__(self):
Base.__init__(self)
print('B.__init__')
class C(A,B):
def __init__(self):
A.__init__(self)
B.__init__(self)
print('C.__init__')
如果你运行这段代码就会发现 Base.__init__()
被调用两次,如下所示:
>>> c = C()
Base.__init__
A.__init__
Base.__init__
B.__init__
C.__init__
>>>
可能两次调用 Base.__init__()
没什么坏处,但有时候却不是。 另一方面,假设你在代码中换成使用 super()
,结果就很完美了:
class Base:
def __init__(self):
print('Base.__init__')
class A(Base):
def __init__(self):
super().__init__()
print('A.__init__')
class B(Base):
def __init__(self):
super().__init__()
print('B.__init__')
class C(A,B):
def __init__(self):
super().__init__() # Only one call to super() here
print('C.__init__')
运行这个新版本后,你会发现每个 __init__()
方法只会被调用一次了:
>>> c = C()
Base.__init__
B.__init__
A.__init__
C.__init__
>>>
为了弄清它的原理,我们需要花点时间解释下Python是如何实现继承的。 对于你定义的每一个类,Python会计算出一个所谓的方法解析顺序 (MRO) 列表。 这个 MRO 列表就是一个简单的所有基类的线性顺序表。例如:
>>> C.__mro__
(<class '__main__.C'>, <class '__main__.A'>, <class '__main__.B'>,
<class '__main__.Base'>, <class 'object'>)
>>>
为了实现继承,Python会在 MRO 列表上从左到右开始查找基类,直到找到第一个匹配这个属性的类为止。
而这个 MRO 列表的构造是通过一个C3线性化算法来实现的。 我们不去深究这个算法的数学原理,它实际上就是合并所有父类的 MRO 列表并遵循如下三条准则:
老实说,你所要知道的就是 MRO 列表中的类顺序会让你定义的任意类层级关系变得有意义。
当你使用 super()
函数时,Python会在 MRO 列表上继续搜索下一个类。 只要每个重定义的方法统一使用 super()
并只调用它一次, 那么控制流最终会遍历完整个 MRO 列表,每个方法也只会被调用一次。 这也是为什么在第二个例子中你不会调用两次 Base.__init__()
的原因。
super()
有个令人吃惊的地方是它并不一定去查找某个类在 MRO 中下一个直接父类, 你甚至可以在一个没有直接父类的类中使用它。例如,考虑如下这个类:
class A:
def spam(self):
print('A.spam')
super().spam()
如果你试着直接使用这个类就会出错:
>>> a = A()
>>> a.spam()
A.spam
Traceback (most recent call last):
File "" , line 1, in <module>
File "" , line 4, in spam
AttributeError: 'super' object has no attribute 'spam'
>>>
但是,如果你使用多继承的话看看会发生什么:
>>> class B:
... def spam(self):
... print('B.spam')
...
>>> class C(A,B):
... pass
...
>>> c = C()
>>> c.spam()
A.spam
B.spam
>>>
你可以看到在类A中使用 super().spam()
实际上调用的是跟类A毫无关系的类B中的 spam()
方法。 这个用类C的 MRO 列表就可以完全解释清楚了:
>>> C.__mro__
(<class '__main__.C'>, <class '__main__.A'>, <class '__main__.B'>,
<class 'object'>)
>>>
在定义混入类的时候这样使用 super()
是很普遍的。
然而,由于 super()
可能会调用不是你想要的方法,你应该遵循一些通用原则。 首先,确保在继承体系中所有相同名字的方法拥有可兼容的参数签名(比如相同的参数个数和参数名称)。 这样可以确保 super()
调用一个非直接父类方法时不会出错。 其次,最好确保最顶层的类提供了这个方法的实现,这样的话在 MRO 上面的查找链肯定可以找到某个确定的方法。
在Python社区中对于 super()
的使用有时候会引来一些争议。 尽管如此,如果一切顺利的话,你应该在你最新代码中使用它。 Raymond Hettinger为此写了一篇非常好的文章 “Python’s super() Considered Super!” , 通过大量的例子向我们解释了为什么 super()
是极好的。
[ PYTHON DOCUMENT ]
返回一个代理对象,它会将方法调用委托给 type 指定的父类或兄弟类。 这对于访问已在类中被重载的继承方法很有用。 搜索顺序与 getattr()
所使用的相同,只是 type 指定的类型本身会被跳过。
type 的 __mro__
属性列出了 getattr()
和 super()
所使用的方法解析顺序。 该属性是动态的,可以在继承层级结构更新的时候任意改变。
如果省略第二个参数,则返回的超类对象是未绑定的。 如果第二个参数为一个对象,则 isinstance(obj, type)
必须为真值。 如果第二个参数为一个类型,则 issubclass(type2, type)
必须为真值(这适用于类方法)。
super
有两个典型用例。 在具有单继承的类层级结构中,super
可用来引用父类而不必显式地指定它们的名称,从而令代码更易维护。 这种用法与其他编程语言中 super
的用法非常相似。
第二个用例是在动态执行环境中支持协作多重继承。 此用例为 Python 所独有,在静态编译语言或仅支持单继承的语言中是不存在的。 这使得实现“菱形图”成为可能,在这时会有多个基类实现相同的方法。 好的设计强制要求这种方法在每个情况下具有相同的调用签名(因为调用顺序是在运行时确定的,也因为该顺序要适应类层级结构的更改,还因为该顺序可能包含在运行时之前未知的兄弟类)。
对于以上两个用例,典型的超类调用看起来是这样的:
class C(B):
def method(self, arg):
super().method(arg) # This does the same thing as:
# super(C, self).method(arg)
请注意 super()
是作为显式加点属性查找的绑定过程的一部分来实现的,例如 super().__getitem__(name)
。 它做到这一点是通过实现自己的 __getattribute__()
方法,这样就能以可预测的顺序搜索类,并且支持协作多重继承。 对应地,super()
在像 super()[name]
这样使用语句或操作符进行隐式查找时则未被定义。
还要注意的是,除了零个参数的形式以外,super()
并不限于在方法内部傅和。 两个参数的形式明确指定参数并进行相应的引用。 零个参数的形式仅适用于类定义内部,因为编译器需要填入必要的细节以正确地检索到被定义的类,还需要为普通访问当前实例。
class.__mro__
# 此属性是由类组成的元组,在方法解析期间会基于它来查找基类。
class.mro()
# 此方法可被一个元类来重载,以为其实例定制方法解析顺序。
# 它会在类实例化时被调用,其结果存储于 __mro__ 之中。
getattr(object, name[, default])
# 返回对象命名属性的值。name 必须是字符串。
# 如果该字符串是对象的属性之一,则返回该属性的值。
例如, getattr(x, 'foobar')
等同于 x.foobar
。如果指定的属性不存在,且提供了 default
值,则返回它,否则触发 AttributeError
。