欢迎各位兄弟 发布技术文章

这里的技术是共享的

You are here

使用元类

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))
<class 'type'>
>>> print(type(h))
<class 'hello.Hello'>

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))
<class 'type'>
>>> print(type(h))
<class '__main__.Hello'>

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

  1. class的名称;
  2. 继承的父类集合,注意Python支持多重继承,如果只有一个父类,别忘了tuple的单元素写法;
  3. 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__()方法接收到的参数依次是:

  1. 当前准备创建的类的对象;

  2. 类的名字;

  3. 类继承的父类集合;

  4. 类的方法集合。

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

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

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

>>> L2 = list()
>>> L2.add(1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
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和属性类型StringFieldIntegerField是由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,比如StringFieldIntegerField等等:

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中定义的metaclassModelMetaclass来创建User类,也就是说,metaclass可以隐式地继承到子类,但子类自己却感觉不到。

ModelMetaclass中,一共做了几件事情:

  1. 排除掉对Model类的修改;

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

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

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

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

编写代码试试:

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

输出如下:

Found model: User
Found mapping: email ==> <StringField:email>
Found mapping: password ==> <StringField:password>
Found mapping: id ==> <IntegerField:uid>
Found mapping: name ==> <StringField:username>
SQL: insert into User (password,email,username,id) values (?,?,?,?)
ARGS: ['my-pwd', 'test@orm.org', 'Michael', 12345]

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

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

小结

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

参考源码

create_class_on_the_fly.py

use_metaclass.py

orm.py

  • #ORM:object relational mapping 对象-关系映射
    #把关系数据库的一行映射为一个对象,也就是一个类对应一个表
    #ORM框架所有的类只能动态定义
    #定义一个User类来操作对应的数据库表User
    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)#输出<对象所属的类名:对象的名字>
    
    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')
    
    class ModelMetaclass(type):
        def __new__(cls,name,bases,attrs):#当前metaclass方法准备创建的类的对象,类的名字,类继承的父类集合,类的方法集合
            if name=='Model':
                return type.__new__(cls,name,bases,attrs)#封锁对Model的修改,类名是Model就只能返回
            print('Found model:%s'%name)
            mappings=dict()#新建一个字典
            for k,v in attrs.items():
                if isinstance(v, Field):
                    print('Found mapping: %s ==> %s' % (k, v))
            #v是属于Field类的,因此v遇到print会自动调用__str__ attr是无序的字典,因此打印输出的时候也是无序的
                    mappings[k] = v
            # 在当前类(比如User)中查找定义的类的所有属性,如果找到一个Field属性,就把它保存到一个__mappings__的dict中,
            # 同时从类属性中删除该Field属性,否则,容易造成运行时错误(实例的属性会遮盖类的同名属性);
            for k in mappings.keys():
                attrs.pop(k)
            attrs['__mappings__'] = mappings  # 保存属性和列的映射关系,这属于User标的属性
            attrs['__table__'] = name  # 假设表名和类名一致
            return type.__new__(cls, name, bases, attrs)#属性修改完毕后返回
    
    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):
        # 定义类的属性到列的映射
        id=IntegerField('id')#用IntegerField初始化User类的属性,调用setattr自动赋值
        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的方法->调用ModelMetaclass的方法
    

    我知道在SQL里varchar100是限制字段内容的类型,但是放在init函数里怎么解释,init函数的参数不是只能是类的属性么,字符串可以作为类的属性么?

    Collapse

    • Created at 9-9 15:58, Last updated at 9-9 15:58

      您好。对于一个新建的metaclass而言 atrr这个字典里,不是空的么?

      for k,v in attrs.item(): 怎么成立?

      for k,v in attrs.items(): if isinstance(v, Field): print('Found mapping: %s ==> %s' % (k, v))

          #v是属于Field类的,因此v遇到print会自动调用__str__ attr是无序的字典,因此打印输出的时候也是无序的
                  mappings[k] = v
          # 在当前类(比如User)中查找定义的类的所有属性,如果找到一个Field属性,就把它保存到一个__mappings__的dict中,
          # 同时从类属性中删除该Field属性,否则,容易造成运行时错误(实例的属性会遮盖类的同名属性);
          for k in mappings.keys():
              attrs.pop(k)
      
  • 一把辛酸泪

    菲菲的歪牙 created at 8-29 22:01, Last updated at 8-29 22:01

    廖老师说看不懂没关系,结果看到后面突然就蹦出来这个,麻溜的滚回来看了,当时看不懂就pass了,一把辛酸泪啊

  • 为什么我这里会报错啊

    魂影lys created at 7-13 16:55, Last updated at 7-21 10:30
    class Model(dict,metaclass=ModelMetaclass):
                              ^
    

    SyntaxError: invalid syntax

    python2.7的不能直接这么做吗? 应该怎么处理呢? 求助

  • 第二个理解起来有点困难 来加个注释

    枫-落J created at 7-2 20:55, Last updated at 7-13 11:38
    class ModelMetaclass(type):
    
        def __new__(cls, name, bases, attrs):
            if name=='Model'://如果当前创建对象为Model的实例则不做操作(因为Model没有属性 做了也白做)
                return type.__new__(cls, name, bases, attrs)
            print('Found model: %s' % name)//打印当前实例的类名称
            mappings = dict()//创建一个空的字典
            for k, v in attrs.items():
            //attrs应该是存放了类的所有属性以及方法的字典,我的理解是在python中一切都是对象. 方法的类型为<class 'function'> 值为形如<function aaa at 0x10e4839d8>的内存地址.可以理解为方法是一个function的实例.这里k是属性或方法的类型,v是属性或方法的值
                if isinstance(v, Field)://如果v是Field的实例对象
                    print('Found mapping: %s ==> %s' % (k, v))
                    mappings[k] = v//将其添加到mappings字典中
            for k in mappings.keys()://最后遍历mappings,从attrs中pop
                attrs.pop(k)
            //最后正在创建的对象 添加两个属性  __mappings__和 __table__
            attrs['__mappings__'] = mappings # 保存属性和列的映射关系
            attrs['__table__'] = name # 假设表名和类名一致
            return type.__new__(cls, name, bases, attrs)
    
    • Created at 7-2 21:01, Last updated at 7-2 21:01
      class ModelMetaclass(type):
          def __new__(cls, name, bases, attrs):
              for k, v in attrs.items():
                  print('key:%s,value:%s' % (k, v))
              return type.__new__(cls, name, bases, attrs)
      
      
      class Test(object, metaclass=ModelMetaclass):
          name = "dlj"
          age = 123
      
          def aaa(self):
              pass
      
      
      a = Test()
      
      打印结果:
      key:name,value:dlj
      key:__module__,value:__main__
      key:aaa,value:<function Test.aaa at 0x109fa10d0>
      key:age,value:123
      key:__qualname__,value:Test
      

      验证了attrs是包含所有元素和方法的字典

      Read More

    • Created at 7-13 11:38, Last updated at 7-13 11:38

      class User(Model):

      # 定义类的属性到列的映射:
      id = IntegerField('id')
      name = StringField('username')
      email = StringField('email')
      password = StringField('password')
      

      如果把id,username,email,password初始化将毫无意义 ,如果是这样当时new一个user时无需pop了 只需将id,name,email,password名字更改一下即可,应为这几个字段不是表示的是表的字段名,所以这个User的类建议修改 class User(Model):

      # 定义类的属性到列的映射:
      id = IntegerField('varchar(100')
      username = StringField('varchar(100')
      email = StringField('varchar(100')
      password = StringField('varchar(100')
      
      然后改一下StringField(Field)的定义
      
      其中id、username、email、password表示表的字段名
      
  • 看到这里膜拜之情再次油然而生

    天之骄子呃 created at 7-1 0:31, Last updated at 7-1 0:31

    看到这里膜拜之情再次油然而生,廖老师对编译原理理解得还这么深刻实在佩服。其实很想请假廖老师当遇见一门新语言或者新技术是怎么去学习的呢?从文档开始看吗?很期待您的回复:)

  • User类没有__init__方法也可以传入参数吗?

    wangdonglong5776 created at 4-1 20:35, Last updated at 6-26 15:11

    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()

    User类没有init方法也可以传入参数吗?

    User类没有init方法也可以传入参数吗?

    User类没有init方法也可以传入参数吗?

    Read More

    • Created at 4-2 22:31, Last updated at 4-2 22:31

      没有定义__init__就用父类的__init__

    • Created at 5-3 16:27, Last updated at 5-3 16:27

      我也在这一段代码卡住了,User类中的id,name,email和password这个几个变量,与创建实例时u的id,name,email和password这几个变量有什么区别吗?

    • Created at 5-3 21:24, Last updated at 5-3 21:24

      类的变量不是实例变量,它是用来定义表的字段的

    • Created at 6-26 15:11, Last updated at 6-26 15:11

      User调用了Model的'init'方法,而Model又调用了dict的'init'方法,而dict的'init'方法是'init(**kw)',所以最后把u=User()括号里的内容生成了一个字典

  • 我想知道Metaclass中的

    __new__
    

    的attrs参数到底是类属性(static)还是实例属性(非static)

    attrs['__mappings__'] = mappings # 保存属性和列的映射关系
    attrs['__table__'] = name # 假设表名和类名一致
    

    还有就是这里的

    __mappings__
    __table__
    

    是类属性(static)还是实例属性(非static)

    • Created at 4-21 23:06, Last updated at 4-21 23:06

      换句话说,你可以把类看成是metaclass创建出来的“实例”。

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

      attrs是即将要创建的class的“属性”,attrs['add']相当于下面的def add(self, value)

      class MyList(list):
          def add(self, value):
              self.append(value)
      
    • Created at 4-23 0:25, Last updated at 4-23 0:25

      但是

      class User(Model):
          # 定义类的属性到列的映射:
          id = IntegerField('id')
          name = StringField('username')
          email = StringField('email')
          password = StringField('password')
      

      显然这里的id是类的static变量

      可是class ModelMetaclass(type):这里

              for k, v in attrs.items():
                  if isinstance(v, Field):
      

      获取static的属性跟成员变量没区别,难道metaclass没有区分static和非static的方法吗? 还有这一句,是不是就把静态的field全部删除了?

      在此插入代码
      
      for k in mappings.keys():
        attrs.pop(k)
      

      这里的mappings是static的还是非static的

       attrs['__mappings__'] = mappings
      

      Collapse

    • Created at 6-13 13:55, Last updated at 6-13 13:55

      前后两次的id,name等变量不是一回事,只是名字相同,开始是静态的但是创建类时被删掉了,创建对象时传参数,又重现创建了非静态的变量,__dict__是创建类时被添加的静态变量,我上面发了个贴你看一下

  • 我对类的创建过程和对象创建过程的理解

    无量萨姆大神 created at 6-13 13:50, Last updated at 6-13 13:50
    class User(Model):
        # 定义类的属性到列的映射:
        id = IntegerField('id')
        name = StringField('username')
        email = StringField('email')
        password = StringField('password')
        # 这些属性(列对象model类型)看起来是属于类的,其实只是起提示作用,因为在类的生成过程中(ModelMetaclass)已经删除了这些属性,
        # 并将列对象(model类型)按属性名保存在一个内部的dict中
        # u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
        # 创建类的实例时,其实又重新添加了同名的对象属性(int,str类型),因为属性类型都不一样了
        # 调用save函数生成sql语句时,需要列名和列的值,使用相同的key,从dict中取出列对象(model类型),获得name,从属性中取出列值(int,str类型)

普通分类: