Python元类(metaclass)及其用途

2015-03-09 21:32 编程相关 python

"Python元类(metaclass)及其用途"

最近看了一篇讲解元类的文章，写得非常好，叫深刻理解Python中的元类(metaclass)，其实是一篇Stack overflow的热帖，由伯乐在线翻译成了中文。本文后面我会贴出这篇文章的全部内容，但在此之前我想写下我认为的元类的一些要点。

元类是什么？

我们常说python中一切皆对象，那思考一下，类是什么的对象呢？其实答案就是类是元类的对象。所以元类我们也称为类的类。

type

type实际上是个元类，它是元类这个概念，一种具体的表现形式。它是python所有类的元类，即使我们自定义的元类，也是基于它定义的。对于这点，相信对于很多刚认识元类的人来说，有点大开眼界的意思，想不到平常用来检测对象类型的type，还有个如此深井冰的角色。

当我们打印输出类.__class__，它的值为<type 'type'>。这也佐证了type即是所有类的元类。

有了元类或者说type之后，我们就有了另一种创建的类的方法：


xxxxxxxxxx
MyClass = type("MyClass", (), {})

它等价于


xxxxxxxxxx
class MyClass:
    pass

自定义元类

自定义元类有两种方法

方法一：基于函数（不常用）

其实元类不一定要是个class，只要是个可调用对象就行了。下面的upper_attr就可以称之为一个元类。


xxxxxxxxxx
# 元类会自动将你通常传给‘type’的参数作为自己的参数传入
def upper_attr(future_class_name, future_class_parents, future_class_attr):
    '''返回一个类对象，将属性都转为大写形式'''
    #  选择所有不以'__'开头的属性
    attrs = ((name, value) for name, value in future_class_attr.items() if not name.startswith('__'))
        # 将它们转为大写形式
    uppercase_attr = dict((name.upper(), value) for name, value in attrs)
    # 通过'type'来做类对象的创建
    return type(future_class_name, future_class_parents, uppercase_attr)

方法二：基于class，继承type

这种方式更加oop


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

metaclass

__metaclass__是用来给类指定元类


xxxxxxxxxx
class A(object):
    __metaclass__ = MyMetaClass

以上只是python2的定义形式，python3已经改成如下方式


xxxxxxxxxx
class A(metaclass=MyMetaClass)
    pass

重点理解元类的new方法和call方法背后的含义

__new__的原型为__new__(cls, name, bases, attrs)，返回的是元类的对象，元类的对象也就是类。其中name即是类的名字。

__call__的原型__call__(self, *args, **kwargs)，我们知道__call__使得对象实例能够像函数一样被调用。那回到元类这里，这里的对象实例其实就是类，所以实例化一个类时，本质上是调用了元类的__call__方法。这也是用元类实现单例模式的原理所在。

元类的用途

元类给了我们干涉类的创建的能力。比如在django中，用户声明了price=IntegerField()这个field。price明明是个IntegerField对象，那为什么我们用model对象去获取price的时候又是个int值呢？其实答案就是元类搞得鬼，在创建Model类的时候，元类重新整理了Model类的属性，price原本的含义被篡改。

其他常见的元类的用途还有单例模式实现、动态创建类等等。

以下为深刻理解Python中的元类(metaclass)的全部内容

译注：这是一篇在Stack overflow上很热的帖子。提问者自称已经掌握了有关Python OOP编程中的各种概念，但始终觉得元类(metaclass)难以理解。他知道这肯定和自省有关，但仍然觉得不太明白，希望大家可以给出一些实际的例子和代码片段以帮助理解，以及在什么情况下需要进行元编程。于是e-satis同学给出了神一般的回复，该回复获得了985点的赞同点数，更有人评论说这段回复应该加入到Python的官方文档中去。而e-satis同学本人在Stack Overflow中的声望积分也高达64271分。以下就是这篇精彩的回复（提示：非常长）

类也是对象

在理解元类之前，你需要先掌握Python中的类。Python中类的概念借鉴于Smalltalk，这显得有些奇特。在大多数编程语言中，类就是一组用来描述如何生成一个对象的代码段。在Python中这一点仍然成立：


xxxxxxxxxx
>>> class ObjectCreator(object):
…       pass
…
>>> my_object = ObjectCreator()
>>> print my_object
    <__main__.ObjectCreator object at 0x8974f2c>

但是，Python中的类还远不止如此。类同样也是一种对象。是的，没错，就是对象。只要你使用关键字class，Python解释器在执行的时候就会创建一个对象。下面的代码段：


xxxxxxxxxx
>>> class ObjectCreator(object):
…       pass
…

将在内存中创建一个对象，名字就是ObjectCreator。这个对象（类）自身拥有创建对象（类实例）的能力，而这就是为什么它是一个类的原因。但是，它的本质仍然是一个对象，于是乎你可以对它做如下的操作：

