python基础——使用元类

阅读量：5368 次

发布时间：2019-06-15

本文共 11508 字，大约阅读时间需要 38 分钟。

python基础——使用元类

type()

　　动态语言和静态语言最大的不同，就是函数和类的定义，不是编译时定义的，而是运行时动态创建的。

　　比方说我们要定义一个Hello的class，就写一个hello.py模块：

class Hello(object):    def hello(self, name='world'):        print('Hello, %s.' % name)

　　当Python解释器载入hello模块时，就会依次执行该模块的所有语句，执行结果就是动态创建出一个Hello的class对象，测试如下：

>>> from hello import Hello>>> h = Hello()>>> h.hello()Hello, world.>>> print(type(Hello))
     
      >>> print(type(h))

　　type()函数可以查看一个类型或变量的类型，Hello是一个class，它的类型就是type，而h是一个实例，它的类型就是class Hello。

　　我们说class的定义是运行时动态创建的，而创建class的方法就是使用type()函数。

　　type()函数既可以返回一个对象的类型，又可以创建出新的类型，比如，我们可以通过type()函数创建出Hello类，而无需通过class Hello(object)...的定义：

>>> def fn(self, name='world'): # 先定义函数...     print('Hello, %s.' % name)...>>> Hello = type('Hello', (object,), dict(hello=fn)) # 创建Hello class>>> h = Hello()>>> h.hello()Hello, world.>>> print(type(Hello))
     
      >>> print(type(h))

　　要创建一个class对象，type()函数依次传入3个参数：

class的名称；

继承的父类集合，注意Python支持多重继承，如果只有一个父类，别忘了tuple的单元素写法；

包含属性的字典（名称和值）；class的方法名称与函数绑定，这里我们把函数fn绑定到方法名hello上。

　　通过type()函数创建的类和直接写class是完全一样的，因为Python解释器遇到class定义时，仅仅是扫描一下class定义的语法，然后调用type()函数创建出class。

　　正常情况下，我们都用class Xxx...来定义类，但是，type()函数也允许我们动态创建出类来，也就是说，动态语言本身支持运行期动态创建类，这和静态语言有非常大的不同，要在静态语言运行期创建类，必须构造源代码字符串再调用编译器，或者借助一些工具生成字节码实现，本质上都是动态编译，会非常复杂。

metaclass

　　除了使用type()动态创建类以外，要控制类的创建行为，还可以使用metaclass。

　　metaclass，直译为元类，简单的解释就是：

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

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

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

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

　　metaclass是Python面向对象里最难理解，也是最难使用的魔术代码。正常情况下，你不会碰到需要使用metaclass的情况，所以，以下内容看不懂也没关系，因为基本上你不会用到。

　　我们先看一个简单的例子，这个metaclass可以给我们自定义的MyList增加一个add方法：

　　定义ListMetaclass，按照默认习惯，metaclass的类名总是以Metaclass结尾，以便清楚地表示这是一个metaclass：

# metaclass是类的模板，所以必须从`type`类型派生：class ListMetaclass(type):    def __new__(cls, name, bases, attrs):        attrs['add'] = lambda self, value: self.append(value)        return type.__new__(cls, name, bases, attrs)

　　有了ListMetaclass，我们在定义类的时候还要指示使用ListMetaclass来定制类，传入关键字参数metaclass：

class MyList(list, metaclass=ListMetaclass):    pass

　　当我们传入关键字参数metaclass时，魔术就生效了，它指示Python解释器在创建MyList时，要通过ListMetaclass.__new__()来创建，在此，我们可以修改类的定义，比如，加上新的方法，然后，返回修改后的定义。

　　__new__()方法接收到的参数依次是：

当前准备创建的类的实例（类方法的第一个参数总是表示当前的实例，就像在普通的类方法中的self参数一样）；

类的名字；

类继承的父类集合；

类的方法集合。

测试一下MyList是否可以调用add()方法：

>>> L = MyList()>>> L.add(1)>> L[1]

　　而普通的list没有add()方法：

>>> L2 = list()>>> L2.add(1)Traceback (most recent call last):  File "
     
      ", line 1, in 
      
       AttributeError: 'list' object has no attribute 'add'

　　动态修改有什么意义？直接在MyList定义中写上add()方法不是更简单吗？正常情况下，确实应该直接写，通过metaclass修改纯属变态。

　　但是，总会遇到需要通过metaclass修改类定义的。ORM就是一个典型的例子。

　　ORM全称“Object Relational Mapping”，即对象-关系映射，就是把关系数据库的一行映射为一个对象，也就是一个类对应一个表，这样，写代码更简单，不用直接操作SQL语句。

　　要编写一个ORM框架，所有的类都只能动态定义，因为只有使用者才能根据表的结构定义出对应的类来。

　　让我们来尝试编写一个ORM框架。

编写底层模块的第一步，就是先把调用接口写出来。比如，使用者如果使用这个ORM框架，想定义一个User类来操作对应的数据库表User，我们期待他写出这样的代码：

