欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

[python] 理解metaclass并实现一个简单ORM框架

程序员文章站 2022-04-12 19:51:40
metaclass 除了使用type()动态创建类以外,要控制类的创建行为,还可以使用metaclass。 metaclass,直译为元类,简单的解释就是: 当我们定义了类以后,就可以根据这个类创建出实例,所以:先定义类,然后创建实例。 但是如果我们想创建出类呢?那就必须根据metaclass创建出 ......

 

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框架。

 

 搬自廖大神的官网,文章在哪里都有,关键是自己融会贯通。