你可以将它赋值给一个变量
你可以拷贝它
你可以为它增加属性
你可以将它作为函数参数进行传递

下面是示例：


xxxxxxxxxx
>>> print ObjectCreator     # 你可以打印一个类，因为它其实也是一个对象
<class '__main__.ObjectCreator'>
>>> def echo(o):
…       print o
…
>>> echo(ObjectCreator)                 # 你可以将类做为参数传给函数
<class '__main__.ObjectCreator'>
>>> print hasattr(ObjectCreator, 'new_attribute')
Fasle
>>> ObjectCreator.new_attribute = 'foo' #  你可以为类增加属性
>>> print hasattr(ObjectCreator, 'new_attribute')
True
>>> print ObjectCreator.new_attribute
foo
>>> ObjectCreatorMirror = ObjectCreator # 你可以将类赋值给一个变量
>>> print ObjectCreatorMirror()
<__main__.ObjectCreator object at 0x8997b4c>

动态地创建类

因为类也是对象，你可以在运行时动态的创建它们，就像其他任何对象一样。首先，你可以在函数中创建类，使用class关键字即可。


xxxxxxxxxx
>>> def choose_class(name):
…       if name == 'foo':
…           class Foo(object):
…               pass
…           return Foo     # 返回的是类，不是类的实例
…       else:
…           class Bar(object):
…               pass
…           return Bar
…
>>> MyClass = choose_class('foo')
>>> print MyClass              # 函数返回的是类，不是类的实例
<class '__main__'.Foo>
>>> print MyClass()            # 你可以通过这个类创建类实例，也就是对象
<__main__.Foo object at 0x89c6d4c>

但这还不够动态，因为你仍然需要自己编写整个类的代码。由于类也是对象，所以它们必须是通过什么东西来生成的才对。当你使用class关键字时，Python解释器自动创建这个对象。但就和Python中的大多数事情一样，Python仍然提供给你手动处理的方法。还记得内建函数type吗？这个古老但强大的函数能够让你知道一个对象的类型是什么，就像这样：


xxxxxxxxxx
>>> print type(1)
<type 'int'>
>>> print type("1")
<type 'str'>
>>> print type(ObjectCreator)
<type 'type'>
>>> print type(ObjectCreator())
<class '__main__.ObjectCreator'>

这里，type有一种完全不同的能力，它也能动态的创建类。type可以接受一个类的描述作为参数，然后返回一个类。（我知道，根据传入参数的不同，同一个函数拥有两种完全不同的用法是一件很傻的事情，但这在Python中是为了保持向后兼容性）

type可以像这样工作：


xxxxxxxxxx
type(类名, 父类的元组（针对继承的情况，可以为空），包含属性的字典（名称和值）)

比如下面的代码：


xxxxxxxxxx
>>> class MyShinyClass(object):
…       pass

可以手动像这样创建：


xxxxxxxxxx
>>> MyShinyClass = type('MyShinyClass', (), {})  # 返回一个类对象
>>> print MyShinyClass
<class '__main__.MyShinyClass'>
>>> print MyShinyClass()  #  创建一个该类的实例
<__main__.MyShinyClass object at 0x8997cec>

你会发现我们使用“MyShinyClass”作为类名，并且也可以把它当做一个变量来作为类的引用。类和变量是不同的，这里没有任何理由把事情弄的复杂。

type 接受一个字典来为类定义属性，因此


xxxxxxxxxx
>>> class Foo(object):
…       bar = True

可以翻译为：


xxxxxxxxxx
>>> Foo = type('Foo', (), {'bar':True})

并且可以将Foo当成一个普通的类一样使用：


xxxxxxxxxx
>>> print Foo
<class '__main__.Foo'>
>>> print Foo.bar
True
>>> f = Foo()
>>> print f
<__main__.Foo object at 0x8a9b84c>
>>> print f.bar
True

当然，你可以向这个类继承，所以，如下的代码：


xxxxxxxxxx
>>> class FooChild(Foo):
…       pass

就可以写成：


xxxxxxxxxx
>>> FooChild = type('FooChild', (Foo,),{})
>>> print FooChild
<class '__main__.FooChild'>
>>> print FooChild.bar   # bar属性是由Foo继承而来
True

最终你会希望为你的类增加方法。只需要定义一个有着恰当签名的函数并将其作为属性赋值就可以了。


xxxxxxxxxx
>>> def echo_bar(self):
…       print self.bar
…
>>> FooChild = type('FooChild', (Foo,), {'echo_bar': echo_bar})
>>> hasattr(Foo, 'echo_bar')
False
>>> hasattr(FooChild, 'echo_bar')
True
>>> my_foo = FooChild()
>>> my_foo.echo_bar()
True

你可以看到，在Python中，类也是对象，你可以动态的创建类。这就是当你使用关键字class时Python在幕后做的事情，而这就是通过元类来实现的。