Python中使用type、metaclass动态创建方法和属性
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']
可以看到,save()
方法已经打印出了可执行的sql语句,以及参数列表,只需要真正连接到数据库,执行该sql语句,就可以完成真正的功能。
以上只是简单的编写orm示例,实际应用会更复杂。有描述不当的清随时指正哈