四、自定义元类

到现在,我们已经知道元类是什么东东了。那么,从始至终我们还不知道元类到底有啥用。只是了解了一下元类。在了解它有啥用的时候,我们先来了解下怎么自定义元类。因为只有了解了怎么自定义才能更好的理解它的作用。

首先我们来了解下 __metaclass__ 属性

metaclass,直译为元类,简单的解释就是:

当我们定义了类以后,就可以根据这个类创建出实例,所以:先定义类,然后创建实例。

但是如果我们想创建出类呢?那就必须根据metaclass创建出类,所以:先定义metaclass,然后创建类。

连接起来就是:先定义metaclass,就可以创建类,最后创建实例。

所以,metaclass允许你创建类或者修改类。换句话说,你可以把类看成是metaclass创建出来的“实例”。

  1. class MyObject(object):
  2. __metaclass__ = something
  3. […]

如果是这样写的话,Python 就会用元类来创建类 MyObject。当你写下 class MyObject(object),但是类对象 MyObject 还没有在内存中创建。Python 会在类的定义中寻找 __metaclass__ 属性,如果找到了,Python 就会用它来创建类 MyObject,如果没有找到,就会用内建的 type 函数来创建这个类。如果还不怎么理解,看下下面的流程图:

__metaclass__的介绍

再举个实例:

  1. class Foo(Bar):
  2. pass

它的判断流程是怎样的呢?

首先判断 Foo 中是否有 __metaclass__ 这个属性?如果有,Python 会在内存中通过 __metaclass__ 创建一个名字为 Foo 的类对象(注意,这里是类对象)。如果 Python 没有找到__metaclass__ ,它会继续在 Bar(父类)中寻找__metaclass__ 属性,并尝试做和前面同样的操作。如果 Python在任何父类中都找不到 __metaclass__ ,它就会在模块层次中去寻找 __metaclass__ ,并尝试做同样的操作。如果还是找不到` metaclass` ,Python 就会用内置的 type 来创建这个类对象。

其实 __metaclass__ 就是定义了 class 的行为。类似于 class 定义了 instance 的行为,metaclass 则定义了 class 的行为。可以说,class 是 metaclass 的 instance。

现在,我们基本了解了 __metaclass__ 属性,但是,也没讲过如何使用这个属性,或者说这个属性可以放些什么?

答案就是:可以创建一个类的东西。那么什么可以用来创建一个类呢?type,或者任何使用到 type 或者子类化 type 的东东都可以。

元类的主要目的就是为了当创建类时能够自动地改变类。通常,你会为API 做这样的事情,你希望可以创建符合当前上下文的类。假想一个很傻的例子,你决定在你的模块里所有的类的属性都应该是大写形式。有好几种方法可以办到,但其中一种就是通过在模块级别设定__metaclass__ 。采用这种方法,这个模块中的所有类都会通过这个元类来创建,我们只需要告诉元类把所有的属性都改成大写形式就万事大吉了。

幸运的是,__metaclass__ 实际上可以被任意调用,它并不需要是一个正式的类。所以,我们这里就先以一个简单的函数作为例子开始。

  1. # 元类会自动将你通常传给‘type’的参数作为自己的参数传入
  2. def upper_attr(future_class_name, future_class_parents, future_class_attr):
  3. '''返回一个类对象,将属性都转为大写形式'''
  4. # 选择所有不以'__'开头的属性
  5. attrs = ((name, value) for name, value in future_class_attr.items() if not name.startswith('__'))
  1. # 将它们转为大写形式
  2. uppercase_attr = dict((name.upper(), value) for name, value in attrs)
  3. # 通过'type'来做类对象的创建
  4. return type(future_class_name, future_class_parents, uppercase_attr)
  5. __metaclass__ = upper_attr
  6. # 这会作用到这个模块中的所有类
  7. class Foo(object):
  8. # 我们也可以只在这里定义__metaclass__,这样就只会作用于这个类中
  9. bar = 'bip'
  1. print hasattr(Foo, 'bar')
  2. # 输出: False
  3. print hasattr(Foo, 'BAR')
  4. # 输出:True
  5. f = Foo()
  6. print f.BAR
  7. # 输出:'bip'

用 class 当做元类的做法:

  1. # 请记住,'type'实际上是一个类,就像'str'和'int'一样
  2. # 所以,你可以从type继承
  3. class UpperAttrMetaClass(type):
  4. # __new__ 是在__init__之前被调用的特殊方法
  5. # __new__是用来创建对象并返回之的方法
  6. # 而__init__只是用来将传入的参数初始化给对象
  7. # 你很少用到__new__,除非你希望能够控制对象的创建
  8. # 这里,创建的对象是类,我们希望能够自定义它,所以我们这里改写__new__
  9. # 如果你希望的话,你也可以在__init__中做些事情
  10. # 还有一些高级的用法会涉及到改写__call__特殊方法,但是我们这里不用
  11. def __new__(upperattr_metaclass, future_class_name, future_class_parents, future_class_attr):
  12. attrs = ((name, value) for name, value in future_class_attr.items() if not name.startswith('__'))
  13. uppercase_attr = dict((name.upper(), value) for name, value in attrs)
  14. return type(future_class_name, future_class_parents, uppercase_attr)

但是,这种方式其实不是 OOP。我们直接调用了 type,而且我们没有改写父类的 __new__ 方法。现在让我们这样去处理:

  1. class UpperAttrMetaclass(type):
  2. def __new__(upperattr_metaclass, future_class_name, future_class_parents, future_class_attr):
  3. attrs = ((name, value) for name, value in future_class_attr.items() if not name.startswith('__'))
  4. uppercase_attr = dict((name.upper(), value) for name, value in attrs)
  5. # 复用type.__new__方法
  6. # 这就是基本的OOP编程,没什么魔法
  7. return type.__new__(upperattr_metaclass, future_class_name, future_class_parents, uppercase_attr)

你可能已经注意到了有个额外的参数 upperattr_metaclass ,这并没有什么特别的。类方法的第一个参数总是表示当前的实例,就像在普通的类方法中的 self 参数一样。当然了,为了清晰起见,这里的名字我起的比较长。但是就像 self 一样,所有的参数都有它们的传统名称。因此,在真实的产品代码中一个元类应该是像这样的:

  1. class UpperAttrMetaclass(type):
  2. def __new__(cls, name, bases, dct):
  3. attrs = ((name, value) for name, value in dct.items() if not name.startswith('__')
  4. uppercase_attr = dict((name.upper(), value) for name, value in attrs)
  5. return type.__new__(cls, name, bases, uppercase_attr)

如果使用 super 方法的话,我们还可以使它变得更清晰一些,这会缓解继承(是的,你可以拥有元类,从元类继承,从 type 继承)

  1. class UpperAttrMetaclass(type):
  2. def __new__(cls, name, bases, dct):
  3. attrs = ((name, value) for name, value in dct.items() if not name.startswith('__'))
  4. uppercase_attr = dict((name.upper(), value) for name, value in attrs)
  5. return super(UpperAttrMetaclass, cls).__new__(cls, name, bases, uppercase_attr)

通常我们都会使用元类去做一些晦涩的事情,依赖于自省,控制继承等等。确实,用元类来搞些“黑暗魔法”是特别有用的,因而会搞出些复杂的东西来。但就元类本身而言,它们其实是很简单的:

  • 拦截类的创建
  • 修改类
  • 返回修改之后的类