由ORM浅谈python元类

主要介绍了什么是类，如何动态的创建类，什么是元类，类的_metaclass_属性以及如何自己实现ORM。

在谈Python元类之前，我们先来看看ORM是什么?

ORM 为Object Relational Mapping 的简称，中文意思为对象关系映射，ORM的出现，是为了解决面向对象和关系数据库之间不相匹配而出现的技术，目的是使用面向对象的思想来实现对数据库中表的操作，从而屏蔽掉底层的SQL操作。

简单了解了ORM的概念，许多同学可能会想了解ORM是怎么实现的，以下代码摘自django项目ORM的部分实现代码：

def subclass_exception(name, parents, module, attached_to=None):
    """
    Create exception subclass. Used by ModelBase below.

    If 'attached_to' is supplied, the exception will be created in a way that
    allows it to be pickled, assuming the returned exception class will be added
    as an attribute to the 'attached_to' class.
    """
    class_dict = {'__module__': module}
    if attached_to is not None:
            def __reduce__(self):
               # Exceptions are special - they've got state that isn't
               # in self.__dict__. We assume it is all in self.args.
               return (unpickle_inner_exception, (attached_to, name), self.args)

            def __setstate__(self, args):
               self.args = args

        class_dict['__reduce__'] = __reduce__
        class_dict['__setstate__'] = __setstate__

    return type(name, parents, class_dict)

很多同学会好奇，type 不是一般来检测Python变量的类型的嘛，怎么在这里竟然可以接受这么多参数，在这里他的用法到底是什么呢？这就涉及到了Python 的元类(metaclass)相关知识，而ORM，则是元类的应用之一。

类和实例

面向对象最重要的概念就是类（Class）和实例（Instance），必须牢记类是抽象的模板，比如Student类，而实例是根据类创建出来的一个个具体的“对象”，每个对象都拥有相同的方法，但各自的数据可能不同。

仍以Student类为例，在Python中，定义类是通过class关键字：

1 2	class Student(object): pass

class后面紧接着是类名，即Student，类名通常是大写开头的单词，紧接着是(object)，表示该类是从哪个类继承下来的，继承的概念我们后面再讲，通常，如果没有合适的继承类，就使用object类，这是所有类最终都会继承的类。

定义好了Student类，就可以根据Student类创建出Student的实例，创建实例是通过类名+()实现的：

>>> bart = Student()
>>> bart
<__main__.Student object at 0x10a67a590>
>>> Student
<class '__main__.Student'>

可以看到，变量bart指向的就是一个Student的object，后面的0x10a67a590是内存地址，每个object的地址都不一样，而Student本身则是一个类。
可以自由地给一个实例变量绑定属性，比如，给实例bart绑定一个name属性：

1
2
3

>>> bart.name = 'Bart Simpson'
>>> bart.name
'Bart Simpson'

由于类可以起到模板的作用，因此，可以在创建实例的时候，把一些我们认为必须绑定的属性强制填写进去。通过定义一个特殊的init方法，在创建实例的时候，就把name，score等属性绑上去：

class Student(object):

    def __init__(self, name, score):
        self.name = name
        self.score = score

注意到init方法的第一个参数永远是self，表示创建的实例本身，因此，在init方法内部，就可以把各种属性绑定到self，因为self就指向创建的实例本身。

有了init方法，在创建实例的时候，就不能传入空的参数了，必须传入与init方法匹配的参数，但self不需要传，Python解释器自己会把实例变量传进去：

>>> bart = Student('Bart Simpson', 59)
>>> bart.name
'Bart Simpson'
>>> bart.score
59

和普通的函数相比，在类中定义的函数只有一点不同，就是第一个参数永远是实例变量self，并且，调用时，不用传递该参数。除此之外，类的方法和普通函数没有什么区别，所以，你仍然可以用默认参数、可变参数和关键字参数。

数据封装

面向对象编程的一个重要特点就是数据封装。在上面的Student类中，每个实例就拥有各自的name和score这些数据。我们可以通过函数来访问这些数据，比如打印一个学生的成绩：

>>> def print_score(std):
...     print '%s: %s' % (std.name, std.score)
...
>>> print_score(bart)
Bart Simpson: 59

但是，既然Student实例本身就拥有这些数据，要访问这些数据，就没有必要从外面的函数去访问，可以直接在Student类的内部定义访问数据的函数，这样，就把“数据”给封装起来了。这些封装数据的函数是和Student类本身是关联起来的，我们称之为类的方法：

class Student(object):

    def __init__(self, name, score):
        self.name = name
        self.score = score

    def print_score(self):
        print '%s: %s' % (self.name, self.score)

