由ORM談Python元類

本文主要介紹了什麼是類，如何動態的建立類，什麼是元類，類的_metaclass_屬性以及如何本身實現ORM。
上篇文章回顧： 淺談TLS 1.3

在談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，則是元類的應用之一。

什麼是類？

簡單來講，類就是用一種使用相對固定的格式，來描述如何生成對象的一段代碼，在Python中，咱們使用以下格式來生成類：

class MyClass(object):
    pass複製代碼

可是同時，類又是一種特殊的對象，稱之爲classobj，可使用type來測定出：

>>> class MyClass():
...     pass
...
>>> type(MyClass)
<type 'classobj'
>>>> type(MyClass())
<type 'instance'>複製代碼

同時，它也具備對象的所有特徵，如你能夠對他進行賦值，拷貝，增長屬性等的操做，以下示例：

>>> class MyClass():
...     pass
...
>>> print MyClass
__main__.MyClass
>>> a = MyClass
>>> print a
__main__.MyClass
>>> MyClass.__dict__
{'__module__': '__main__', '__doc__': None}
>>> MyClass.a = 100
>>> MyClass.__dict__
{'a': 100, '__module__': '__main__', '__doc__': None}
>>>
>>> MyClass.a = 200
>>> MyClass.a200
>>>複製代碼

如何動態的建立類？

最簡單的方法，就是採用以下方法：

def create_class(class_name):
    if class_name == "MyClass":
        class MyClass():
            pass
        return MyClass
    else:
        class OtherClasss():
            pass
        return OtherClasss複製代碼

可是此類方法，不能稱之爲真正的動態，由於只能支持有限的類的建立，那有什麼方法，能真正實現動態建立一些類呢？ 因此，這裏就不得不提到關鍵詞type了，首先，咱們大多數人談起type，首先想到的是，type不就是用來測試變量類型的嘛，以下：

>>> print type(1)<type 'int'
>>>> print type("1")<type 'str'
>>>> class A():
...     pass
...
>>> type(A)<type 'classobj'
>>>> type(A())
<type 'instance'>複製代碼

可是與此同時，type還有另外一個神奇的能力，就是它也能動態的建立類。type能夠接受一個類的相關信息做爲參數，而後返回一個類。 下面是其用法：

type(類名, 父類的元組，包含屬性的字典)複製代碼

什麼是元類？

上面提到了類是一種特殊的對象，對象就必須有類來建立，而元類，就是用來建立這種類的。簡單來講，用於建立類的類，就是元類。 能夠理解爲一下這種方式：

MyClass = MetaClass()
MyObject = MyClass()複製代碼

而type，就是元類，因而建立一個類，就可使用以下這種方式：

MyClass = type("MyClass", (), {})
MyObject = MyClass()複製代碼

類的_metaclass_屬性

當咱們建立一個類的時候爲其添加__metaclass__屬性：

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。

參考連接

stackoverflow：

https://stackoverflow.com/questions/100003/what-are-metaclasses-in-python

廖雪峯的官方網站：

https://www.liaoxuefeng.com/wiki/001374738125095c955c1e6d8bb493182103fac9270762a000/001386820064557c69858840b4c48d2b8411bc2ea9099ba000

本文首發於公衆號「小米運維」，點擊查看原文。