类级语法 ¶

Author:	王蒙
Tags:	Python 开发，语法
abstract:	本章简述 Python 中类级的复杂语法，包括 super 函数，descriptor，装饰器和元类等等。

Contents

类级语法

Problem ¶

super 函数
descriptor
property
classmethod
abstractmethod
meta programming
- decorator
- metaclass
Mixin

Solution ¶

继承 built-in types ¶

built-in types 支持些特别的运算符。继承时，重写 built-in type 的某些方法，就可以重定义这些运算符。

常见的，__getitem__ 对应 a[k] 运算符， __setitem__ 对应 a[k] = 11 运算符。

定义序的时候，优先使用 @totalordering 运算符。

在重写运算符，继承 built-in types 时，应该先去 collections 包中找找有没有现成的实现。大多数情况写，用不着重写运算符，继承 built-in types 。

使用父类的方法 ¶

super() 用于获得父类的方法。 super() 可以用在任何上下文中，不一定非要在类方法中出现。 super() 常见的用法有如下三种：

super(instance_type, instance_value): instance_value 必须属于 instance_type 否则会报错。instance_value 属于 instance_type 的情况下，返回 instance_value 对应的 type 的 mro 中 instance_type 后一个 type。

super(instance_type): 返回 instance_type 的 mro 中 instance_type 后一个 type。

super(): python3 的语法（Python2 不支持），出现在类方法中。如果 super() 出现在普通方法中，相当于 super(defined_class, self)；如果出现在普通的类方法中相当于 super(defined_class)；如果出现在 staticmethod 中会报 RuntimeError。

除了使用 super() 获得父类方法，还可以使用 superclass 的类名直接获得 superclass 的方法。尽量不要同时使用 super 和 superclass 类名两种访问父类的方法。

Python 子类默认不会调用父类的 __init__ 函数（初始化函数），如果需要，需要开发者自行调用，调用时，如果不清楚父类 __init__ 函数的 signature, 可以查文档或者读源码。

Python3 所有的类都继承自 object 类， Python2 中有继承自 object 的类，也有不是继承自 object 的类。继承自 object 的类称为新式类(new style class)，不是继承自 object 的类称为旧式类(old style class)。新式类使用 C3 算法解决多重继承问题，旧式类使用深度优先解决多重继承问题。新式类有 mro 方法和 __mro__ 属性；旧式类没有。

Python3 中所有类都是新式类，不管怎么定义类。 Python2 中只有明确继承自 object 或者继承自其它新式类的类才是新式类。除此之外是旧式类。比如如下 Python2 代码：

# 旧式类
class A:
    pass

# 旧式类
class B():
    pass

# 旧式类
class C(A):
    pass

# 新式类
class D(object):
    pass

# 新式类
class E(D):
    pass

如果代码要运行在 Python2 和 Python3 环境，那么定义类时，一定要指明继承于那个类。一定都用新式类。

即使旧式类没有 mro ，但是仍然可以使用 super 。最好不要用旧式类。

mro(method resolve order)， Python 新式类使用 C3 算法计算 mro。对于多重继承，C3 给出给类的线性排列。C3 算法计算公式为：

class MyClass(Base1, Base2):
    pass

L(MyClass) = MyClass + merge(L[Base1], L[Base2], Base1, Base2)

下面是摘抄的 C3 算法的解释：

The liberalization of C is the sum of C plus the merge of the liberalizations of the parents and the list of the
parents.

Taken the head of the first list, that is, L[Base1][0]; if this head is not in the tail of any of the other
lists, then add it to the liberalization of MyClass and remove it from the lists in the merge, otherwise look at
the head of the next list and take it, if it is a good head.

Then, repeat the operation until all the classes are removed or it is impossible to find good heads. In this
case, it is impossible to construct the merge, Python 2.3 will refuse to create the class MyClass and will raise
an exception.

Best Practices ¶

尽量不要使用多重继承
super 和 explicit class calls 不要混在一起使用
如果你的代码要兼容 Python2，定义类时一定要继承自 object
调用父类方法时，确认下父类是谁（比如用 mro() 方法）

Descriptor ¶

descriptor 是获取和设置属性的中间件。descriptor 又称自定义 property，大多数情况下定义个 property 就够用了。

descriptor 协议:

__get__(self, obj, type=None)

__set__(self, obj, value)

__delete__(self, obj)

实现了 __get__() and __set__() 的 descriptor 称为 *data descriptor 。如果 descriptor 只实现了 __get__(), 这个 descriptor 称为 non-data descriptor 。

不管是 instance.attribute 或者是 getattr(instance, ‘attribute’), 都是调用 __getattribute__() 去寻找属性， __getattribute__() 寻找属性的默认顺序为：

It verifies if the attribute is a data descriptor on the class object of the instance.

If not, it looks to see if the attribute can be found in the __dict__ of the instance object.

Finally, it looks to see if the attribute is a non-data descriptor on the class object of the instance.

我认为这段描述没有谈到 MRO 对于 __getattribute__() 的影响。我补充一点就是父类的 data-descriptor 也是子类的 data-descriptor，父类的 non-descriptor 也是子类的 non-descriptor。

metaclass ¶

metaclass 原理和例子

Python3 中用如下的方式使用元类（metaclass）

class B(metaclass=MetaClass):
    ...

class C(B):
    ...

Python 2 中使用如下的方式使用元类（metaclass）

class B(object):

    __mataclass__ = MetaClass

可以使用 six 写出`兼容 python2 和 python3 的元类`_ 。

metaclass 常见的应用

元类（metaclass）很少用。使用 metaclass 请慎重，多想想有没有更简单的方法。

实际使用元类（metaclass）的例子：

ORM: https://github.com/django/django/blob/master/django/db/models/base.py

todo: django 代码比较多，有时间的话，慢慢看。

interface

可以使用 zope.interface 中的 Interface, implements 定义接口。虽然 zope 已经风光不再，但是 zope.interface 仍然常用。静态语言能在编译时，警告你要实现 Interface 中的方法，Python 是动态语言，需要写测试用例，运行测试用例时，会提示你实现Interface 中的方法。

使用 abc 包中的 abstractmethod 也可以定义接口。

重写 __subhook__ 方法，可以定义 isinstance 行为。

Reference ¶

Python cookbook chapter 9 meta programming.
Expert Python Programming Chapter 3 Syntax Best Practices above the class level.
PEP 422: https://www.python.org/dev/peps/pep-0422/

类级语法 ¶

Audience ¶

Prerequisites ¶