要定义一个方法，除了第一个参数是self外，其他和普通函数一样。要调用一个方法，只需要在实例变量上直接调用，除了self不用传递，其他参数正常传入：

1 2	>>> bart.print_score() Bart Simpson: 59

这样一来，我们从外部看Student类，就只需要知道，创建实例需要给出name和score，而如何打印，都是在Student类的内部定义的，这些数据和逻辑被“封装”起来了，调用很容易，但却不用知道内部实现的细节。
封装的另一个好处是可以给Student类增加新的方法，比如get_grade：

class Student(object):
    ...

    def get_grade(self):
        if self.score >= 90:
            return 'A'
        elif self.score >= 60:
            return 'B'
        else:
            return 'C'

同样的，get_grade方法可以直接在实例变量上调用，不需要知道内部实现细节：

1 2	>>> bart.get_grade() 'C'

小结

类是创建实例的模板，而实例则是一个一个具体的对象，各个实例拥有的数据都互相独立，互不影响；

方法就是与实例绑定的函数，和普通函数不同，方法可以直接访问实例的数据；

通过在实例上调用方法，我们就直接操作了对象内部的数据，但无需知道方法内部的实现细节。

和静态语言不同，Python允许对实例变量绑定任何数据，也就是说，对于两个实例变量，虽然它们都是同一个类的不同实例，但拥有的变量名称都可能不同：

>>> bart = Student('Bart Simpson', 59)
>>> lisa = Student('Lisa Simpson', 87)
>>> bart.age = 8
>>> bart.age
8
>>> bart.__dict__
{'name': 'Bart Simpson', 'score': 59, 'age': 8}
>>> lisa.age
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'Student' object has no attribute 'age'

如何动态的创建类？

最简单的方法，就是采用如下方法：

def create_class(class_name):
    if class_name == "MyClass":
        class MyClass():
            pass
        return MyClass
    else:
        class OtherClasss():
            pass
        return OtherClasss

但是此类方法，不能称之为真正的动态，因为只能支持有限的类的创建，那有什么方法，能真正实现动态创建一些类呢？所以，这里就不得不提到关键词type了
但是与此同时，type还有另一个神奇的能力，就是它也能动态的创建类。type可以接受一个类的相关信息作为参数，然后返回一个类。下面是其用法

1	type(类名, 父类的元组，包含属性的字典)

什么是元类？

上面提到了类是一种特殊的对象，对象就必须有类来创建，而元类，就是用来创建这种类的。简单来说，用于创建类的类，就是元类。可以理解为一下这种方式：

1 2	MyClass = MetaClass() MyObject = MyClass()

而type，就是元类，于是创建一个类，就可以使用如下这种方式：

1 2	MyClass = type("MyClass", (), {}) MyObject = MyClass()

类的_metaclass_属性

当我们创建一个类的时候为其添加metaclass属性：

1
2
3

class Foo(object):
    __metaclass__ = something…
[…]

那么，Python就会采用你指定的方法，来创建这个类，否则，会使用type来创建这个类，下面演示如何自定义的指定metaclass属性：

def lower_attr(class_name, class_parents, class_attr):
    lower_attr = {}
    for name, val in class_attr.items():
        if name.startswith('__'):
           lower_attr[name] = val
        else:
           lower_attr[name.lower()] = val
    return type(class_name, class_parents, lower_attr)

class MyClss():
    __metaclass__ = lower_attr
    A = 'A'
    b = 'b'

my_class = MyClss()

print(hasattr(my_class, 'A')) # False
print(hasattr(my_class, 'b')) # True
print(hasattr(my_class, 'a')) # True

如何自己实现ORM？

首先来定义Field类，它负责保存数据库表的字段名和字段的类型：

class Field(object):
    def __init__(self, name, column_type):
        self.name = name
        self.column_type = column_type

在Field的基础上，进一步定义各种具体类型的Field，比如StringField，IntegerField等等：

class StringField(Field):
    def __init__(self, name, max_length):
        super(StringField, self).__init__(name, 'varchar(%d)' % max_length)

class IntegerField(Field):
    def __init__(self, name):
        super(IntegerField, self).__init__(name, 'int')

下一步，就是编写最复杂的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):
                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))

创建User类，并调用save方法，保存：

class User(Model):
    id = IntegerField('id')
    name = StringField('username', max_length=48)
    email = StringField('email', max_length=128)
    password = StringField('password', max_length=24)

# 创建一个实例：
u = User(id=12345, name='xiaoming', email='xiaoming@xiaomi.com', password='test')
# 保存到数据库：
u.save()

上面，我们就简单实现了一个ORM。

参考资料

使用元类 - 廖雪峰的官方网站