Python使用元類

type()

動態(tài)語言和靜態(tài)語言最大的不同,就是函數(shù)和類的定義,不是編譯時定義的,而是運行時動態(tài)創(chuàng)建的。
比方說我們要定義 一個Hello的class,就寫一個hello.py模塊:

class Hello(object):
    def hello(self, name = 'world'):
        print('Hello, %s.' % name)

當(dāng)Python解釋器載入hello模塊時,就會依次執(zhí)行該模塊的所有語句,執(zhí)行結(jié)果就是動態(tài)創(chuàng)建出一個Hello的class對象,測試:

>>> from hello import Hello
>>> h = Hello()
>>> h.hello()
>>> print(type(Hello))
<class 'type'>
>>> print(type(h))
<class 'hello.Hello'>

type()函數(shù)可以查看一個類型或變量的類型,Hello是一個class,它的類型就是type,而h是一個實例,它的類型就是classHello。
我們說class的定義是運行時動態(tài)創(chuàng)建的,而創(chuàng)建class的方法就是使用type()函數(shù)。
type()函數(shù)既可以返回一個對象的類型,又可以創(chuàng)建出新的類型,比如,我們可以通過type()函數(shù)創(chuàng)建出Hello類,而無需通過class Hello(object)...的定義:

>>> def fn(self, name= 'world'):#先定義函數(shù)
...       print('Hello, %s.' % name)
...
>>> Hello = type('Hello', (object,),dict(hello=fn)) #創(chuàng)建Hello class
>>> h = Hello()
>>> h.hello()
Hello, world.
>>> print(type(Hello))
<class 'type'>
>>> print(type(h))
<class 'hello.Hello'>

要創(chuàng)建一個class對象,type()函數(shù)依次傳入3個參數(shù):

1、class的名稱
2、繼承的父類集合,注意Python支持多重繼承,如果只有一個父類,別忘了tuple的單元素寫法
3、class的方法名稱與函數(shù)綁定,這里我們把函數(shù)fn綁定到方法名hello上。

通過type()函數(shù)創(chuàng)建的類和直接寫class是完全一樣的,因為Python解釋器遇到class定義時,僅僅是掃描一下class定義的語法,然后調(diào)用type()函數(shù)創(chuàng)建出class。
正常情況下,我們都用class Xxx...來定義類,但是type()函數(shù)也允許我們動態(tài)創(chuàng)建出類來,也就是說,動態(tài)語言本身支持運行期動態(tài)創(chuàng)建類,這和靜態(tài)語言有非常大的不同,要在靜態(tài)語言運行期創(chuàng)建類,必須構(gòu)造源代碼字符串再調(diào)用編譯器,或者借助一些工具生成字節(jié)碼實現(xiàn),本質(zhì)上都是動態(tài)編譯,會非常復(fù)雜。

metaclass

除了使用type()動態(tài)創(chuàng)建類以外,要控制類的創(chuàng)建行為,還可以使用metaclass。
metaclass,直譯為元類,簡單的解釋就是:
當(dāng)我們定義了類以后,就可以根據(jù)這個類創(chuàng)建出實例,所以:先定義類,然后創(chuàng)建實例。
但是如果我們想創(chuàng)建出類呢?那就必須根據(jù)metaclass創(chuàng)建出類,所以:先定義metaclass,然后創(chuàng)建類。
連接起來就是:先定義metaclass,就可以創(chuàng)建類,最后創(chuàng)建實例。
所以,metaclass允許你創(chuàng)建類或者修改類,換句話說,你可以把類看成是metaclass創(chuàng)建出來的“實例”。
metaclass是Python面向?qū)ο罄镒铍y理解,也是最難使用的魔術(shù)代碼。正常情況下,你不會碰到需要使用metaclass的情況。
看一個簡單的例子,這個metaclass可以給我們自定義的MyList增加一個add方法:
定義ListMetaclass,按照默認(rèn)習(xí)慣,metaclass的類名總是以Metaclass結(jié)尾,以便清楚的表示是一個metaclass:

#metaclass是類的模板,所以必須從`type`類型派生:
class ListMetaclass(type):
    def __new__(cls, name, bases, attrs):
        attrs['add'] = lambda self, value:self.append(value)
        return type.__new__(cls, name, bases, attrs)

有了ListMetaclass,我們在定義類的時候還要指示使用ListMetaclass來定制類,傳入關(guān)鍵字參數(shù) metaclass

class MyList(list, metaclass=ListMetaclass):
    pass

