1. 程式人生 > >由ORM談Python元類

由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='[email protected]', password='test')
# 儲存到資料庫:
u.save()

上面,我們就簡單實現了一個ORM。

參考連結

stackoverflow:

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

廖雪峰的官方網站:

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

本文首發於公眾號“小米運維”,點選檢視原文。