首页 > > 网络编程 > 其它 >

Python中使用type、metaclass动态创建方法和属性

2019-04-11 10:21:55来源：博客园阅读 ()

1: type()

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

比方说我们要定义一个Person的class：

class Person(object):
    def name(self, name='Kaven'):
        print('My name is: %s.' % name)

p = Person()
p.name()
print(type(Person))
print(type(p))

输出：

1 My name is: Kaven.
2 <class 'type'>
3 <class '__main__.Person'>

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

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

# -*- coding: utf-8 -*-
def func(self, name='Kaven'): # 自定义函数
    print('My name is: %s.' % name)

Person = type('Person', (object,), dict(name=func)) # 创建Person class

h = Person()
h.name()
print('type(Person) =', type(Person))
print('type(h) =', type(h))

输出：

1 My name is: Kaven.
2 type(Person) = <class 'type'>
3 type(h) = <class '__main__.Person'>

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

class的名称；
继承的父类集合，注意Python支持多重继承，如果只有一个父类，使用tuple的单元素写法；
class的方法名称与函数绑定，这里我们把函数func绑定到方法名name上。

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

正常情况下，我们都用class X 来定义类，但是，type()函数也允许我们动态创建出类来，也就是说，动态语言本身支持运行期动态创建类，

这和静态语言有非常大的不同，要在静态语言运行期创建类，必须构造源代码字符串再调用编译器，或者借助一些工具生成字节码实现，本质上都是动态编译，会非常复杂。

2: metaclass

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

metaclass，我们这样理解就是：

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

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

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

正常情况下，我们不会碰到需要使用metaclass的情况，所以，以下内容我尽我所理解的描述清楚，因为基本上大家可能不会用到。

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

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

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

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

# 指示使用FriendMetaclass来定制类
class MyFriend(list, metaclass=FriendMetaclass):
    pass

当我们传入关键字参数metaclass时，魔术就生效了，它指示Python解释器在创建MyFriend时，要通过FriendMetaclass.__new__()来创建，

在此，我们可以修改类的定义，比如，加上新的方法，然后，返回修改后的定义。

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

当前准备创建的类的对象；
类的名字；
类继承的父类集合；
类的方法集合。

完整代码如下：

# -*- coding: utf-8 -*-

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


# 指示使用FriendMetaclass来定制类
class MyFriend(list, metaclass=FriendMetaclass):
    pass


L = MyFriend()
L.add('乔峰')
L.add('慕容复')
L.add('鸠摩智')
L.add('玄灯大师')
print(L) # ['乔峰', '慕容复', '鸠摩智', '玄灯大师']

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

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

我们知道ORM即对象-关系映射，就是把关系数据库的一行映射为一个对象，也就是一个类对应一个表，这样，写代码更简单，不用直接操作SQL语句。

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

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

# -*- coding: utf-8 -*-

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


# 创建一个实例：
u = User(id=1, name='loose', email='qq@qq.com', password='123456')
# 保存到数据库：
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(20)')


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语句。

完整代码如下：

# -*- coding: utf-8 -*-

' 简单 ORM 使用 metaclass 示例 '


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


class IntegerField(Field):

    def __init__(self, name):
        super(IntegerField, self).__init__(name, 'bigint')


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)


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


# testing code:

class User(Model):
    id = IntegerField('id')
    name = StringField('username')
    email = StringField('email')
    password = StringField('password')


u = User(id=1, name='loose', email='qq@qq.com', password='123456')
u.save()

输出：

1 Found model: User
2 Found mapping: id ==> <IntegerField:id>
3 Found mapping: name ==> <StringField:username>
4 Found mapping: email ==> <StringField:email>
5 Found mapping: password ==> <StringField:password>
6 SQL: insert into User (id,username,email,password) values (?,?,?,?)
7 ARGS: [1, 'loose', 'qq@qq.com', '123456']