class User(Model):    # 定义类的属性到列的映射：    id = IntegerField('id')    name = StringField('username')    email = StringField('email')    password = StringField('password')# 创建一个实例：u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')# 保存到数据库：u.save()

　　其中，父类Model和属性类型StringField、IntegerField是由ORM框架提供的，剩下的魔术方法比如save()全部由metaclass自动完成。虽然metaclass的编写会比较复杂，但ORM的使用者用起来却异常简单。

　　现在，我们就按上面的接口来实现该ORM。

　　首先来定义Field类，它负责保存数据库表的字段名和字段类型：

class Field(object):    def __init__(self, name, column_type):        self.name = name        self.column_type = column_type    def __str__(self):        return '<%s:%s>' % (self.__class__.__name__, self.name)

　　在Field的基础上，进一步定义各种类型的Field，比如StringField，IntegerField等等：

class StringField(Field):    def __init__(self, name):        super(StringField, self).__init__(name, 'varchar(100)')class IntegerField(Field):    def __init__(self, name):        super(IntegerField, self).__init__(name, 'bigint')

　　下一步，就是编写最复杂的ModelMetaclass了：

class ModelMetaclass(type):    def __new__(cls, name, bases, attrs):        if name=='Model':            return type.__new__(cls, name, bases, attrs)        print('Found model: %s' % name)        mappings = dict()        for k, v in attrs.items():            if isinstance(v, Field):                print('Found mapping: %s ==> %s' % (k, v))                mappings[k] = v        for k in mappings.keys():            attrs.pop(k)        attrs['__mappings__'] = mappings # 保存属性和列的映射关系        attrs['__table__'] = name # 假设表名和类名一致        return type.__new__(cls, name, bases, attrs)

　　以及基类Model：

class Model(dict, metaclass=ModelMetaclass):    def __init__(self, **kw):        super(Model, self).__init__(**kw)    def __getattr__(self, key):        try:            return self[key]        except KeyError:            raise AttributeError(r"'Model' object has no attribute '%s'" % key)    def __setattr__(self, key, value):        self[key] = value    def save(self):        fields = []        params = []        args = []        for k, v in self.__mappings__.items():            fields.append(v.name)            params.append('?')            args.append(getattr(self, k, None))        sql = 'insert into %s (%s) values (%s)' % (self.__table__, ','.join(fields), ','.join(params))        print('SQL: %s' % sql)        print('ARGS: %s' % str(args))

　　当用户定义一个class User(Model)时，Python解释器首先在当前类User的定义中查找metaclass，如果没有找到，就继续在父类Model中查找metaclass，找到了，就使用Model中定义的metaclass的ModelMetaclass来创建User类，也就是说，metaclass可以隐式地继承到子类，但子类自己却感觉不到。

　　在ModelMetaclass中，一共做了几件事情：

排除掉对Model类的修改；

在当前类（比如User）中查找定义的类的所有属性，如果找到一个Field属性，就把它保存到一个__mappings__的dict中，同时从类属性中删除该Field属性，否则，容易造成运行时错误（实例的属性会遮盖类的同名属性）；

把表名保存到__table__中，这里简化为表名默认为类名。

　　在Model类中，就可以定义各种操作数据库的方法，比如save()，delete()，find()，update等等。

　　我们实现了save()方法，把一个实例保存到数据库中。因为有表名，属性到字段的映射和属性值的集合，就可以构造出INSERT语句。

　　编写代码试试：

u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')u.save()

　　输出如下：

　　可以看到，save()方法已经打印出了可执行的SQL语句，以及参数列表，只需要真正连接到数据库，执行该SQL语句，就可以完成真正的功能。

　　不到100行代码，我们就通过metaclass实现了一个精简的ORM框架。

小结

　　metaclass是Python中非常具有魔术性的对象，它可以改变类创建时的行为。这种强大的功能使用起来务必小心。

参考源码：