當(dāng)我們傳入關(guān)鍵字參數(shù)metaclass時,魔術(shù)就生效了,它指示Python解釋器在創(chuàng)建MyList 時,要通過ListMetaclass.__new__()來創(chuàng)建,在此,我們可以修改類的定義,比如,加上新的方法,然后,返回修改后的定義。
__new__()方法接收到的參數(shù)依次是:

1、當(dāng)前準(zhǔn)備創(chuàng)建的類的對象
2、類的名字
3、類集成的父類集合
4、類的方法集合

測試:

>>> L = MyList()
>>> L.add(1)
>> L
[1]

而普通的lsit沒有add()方法:

>>> L2 = list()
>>> L2.add(1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'list' object has no attribute 'add'

動態(tài)修改有什么意義?直接在MyList定義中寫上add()方法不是更簡單嗎?正常情況下,確實應(yīng)該直接寫,通過metaclass修改純屬變態(tài)。
但是,總會遇到需要通過metaclass修改類定義的。ORM就是一個典型的例子。
ORM全稱“Object Relational Mapping”,即對象-關(guān)系映射,就是把關(guān)系數(shù)據(jù)庫的一行映射為一個對象,也就是一個類對應(yīng)一個表,這樣,寫代碼更簡單,不用直接操作SQL語句。
要編寫一個ORM框架,所有的類都只能動態(tài)定義,因為只有使用者才能根據(jù)表的結(jié)構(gòu)定義出對應(yīng)的類來。
嘗試編寫一個ORM框架:
編寫底層模塊的第一步,就是先把調(diào)用接口寫出來。比如:使用者如果使用這個ORM框架,想定義一個User類來操作對應(yīng)的數(shù)據(jù)庫表User,我們期待他寫出這樣的代碼:

class User(Model):
#定義類的屬性到列的映射:
    id = IntegerField('id')
    name = StringField('username')
    email = StringField('email')
    password = StringField('password')

#創(chuàng)建一個實例:
u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
#保存到數(shù)據(jù)庫
u.save()

其中,父類Model和屬性類型StringField、IntegerField是由ORM框架提供的,剩下的魔術(shù)方法比如save()全部由metaclass自動完成。雖然metaclass的編寫會比較復(fù)雜,但ORM的使用者用起來卻異常簡單。
現(xiàn)在按上面的接口來實現(xiàn)ORM。
首先來定義Field類,它負(fù)責(zé)保存數(shù)據(jù)庫表的字段和字段類型:

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的基礎(chǔ)上,進(jìn)一步定義各種類型的Field,比如StringField,IntegerField等等:

class StringField(Field):
    def __init__(self, name):
      super(StringField, self).__init__(name, 'varchar(100)')

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

下一步,就是編寫最復(fù)雜的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 # 保存屬性和列的映射關(guān)系
        attrs['__table__'] = name # 假設(shè)表名和類名一致
        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))

當(dāng)用戶定義一個class User(Model)時,Python解釋器首先在當(dāng)前類User的定義中查找metaclass,如果沒有找到,就繼續(xù)在父類Model中查找metaclass,找到了,就使用Model中定義的metaclass的ModelMetaclass來創(chuàng)建User類,也就是說,metaclass可以隱式地繼承到子類,但子類自己卻感覺不到。

在ModelMetaclass中,一共做了幾件事情:

排除掉對Model類的修改;

在當(dāng)前類(比如User)中查找定義的類的所有屬性,如果找到一個Field屬性,就把它保存到一個mappings的dict中,同時從類屬性中刪除該Field屬性,否則,容易造成運行時錯誤(實例的屬性會遮蓋類的同名屬性);

把表名保存到table中,這里簡化為表名默認(rèn)為類名。

在Model類中,就可以定義各種操作數(shù)據(jù)庫的方法,比如save(),delete(),find(),update等等。

我們實現(xiàn)了save()方法,把一個實例保存到數(shù)據(jù)庫中。因為有表名,屬性到字段的映射和屬性值的集合,就可以構(gòu)造出INSERT語句。

編寫代碼試試:

u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
u.save()
Found model: User
Found mapping: email ==> <StringField:email>
Found mapping: password ==> <StringField:password>
Found mapping: id ==> <IntegerField:uid>
Found mapping: name ==> <StringField:username>
SQL: insert into User (password,email,username,id) values (?,?,?,?)
ARGS: ['my-pwd', 'test@orm.org', 'Michael', 12345]
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容