Python 中 Meta Classes详解
接触过Django的同学都应该十分熟悉它的ORM系统。对于python新手而言,这是一项几乎可以被称作“黑科技”的特性:只要你在models.py中随便定义一个Model的子类,Django便可以:
- 获取它的字段定义,并转换成表结构
- 读取Meta内部类,并转化成相应的配置信息。对于特殊的Model(如abstract、proxy),还要进行相应的转换
- 为没有定义objects的Model加上一个默认的Manager
开发之余,我也曾脑补过其背后的原理。曾经,我认为是这样的:
启动时,遍历models.py中的所有属性,找到Model的子类,并对其进行上述的修改。
当初,我还以为自己触碰到了真理,并曾将其应用到实际生产中——为SAE的KVDB写了一个类ORM系统。然而在实现的过程中,我明显感受到了这种方法的丑陋,而且性能并不出色(因为要遍历所有的定义模块)。
那么事实上,Django是怎么实现的呢?
自古以来我们制造东西的方法都是“自上而下”的,是用切削、分割、组合的方法来制造。然而,生命是自下而上地,自发地建造起来的,这个过程极为低廉。 ——王晋康《水星播种》
这句话揭示了生命的神奇所在:真正的生命都是由基本物质自发构成的,而非造物主流水线式的加工。
那么,如果类也有生命的话,对它自己的修饰就不应该由调用者来完成,而应该是自发的。
幸而,python提供了造物主的接口——这便是MetaClasses,或者称为“元类”。
元类是什么?
简单说:元类就是类的类。
首先,要有一个概念:
python中,一切都是对象。
没错,一切,包括类本身。
既然,类是对象,对象是类的实例,那么——类也应该有类才对。
类的类:type
在python中,我们可以用type检测一个对象的类,如:
printtype(1)#<type'int'>
如果对一个类操作呢?
printtype(int)#<type'type'> classMyClass(object):pass printtype(MyClass)#<type'type'> printtype(type)#<type'type'>
这说明:type其实是一个类型,所有类——包括type自己——的类都是type。
type简介
从官方文档中,我们可以知道:
和dict类似,type也是一个工厂构造函数,调用其将返回一个type类型的实例(即类)。
type有两个重载版本:
+`type(object)`,即我们最常用的版本。
+`type(name,bases,dict)`,一个更强大的版本。通过指定类名称(`name`)、父类列表(`bases`)和属性字典(`dict`)动态合成一个类。
下面两个语句等价:
classInteger(int): name='myinteger' defincrease(self,num): returnnum+1 #------------------- Integer=type('Integer',(int,),{ 'name':'myinteger', 'increase':lambdaself,num:\ num+1#很酷的写法,不是么 })
也就是说:类的定义过程,其实是type类型实例化的过程。
然而这和修饰一个已定义的类有什么关系呢?
当然有啦~既然“类的定义”就是“type类型的初始化过程”,那其中必定会调用到type的构造函数(__new__()或__init__())。只要我们继承type类并修改其__new__函数,在这里面动手脚就可以啦。
接下来我们将通过一个栗子感受python的黑魔法,不过在此之前,我们要先了解一个语法糖。
__metaclass__属性
有没觉得上面第二段示例有些鬼畜呢?它勒令程序员将类的成员写成一个字典,简直是反人类。如果我们真的是要通过修改元类来改变类的行为的话,似乎就必须采用这种方法了~~简直可怕~~
好在,python2.2时引进了一个语法糖:__metaclass__。
classInteger(int): __metaclass__=IntMeta
现在将会等价于:
Integer=IntMeta('Integer',(int,),{})
由此一来,我们在使用传统类定义的同时,也可以使用元类啦。
栗子:子类净化器
需求描述
你是一个有语言洁癖的开发者,平时容不得别人讲一句脏话,在开发时也是如此。现在,你写出了一个非常棒的框架,并马上要将它公之于众了。不过,你的强迫症又犯了:如果你的使用者在代码中写满了脏话,怎么办?岂不是玷污了自己的纯洁?
假如你就是这个丧心病狂的开发者,你会怎么做?
在知道元类之前,你可能会无从下手。不过,这个问题你可以用元类轻松解决——只要在类定义时过滤掉不干净的字眼就好了(百度贴吧的干活~~)。
我们的元类看起来会是这样的:
sensitive_words_list=['asshole','fuck','shit'] defdetect_sensitive_words(string): '''检测敏感词汇''' words_detected=filter(lambdaword:wordinstring.lower(),sensitive_words_list) ifwords_detected: raiseNameError('Sensitivewords{0}detectedinthestring"{1}".'\ .format( ','.join(map(lambdas:'"%s"'%s,words_detected)), string ) ) classCleanerMeta(type): def__new__(cls,class_name,bases,attrs): detect_sensitive_words(class_name)#检查类名 map(detect_sensitive_words,attrs.iterkeys())#检查属性名 print"Welldone!Youareapolitecoder!"#如无异常,输出祝贺消息 returnsuper(CleanerMeta,cls).__new__(cls,class_name,bases,attrs) #重要!这行一定不能漏!!这回调用内建的类构造器来构造类,否则定义好的类将会变成None 现在,只需这样定义基类: classAPIBase(object): __metaclass__=CleanerMeta #... 那么所有APIBase的派生类都会接受安全审查(奸笑~~): classImAGoodBoy(APIBase): a_polite_attribute=1 #[Output]Welldone!Youareapolitecoder! classFuckMyBoss(APIBase): pass #[Output]NameError:Sensitivewords"fuck"detectedinthestring"FuckMyBoss". classPretendToBePolite(APIBase): def__fuck_your_asshole(self): pass #[Output]NameError:Sensitivewords"asshole","fuck"detectedinthestring"_PretendToBePolite__fuck_your_asshole".
看,即使像最后一个例子中的私有属性也难逃审查,因为它们本质都是相同的。
甚至,你还可以对有问题的属性进行偷偷的修改,比如让不文明的函数在调用时打出一行警告等等,这里就不多说了。
元类在实际开发中的应用
日常开发时,元类常用吗?
当然,Django的ORM就是一个例子,大名鼎鼎的SQLAlchemy也用了这种黑魔法。
此外,在一些小型的库中,也有元类的身影。比如abc(奇怪的名字~~)——这是python的一个内建库,用于模拟抽象基类(AbstractBaseClasses)。开发者可以使用abc.abstractmethod装饰器,将指定了__metaclass__=abc.ABCMeta的类的方法定义成抽象方法,同时这个类也成了抽象基类,抽象基类是不可实例化的。这便实现了对抽象基类的模拟。
倘若你也有需要动态修改类定义的需求,不妨也试试这种“黑魔法”。
小结
- 类也是对象,所有的类都是type的实例
- 元类(MetaClasses)是类的类
- __metaclass__=Meta是Meta(name,bases,dict)的语法糖
- 可以通过重载元类的__new__方法,修改类定义的行为