1 #python 使用元类   示例  2 #2016-8-30 19:37:49  3 #MengmengCoding  4 # -*- coding: utf-8 -*-  5   6 #可以通过type()函数创建出Hello类，而无需通过class Hello(object)...的定义  7 #即可通过type()在运行期间动态创建类，而不像其它静态语言需先定义类，才使用  8   9 def fn(self,name='Shuke'):    #先定义函数 10     print('Hello, %s.' %name) 11      12 HelloClass=type('HelloClass',(object,),dict(hello=fn))    #创建HelloClass类 13  14 h=HelloClass()    #实例化一个HelloClass 15 print('call h.hello():') 16 h.hello() 17 print('type(HelloClass) =', type(HelloClass)) 18 print('type(h)=',type(h)) 19 #输出： 20 ''' 21 call h.hello(): 22 Hello, Shuke. 23 type(HelloClass) = 
      
        24 type(h)= 
       
         25 ''' 26 #---------------------------------------------------------------------------# 27 ''' 28 使用type()创建一个class对象的要点： 29 ***************************************************************************** 30 要创建一个class对象，type()函数依次传入3个参数： 31 1、class的名称； 32 2、继承的父类集合，注意Python支持多重继承， 33 如果只有一个父类，别忘了tuple的单元素写法； 34 3、包含属性的字典（名称和值）；class的方法名称与函数绑定，这里我们把函数fn绑定到方法名hello上。 35 ***************************************************************************** 36 ''' 37 #---------------------------------------------------------------------------# 38  39 #可以使用meraclass创建类，修改类的行为 40 #eg:使用metaclass给自定义的MyList增加一个add方法 41  42 #metaclass是创建类，所以必须从'type'类型派生： 43 class ListMetaclass(type):        #按照默认习惯，metaclass的类名总是以Metaclass结尾，以便清楚地表示这是一个metaclass 44     # __new__ 是在__init__之前被调用的特殊方法 45     # __new__是用来创建对象并返回之的方法 46     # 而__init__只是用来将传入的参数初始化给对象 47     # 你很少用到__new__，除非你希望能够控制对象的创建 48     # 这里，创建的对象是类，我们希望能够自定义它，所以我们这里改写__new__ 49     def __new__(cls,name,bases,attrs): 50         attrs['add']=lambda self,value:    self.append(value) 51         return type.__new__(cls,name,bases,attrs) 52          53 #指示使用ListMetaclass来定制类 54 ''' 55 传入关键字参数metaclass时 56 它指示Python解释器在创建MyList时，要通过ListMetaclass.__new__()来创建， 57 在此，我们可以修改类的定义， 58 比如，加上新的方法，然后，返回修改后的定义 59 ''' 60 class MyList(list,metaclass=ListMetaclass):        #MyList继承list类，且使用ListMetaclass来定制类 61     pass 62  63 L=MyList() 64 L.add(1) 65 L.add(2) 66 L.add(3) 67 L.add('END') 68 print(L) 69 #输出：[1, 2, 3, 'END'] 70 ''' 71 __new__()方法接收到的参数依次是: 72 1、当前准备创建的类的实例（类方法的第一个参数总是表示当前的实例， 73 就像在普通的类方法中的self参数一样） 74  75 2、类的名字； 76  77 3、类继承的父类集合； 78  79 4、类的方法集合。 80 ''' 81  82 #练习： 83 #尝试编写一个ORM（Object Relational Mapping）框架 84  85 #首先来定义Field类，它负责保存数据库表的字段名和字段类型 86  87 class Field(object): 88  89     def __init__(self,name,column_type): 90         self.name=name 91         self.column_type=column_type 92          93     def __str__(self): 94         #自定义print时输出的字符串：
        
          95         return '<%s:%s>' % (self.__class__.__name__, self.name) 96          97 #在Field的基础上，进一步定义各种类型的Field，比如StringField，IntegerField等等 98  99 class StringField(Field):100     101     def __init__(self,name):102         #子类里访问父类的同名属性，而又不想直接引用父类的名字103         #此时可使用super()104         super(StringField,self).__init__(name,'varchar(100)')105 106 107 class IntegerField(Field):108     109     def __init__(self,name):110         super(IntegerField,self).__init__(name,'bigint')111         112 113 #编写ModelMetaclass114 class ModelMetaclass(type):115     116     def __new__(cls,name,bases,attrs):117         if name=='Model':118             # 通过'type'来做类对象的创建119             return type.__new__(cls,name,bases,attrs)120         print('Found model: %s' %name)121         mappings=dict()122         for k,v in attrs.items():123             if isinstance(v,Field):124                 print('Found mapping: %s ==> %s' %(k,v))125                 mappings[k]=v126         for k in mappings.keys():127             attrs.pop(k)                #剔除128         attrs['__mappings__']=mappings    #保存属性和列的映射关系129         attrs['__table__']=name            #假设表名和类名一致130         return type.__new__(cls,name,bases,attrs)131         132 class Model(dict,metaclass=ModelMetaclass):133     134     def __init__(self,**kw):135         super(Model,self).__init__(**kw)136     137     def __getattr__(self,key):            #当使用点号获取实例属性时，如果属性不存在就自动调用__getattr__方法138         try:139             return self[key]140         except KeyError:141             raise AttributeError(r"'Model' object has no attribute '%s'" % key)142             143     def __setattr__(self,key,value):    #__setattr__当设置类实例属性时自动调用144         self[key]=value145         146     def save(self):147         fields=[]148         params=[]149         args=[]150         for k,v in self.__mappings__.items():151             fields.append(v.name)152             params.append('?')153             args.append(getattr(self,k,None))154         sql = 'insert into %s (%s) values (%s)' % (self.__table__, ','.join(fields), ','.join(params))155         print('SQL: %s' %sql)156         print('ARGS: %s' %str(args))157         158 #testing code:159 class User(Model):160     id = IntegerField('id')161     name = StringField('username')162     email = StringField('email')163     password = StringField('password')164 165 u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')166 u.save()167 168 #输出：169 '''170 Found model: User171 Found mapping: name ==> 
         
          172 Found mapping: password ==> 
          
           173 Found mapping: id ==> 
           
            174 Found mapping: email ==> 
            
             175 SQL: insert into User (password,id,email,username) values (?,?,?,?)176 ARGS: ['my-pwd', 12345, 'test@orm.org', 'Michael']177 '''