Python元类metaclass

2015-08-14 本文已影响1424人 TypingQuietly

最近接触到一个对xml进行序列化的python库，实际上可以理解为一个小的ORM，只不过数据的来源是xml而不是数据库。这个库能够根据xml的结构定义自己的model class，在model class的字段中指定要提取的数据在xml文件结构中的xpath路径，用lxml对xpath路径进行解析，最后能够将xml数据序列化成普通的python对象进行消费，不必每次手动的对各个节点进行操作，即便有lxml这类封装程度比较高的库来操作xml，也依然没有这么优雅和自动化。因为进行序列化自定义的类由用户定义，我们事先不会知道会有哪些字段，所以就需要动态的获取自定义类的属性、方法等数据，这样才能达到定制的目的，所以这个时候元类metaclass也就能派上用场了。

元类metaclass应该算是python元编程的一部分，可以粗暴的理解为类的类，一般我们根据类创建实例，有了元类，我们就可以使用元类创建类。

先拿一个简短的例子（来源于廖雪峰老师的python教程）给大家一个简单的印象：

class ListMetaclass(type):
    def __new__(cls, name, bases, attrs):
        attrs['add'] = lambda self, value: self.append(value)
        return type.__new__(cls, name, bases, attrs)

class MyList(list):
    __metaclass__ = ListMetaclass

my_list = MyList()
my_list.add(1)
print my_list
print type(my_list)
print type(MyList)
print type(list)

output:
    [1]
    <class '__main__.MyList'>
    <class '__main__.ListMetaclass'>
    <type 'type'>

上面这段代码创建了一个包含一个add方法自定义的列表类型，从输出的内容可以看到，自定义的MyList能够正常工作，MyList的类型是ListMetaclass,实例my_list的类型是MyList，内置的类list类型是type。稍稍对比一下，MyList仿佛就是ListMetaclass的实例，因为它确实是type.__new__(cls, name, bases, attrs)这条语句创建的。另外默认情况下新式类会自动使用元类type，所以type（list）的值是<type 'type'>。
在元类中具体创建类的语句中，我们调用了type的方法__new__，传递的四个参数分别是：元类对象、要创建的类的名字、要创建的类继承的父类、要创建的类中定义的属性。这些信息能够充分利用来对要定义的类进行定制。这里类ListmetaClass的作用有点像“工厂”，不过元类的作用不止于此。我们能够在元类中定义一些方法，这些方法不是静态方法却非常像静态方法，它们能够直接被类对象调用，这样方便在自定义类的时候增加一些更丰富的功能:

class ModelBase(type):
    def __new__(cls, name, bases, attrs):
        attrs['xxxx'] = cls.do_something(*args);
        return type.__new__(cls, name, bases, attrs)
    def do_something(cls, *args):
        pass

在使用metaclass的过程中，一般会定义一个继承自type的元类元结合__new__和__init__来使用，不过我们也能直接定义函数或者可执行的类（实现__call__):

def init_attributes(name, bases, dict):
    if 'attributes' in dict:
        for attr in dict['attributes']:
            dict[attr] = None

    return type(name, bases, dict)

class Initialised(object):
    __metaclass__ = init_attributes
    attributes = ['foo', 'bar', 'baz']

print 'foo =>', Initialised.foo
    
# output=>
    foo => None

或者

class MetaSingleton(type):
    instance = None
    def __call__(cls, *args, **kw):
        if cls.instance is None:
            cls.instance = super(MetaSingleton, cls).__call__(*args, **kw)
        return cls.instance

 class Foo(object):
     __metaclass__ = MetaSingleton

 a = Foo()
 b = Foo()
 assert a is b

最后还是拿廖雪峰老师github的一个simple orm的例子（廖老师的脑残粉的节奏么 <(￣︶￣)>）来简单的分析一下metaclass稍微复杂点的用法：
这个例子粗略的还原了metaclass在实际中能够发挥的作用，用户定义自己的db类，db类字段，创建实例然后操作保存（虽然例子中并没有真正的保存，只是打出一些log）。例子的关键部分当然在ModelMetaclass中，将自定义的类中定义的一些属性比如id,name,email,password保存在一个__mappings__的属性中，清空原有的属性防止冲突重复。当调用save进行保存的时候就能使用这些信息。
有几个细节需要注意的是：

if name=='Model': return type.__new__(cls, name, bases, attrs)这两行代码能够排除对Model（dict)的更改，基类Model（dict)只是定义了一些能够被继承自这个类的自定义类比如说像User使用的一些复用的方法
当我们自定义自己的类的时候，虽然自己并没有自定义__metaclass__字段，但因为继承子基类Model（dict)，能够向上查找并使用到元类ModelMetaclass
当python解释器执行到我们自定义的类（遇到class关键字）的时候，会先执行类的逻辑，收集在自定义的类中定义的属性信息，接着执行元类的__new__方法创建类型，如果有定义__init__则会这个方法完成一些初始化的工作，然后整个类的定制化也就完成了。看过有的代码会直接在__init__方法中对自定义的类进行定制，但是考虑到执行的周期，这个时候自定义的类应该已经默认由type.__new__创建好，这个时候再进行定制化其实只是在类上动态的增加了一些属性，虽然也能达到类似的效果，但并不是推荐的做法，至少当你查看类型的时候显示是<type 'type'>也会觉得混淆和奇怪。

好了，差不多就说到这里吧，大家还想深入了解的话建议着一些标准的代码一边调试一边消化和深入，如果有时间造造轮子，相信那也是极好的。

文章中的内容是自己参考了众多文章自己消化理解后的产物，可能会有一些理解偏妥的地方，欢迎大家指正。

注：文章中部分内容参考资源：
https://docs.python.org/2/reference/datamodel.html#customizing-class-creation
http://stackoverflow.com/questions/100003/what-is-a-metaclass-in-python/100037#100037
http://stackoverflow.com/questions/100003/what-is-a-metaclass-in-python
http://blog.ionelmc.ro/2015/02/09/understanding-python-metaclasses/
http://www.liaoxuefeng.com/wiki/001374738125095c955c1e6d8bb493182103fac9270762a000/001386820064557c69858840b4c48d2b8411bc2ea9099ba000

Python元类metaclass

猜你喜欢

热点阅读