2. 使用元类
    4. 阅读: 254175
    5. type()
    7. 动态语言和静态语言最大的不同，就是函数和类的定义，不是编译时定义的，而是运行时动态创建的。
    9. 比方说我们要定义一个Hello的class，就写一个hello.py模块：
    11. class Hello(object):
    12.    def hello(self, name='world'):
    13.        print('Hello, %s.' % name)
    14. 当Python解释器载入hello模块时，就会依次执行该模块的所有语句，执行结果就是动态创建出一个Hello的class对象，测试如下：
    16. >>> from hello import Hello
    17. >>> h = Hello()
    18. >>> h.hello()
    19. Hello, world.
    20. >>> print(type(Hello))
    21. <class 'type'>
    22. >>> print(type(h))
    23. <class 'hello.Hello'>
    24. type()函数可以查看一个类型或变量的类型，Hello是一个class，它的类型就是type，而h是一个实例，它的类型就是class Hello。
    26. 我们说class的定义是运行时动态创建的，而创建class的方法就是使用type()函数。
    28. type()函数既可以返回一个对象的类型，又可以创建出新的类型，比如，我们可以通过type()函数创建出Hello类，而无需通过class Hello(object)...的定义：
    30. >>> def fn(self, name='world'): # 先定义函数
    31. ...     print('Hello, %s.' % name)
    32. ...
    33. >>> Hello = type('Hello', (object,), dict(hello=fn)) # 创建Hello class
    34. >>> h = Hello()
    35. >>> h.hello()
    36. Hello, world.
    37. >>> print(type(Hello))
    38. <class 'type'>
    39. >>> print(type(h))
    40. <class '__main__.Hello'>
    41. 要创建一个class对象，type()函数依次传入3个参数：
    43. class的名称；
    44. 继承的父类集合，注意Python支持多重继承，如果只有一个父类，别忘了tuple的单元素写法；
    45. class的方法名称与函数绑定，这里我们把函数fn绑定到方法名hello上。
    46. 通过type()函数创建的类和直接写class是完全一样的，因为Python解释器遇到class定义时，仅仅是扫描一下class定义的语法，然后调用type()函数创建出class。
    48. 正常情况下，我们都用class Xxx...来定义类，但是，type()函数也允许我们动态创建出类来，也就是说，动态语言本身支持运行期动态创建类，这和静态语言有非常大的不同，要在静态语言运行期创建类，必须构造源代码字符串再调用编译器，或者借助一些工具生成字节码实现，本质上都是动态编译，会非常复杂。
    50. metaclass
    52. 除了使用type()动态创建类以外，要控制类的创建行为，还可以使用metaclass。
    54. metaclass，直译为元类，简单的解释就是：
    56. 当我们定义了类以后，就可以根据这个类创建出实例，所以：先定义类，然后创建实例。
    58. 但是如果我们想创建出类呢？那就必须根据metaclass创建出类，所以：先定义metaclass，然后创建类。
    60. 连接起来就是：先定义metaclass，就可以创建类，最后创建实例。
    62. 所以，metaclass允许你创建类或者修改类。换句话说，你可以把类看成是metaclass创建出来的"实例"。
    64. metaclass是Python面向对象里最难理解，也是最难使用的魔术代码。正常情况下，你不会碰到需要使用metaclass的情况，所以，以下内容看不懂也没关系，因为基本上你不会用到。
    66. 我们先看一个简单的例子，这个metaclass可以给我们自定义的MyList增加一个add方法：
    68. 定义ListMetaclass，按照默认习惯，metaclass的类名总是以Metaclass结尾，以便清楚地表示这是一个metaclass：
    70. # metaclass是类的模板，所以必须从`type`类型派生：
    71. class ListMetaclass(type):
    72.    def __new__(cls, name, bases, attrs):
    73.        attrs['add'] = lambda self, value: self.append(value)
    74.        return type.__new__(cls, name, bases, attrs)
    75. 有了ListMetaclass，我们在定义类的时候还要指示使用ListMetaclass来定制类，传入关键字参数metaclass：
    77. class MyList(list, metaclass=ListMetaclass):
    78.    pass
    79. 当我们传入关键字参数metaclass时，魔术就生效了，它指示Python解释器在创建MyList时，要通过ListMetaclass.__new__()来创建，在此，我们可以修改类的定义，比如，加上新的方法，然后，返回修改后的定义。
    81. __new__()方法接收到的参数依次是：
    83. 当前准备创建的类的对象；
    85. 类的名字；
    87. 类继承的父类集合；
    89. 类的方法集合。
    91. 测试一下MyList是否可以调用add()方法：
    93. >>> L = MyList()
    94. >>> L.add(1)
    95. >> L
    96. [1]
    97. 而普通的list没有add()方法：
    99. >>> L2 = list()
    100. >>> L2.add(1)
    101. Traceback (most recent call last):
    102.  File "<stdin>", line 1, in <module>
    103. AttributeError: 'list' object has no attribute 'add'
    104. 动态修改有什么意义？直接在MyList定义中写上add()方法不是更简单吗？正常情况下，确实应该直接写，通过metaclass修改纯属变态。
    106. 但是，总会遇到需要通过metaclass修改类定义的。ORM就是一个典型的例子。
    108. ORM全称"Object Relational Mapping"，即对象-关系映射，就是把关系数据库的一行映射为一个对象，也就是一个类对应一个表，这样，写代码更简单，不用直接操作SQL语句。
    110. 要编写一个ORM框架，所有的类都只能动态定义，因为只有使用者才能根据表的结构定义出对应的类来。
    112. 让我们来尝试编写一个ORM框架。
    114. 编写底层模块的第一步，就是先把调用接口写出来。比如，使用者如果使用这个ORM框架，想定义一个User类来操作对应的数据库表User，我们期待他写出这样的代码：
    116. class User(Model):
    117.    # 定义类的属性到列的映射：
    118.    id = IntegerField('id')
    119.    name = StringField('username')
    120.    email = StringField('email')
    121.    password = StringField('password')
    123. # 创建一个实例：
    124. u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
    125. # 保存到数据库：
    126. u.save()
    127. 其中，父类Model和属性类型StringField、IntegerField是由ORM框架提供的，剩下的魔术方法比如save()全部由metaclass自动完成。虽然metaclass的编写会比较复杂，但ORM的使用者用起来却异常简单。
    129. 现在，我们就按上面的接口来实现该ORM。
    131. 首先来定义Field类，它负责保存数据库表的字段名和字段类型：
    133. class Field(object):
    135.    def __init__(self, name, column_type):
    136.        self.name = name
    137.        self.column_type = column_type
    139.    def __str__(self):
    140.        return '<%s:%s>' % (self.__class__.__name__, self.name)
    141. 在Field的基础上，进一步定义各种类型的Field，比如StringField，IntegerField等等：
    143. class StringField(Field):
    145.    def __init__(self, name):
    146.        super(StringField, self).__init__(name, 'varchar(100)')
    148. class IntegerField(Field):
    150.    def __init__(self, name):
    151.        super(IntegerField, self).__init__(name, 'bigint')
    152. 下一步，就是编写最复杂的ModelMetaclass了：
    154. class ModelMetaclass(type):
    156.    def __new__(cls, name, bases, attrs):
    157.        if name=='Model':
    158.            return type.__new__(cls, name, bases, attrs)
    159.        print('Found model: %s' % name)
    160.        mappings = dict()
    161.        for k, v in attrs.items():
    162.            if isinstance(v, Field):
    163.                print('Found mapping: %s ==> %s' % (k, v))
    164.                mappings[k] = v
    165.        for k in mappings.keys():
    166.            attrs.pop(k)
    167.        attrs['__mappings__'] = mappings # 保存属性和列的映射关系
    168.        attrs['__table__'] = name # 假设表名和类名一致
    169.        return type.__new__(cls, name, bases, attrs)
    170. 以及基类Model：
    172. class Model(dict, metaclass=ModelMetaclass):
    174.    def __init__(self, **kw):
    175.        super(Model, self).__init__(**kw)
    177.    def __getattr__(self, key):
    178.        try:
    179.            return self[key]
    180.        except KeyError:
    181.            raise AttributeError(r"'Model' object has no attribute '%s'" % key)
    183.    def __setattr__(self, key, value):
    184.        self[key] = value
    186.    def save(self):
    187.        fields = []
    188.        params = []
    189.        args = []
    190.        for k, v in self.__mappings__.items():
    191.            fields.append(v.name)
    192.            params.append('?')
    193.            args.append(getattr(self, k, None))
    194.        sql = 'insert into %s (%s) values (%s)' % (self.__table__, ','.join(fields), ','.join(params))
    195.        print('SQL: %s' % sql)
    196.        print('ARGS: %s' % str(args))
    197. 当用户定义一个class User(Model)时，Python解释器首先在当前类User的定义中查找metaclass，如果没有找到，就继续在父类Model中查找metaclass，找到了，就使用Model中定义的metaclass的ModelMetaclass来创建User类，也就是说，metaclass可以隐式地继承到子类，但子类自己却感觉不到。
    199. 在ModelMetaclass中，一共做了几件事情：
    201. 排除掉对Model类的修改；
    203. 在当前类（比如User）中查找定义的类的所有属性，如果找到一个Field属性，就把它保存到一个__mappings__的dict中，同时从类属性中删除该Field属性，否则，容易造成运行时错误（实例的属性会遮盖类的同名属性）；
    205. 把表名保存到__table__中，这里简化为表名默认为类名。
    207. 在Model类中，就可以定义各种操作数据库的方法，比如save()，delete()，find()，update等等。
    209. 我们实现了save()方法，把一个实例保存到数据库中。因为有表名，属性到字段的映射和属性值的集合，就可以构造出INSERT语句。
    211. 编写代码试试：
    213. u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
    214. u.save()
    215. 输出如下：
    217. Found model: User
    218. Found mapping: email ==> <StringField:email>
    219. Found mapping: password ==> <StringField:password>
    220. Found mapping: id ==> <IntegerField:uid>
    221. Found mapping: name ==> <StringField:username>
    222. SQL: insert into User (password,email,username,id) values (?,?,?,?)
    223. ARGS: ['my-pwd', 'test@orm.org', 'Michael', 12345]
    224. 可以看到，save()方法已经打印出了可执行的SQL语句，以及参数列表，只需要真正连接到数据库，执行该SQL语句，就可以完成真正的功能。
    226. 不到100行代码，我们就通过metaclass实现了一个精简的ORM框架，是不是非常简单？
    228. 真叫人头大
    230. 小结
    232. metaclass是Python中非常具有魔术性的对象，它可以改变类创建时的行为。这种强大的功能使用起来务必小心。
    234. 参考源码
    236. create_class_on_the_fly.py
    238. use_metaclass.py
    240. orm.py