metaclass的實(shí)現(xiàn)機(jī)制

今天我將帶大家設(shè)計(jì)一個(gè)簡(jiǎn)單的orm框架，并簡(jiǎn)單剖析一下YAML這個(gè)序列化工具的原理。

Python類(lèi)的上帝-type

說(shuō)到metaclass，我們首先必須清楚一個(gè)最基礎(chǔ)的概念就是對(duì)象是類(lèi)的實(shí)例，而類(lèi)是type的實(shí)例，重復(fù)一遍：

1. 對(duì)象是類(lèi)的實(shí)例
2. 類(lèi)是type的實(shí)例

在面向?qū)ο蟮?a href="http://ttokpm.com/v/tag/1315/" target="_blank">編程模型中，類(lèi)就相當(dāng)于一個(gè)房子的設(shè)計(jì)圖紙，而對(duì)象則是根據(jù)這個(gè)設(shè)計(jì)圖紙建出來(lái)的房子。

下圖中，玩具模型就可以代表一個(gè)類(lèi)，而具體生產(chǎn)出來(lái)的玩具就可以代表一個(gè)對(duì)象：

總之，類(lèi)就是創(chuàng)建對(duì)象的模板。

而type又是創(chuàng)建類(lèi)的模板，那么我們就可以通過(guò)type創(chuàng)建自己想要的類(lèi)。

比如定義一個(gè) Hello 的 class：

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

當(dāng) Python 解釋器載入 hello 模塊時(shí)，就會(huì)依次執(zhí)行該模塊的所有語(yǔ)句，執(zhí)行結(jié)果就是動(dòng)態(tài)創(chuàng)建出一個(gè) Hello 的 class對(duì)象。

type()函數(shù)既可以查看一個(gè)類(lèi)型或變量的類(lèi)型，也可以根據(jù)參數(shù)創(chuàng)建出新的類(lèi)型，比如上面那段類(lèi)的定義本質(zhì)上就是：

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

type()函數(shù)創(chuàng)建class 對(duì)象，依次傳入 3 個(gè)參數(shù)：

• class 類(lèi)的名稱(chēng)；
• 繼承的父類(lèi)集合，注意 Python 支持多重繼承，如果只有一個(gè)父類(lèi)，別忘了 tuple 的單元素寫(xiě)法；
• class 的方法名稱(chēng)與函數(shù)綁定以及字段名稱(chēng)與對(duì)應(yīng)的值，這里我們把函數(shù) fn 綁定到方法名 hello 上。

通過(guò) type() 函數(shù)創(chuàng)建的類(lèi)和直接寫(xiě) class 是完全一樣的，因?yàn)?Python 解釋器遇到 class 定義時(shí)，僅僅是掃描一下class 定義的語(yǔ)法，然后調(diào)用 type() 函數(shù)創(chuàng)建出 class。

正常情況下，我們肯定都是用 class Xxx... 來(lái)定義類(lèi)，但是type() 函數(shù)允許我們動(dòng)態(tài)創(chuàng)建出類(lèi)來(lái)，這意味著Python這門(mén)動(dòng)態(tài)語(yǔ)言支持運(yùn)行期動(dòng)態(tài)創(chuàng)建類(lèi)。你可能感受不到這有多強(qiáng)大，要知道想在靜態(tài)語(yǔ)言運(yùn)行期創(chuàng)建類(lèi)，必須構(gòu)造源代碼字符串再調(diào)用編譯器，或者借助一些工具生成字節(jié)碼實(shí)現(xiàn)，本質(zhì)上都是動(dòng)態(tài)編譯，會(huì)非常復(fù)雜。

metaclass到底是什么

那type和metaclass有什么關(guān)系呢？metaclass到底是什么呢？

我認(rèn)為metaclass 其實(shí)就是type或type的子類(lèi)，通過(guò)繼承type，重載__call__運(yùn)算符，便可以在class類(lèi)對(duì)象創(chuàng)建時(shí)作出一些修改。

對(duì)于類(lèi) MyClass：

class MyClass():
 pass

其實(shí)相當(dāng)于：

class MyClass(metaclass = type):
 pass

一旦我們把它的 metaclass 設(shè)置成 MyMeta：

class MyClass(metaclass = MyMeta):
 pass

MyClass 就不再由原生的 type 創(chuàng)建，而是會(huì)調(diào)用 MyMeta 的__call__運(yùn)算符重載。

class = type(classname, superclasses, attributedict) 
## 變?yōu)榱?/span>
class = MyMeta(classname, superclasses, attributedict)

對(duì)于具有繼承關(guān)系的類(lèi)：

class Foo(Bar):
 pass

Python做了如下的操作：

• Foo中有__metaclass__這個(gè)屬性嗎？如果是，Python會(huì)通過(guò)__metaclass__創(chuàng)建一個(gè)名字為Foo的類(lèi)(對(duì)象)
• 如果Python沒(méi)有找到__metaclass__，它會(huì)繼續(xù)在Bar（父類(lèi)）中尋找__metaclass__屬性，并嘗試做和前面同樣的操作。
• 如果Python在任何父類(lèi)中都找不到__metaclass__，它就會(huì)在模塊層次中去尋找__metaclass__，并嘗試做同樣的操作。
• 如果還是找不到__metaclass__，Python就會(huì)用內(nèi)置的type來(lái)創(chuàng)建這個(gè)類(lèi)對(duì)象。

假想一個(gè)很傻的例子，你決定在你的模塊里所有的類(lèi)的屬性都應(yīng)該是大寫(xiě)形式。有好幾種方法可以辦到，但其中一種就是通過(guò)在模塊級(jí)別設(shè)定__metaclass__：

class UpperAttrMetaClass(type):
    ## __new__ 是在__init__之前被調(diào)用的特殊方法
    ## __new__是用來(lái)創(chuàng)建對(duì)象并返回之的方法
    ## 而__init__只是用來(lái)將傳入的參數(shù)初始化給對(duì)象
    ## 你很少用到__new__，除非你希望能夠控制對(duì)象的創(chuàng)建
    ## 這里，創(chuàng)建的對(duì)象是類(lèi)，我們希望能夠自定義它，所以我們這里改寫(xiě)__new__
    ## 如果你希望的話，你也可以在__init__中做些事情
    ## 還有一些高級(jí)的用法會(huì)涉及到改寫(xiě)__call__特殊方法，但是我們這里不用
    def __new__(cls, future_class_name, future_class_parents, future_class_attr):
        ##遍歷屬性字典，把不是__開(kāi)頭的屬性名字變?yōu)榇髮?xiě)
        newAttr = {}
        for name,value in future_class_attr.items():
            if not name.startswith("__"):
                newAttr[name.upper()] = value

        ## 方法1：通過(guò)'type'來(lái)做類(lèi)對(duì)象的創(chuàng)建
        ## return type(future_class_name, future_class_parents, newAttr)

        ## 方法2：復(fù)用type.__new__方法，這就是基本的OOP編程
        ## return type.__new__(cls, future_class_name, future_class_parents, newAttr)

        ## 方法3：使用super方法
        return super(UpperAttrMetaClass, cls).__new__(cls, future_class_name, future_class_parents, newAttr)


class Foo(object, metaclass = UpperAttrMetaClass):
    bar = 'bip'

print(hasattr(Foo, 'bar'))
## 輸出: False
print(hasattr(Foo, 'BAR'))
## 輸出:True

f = Foo()
print(f.BAR)
## 輸出:'bip'

簡(jiǎn)易ORM框架的設(shè)計(jì)

ORM全稱(chēng)“Object Relational Mapping”，即對(duì)象-關(guān)系映射，就是把關(guān)系數(shù)據(jù)庫(kù)的一行映射為一個(gè)對(duì)象，也就是一個(gè)類(lèi)對(duì)應(yīng)一個(gè)表，這樣，寫(xiě)代碼更簡(jiǎn)單，不用直接操作SQL語(yǔ)句。

現(xiàn)在設(shè)計(jì)一下ORM框架的調(diào)用接口，比如用戶想通過(guò)User類(lèi)來(lái)操作對(duì)應(yīng)的數(shù)據(jù)庫(kù)表User，我們期待他寫(xiě)出這樣的代碼：

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

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

上面的接口通過(guò)常規(guī)方法很難或幾乎很難實(shí)現(xiàn)，但通過(guò)metaclass就會(huì)相對(duì)比較簡(jiǎn)單。核心思想就是通過(guò)metaclass修改類(lèi)的定義，將類(lèi)的所有Field類(lèi)型的屬性，用一個(gè)額外的字典去保存，然后從原定義中刪除。對(duì)于User創(chuàng)建對(duì)象時(shí)傳入的參數(shù)（id=12345, name='xiaoxiaoming'等）可以模仿字典的實(shí)現(xiàn)或直接繼承dict類(lèi)保存起來(lái)。

其中，父類(lèi)Model和屬性類(lèi)型StringField、IntegerField是由ORM框架提供的，剩下的魔術(shù)方法比如save()全部由metaclass自動(dòng)完成。雖然metaclass的編寫(xiě)會(huì)比較復(fù)雜，但ORM的使用者用起來(lái)卻異常簡(jiǎn)單。

首先定義Field類(lèi)，它負(fù)責(zé)保存數(shù)據(jù)庫(kù)表的字段名和字段類(lèi)型：

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)一步定義各種類(lèi)型的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')

下一步，編寫(xiě)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.setdefault('__table__', name) ## 當(dāng)未定義__table__屬性時(shí)，表名直接使用類(lèi)名
        return type.__new__(cls, name, bases, attrs)

以及基類(lèi)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))

在ModelMetaclass中，一共做了幾件事情：

1. 在當(dāng)前類(lèi)（比如User）中查找定義的類(lèi)的所有屬性，如果找到一個(gè)Field屬性，就把它保存到一個(gè)__mappings__的dict中，同時(shí)從類(lèi)屬性中刪除該Field屬性（避免實(shí)例的屬性遮蓋類(lèi)的同名屬性）；
2. 當(dāng)類(lèi)中未定義__table__字段時(shí)，直接將類(lèi)名保存到__table__字段中作為表名。

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

我們實(shí)現(xiàn)了save()方法，把一個(gè)實(shí)例保存到數(shù)據(jù)庫(kù)中。因?yàn)橛斜砻?，屬性到字段的映射和屬性值的集合，就可以?gòu)造出INSERT語(yǔ)句。

測(cè)試：

u = User(id=12345, name='xiaoxiaoming', email='test@orm.org', password='my-pwd')
u.save()

輸出如下：

Found model: User
Found mapping: id == > < IntegerField:id >
Found mapping: name == > < StringField:username >
Found mapping: email == > < StringField:email >
Found mapping: password == > < StringField:password >
SQL: insert into User (id,username,email,password) values (?,?,?,?)
ARGS: [12345, 'xiaoxiaoming', 'test@orm.org', 'my-pwd']

測(cè)試2：

class Blog(Model):
    __table__ = 'blogs'
    id = IntegerField('id')
    user_id = StringField('user_id')
    user_name = StringField('user_name')
    name = StringField('user_name')
    summary = StringField('summary')
    content = StringField('content')


b = Blog(id=12345, user_id='user_id1', user_name='xxm', name='orm框架的基本運(yùn)行機(jī)制', summary="簡(jiǎn)單講述一下orm框架的基本運(yùn)行機(jī)制",
         content="此處省略一萬(wàn)字...")
b.save()

輸出：

Found model: Blog
Found mapping: id == > < IntegerField:id >
Found mapping: user_id == > < StringField:user_id >
Found mapping: user_name == > < StringField:user_name >
Found mapping: name == > < StringField:user_name >
Found mapping: summary == > < StringField:summary >
Found mapping: content == > < StringField:content >
SQL: insert into blogs (id,user_id,user_name,user_name,summary,content) values (?,?,?,?,?,?)
ARGS: [12345, 'user_id1', 'xxm', 'orm框架的基本運(yùn)行機(jī)制', '簡(jiǎn)單講述一下orm框架的基本運(yùn)行機(jī)制', '此處省略一萬(wàn)字...']

可以看到，save()方法已經(jīng)打印出了可執(zhí)行的SQL語(yǔ)句，以及參數(shù)列表，只需要真正連接到數(shù)據(jù)庫(kù)，執(zhí)行該SQL語(yǔ)句，就可以完成真正的功能。

YAML序列化工具的實(shí)現(xiàn)原理淺析

YAML是一個(gè)家喻戶曉的 Python 工具，可以方便地序列化 / 逆序列化結(jié)構(gòu)數(shù)據(jù)。

官方文檔：https://pyyaml.org/wiki/PyYAMLDocumentation

安裝：

pip install pyyaml

YAMLObject 的任意子類(lèi)支持序列化和反序列化（serialization & deserialization）。比如說(shuō)下面這段代碼：

import yaml


class Monster(yaml.YAMLObject):
    yaml_tag = '!Monster'

    def __init__(self, name, hp, ac, attacks):
        self.name = name
        self.hp = hp
        self.ac = ac
        self.attacks = attacks

    def __repr__(self):
        return f"{self.__class__.__name__}(name={self.name}, hp={self.hp}, ac={self.ac}, attacks={self.attacks})"


monster1 = yaml.load("""
--- !Monster
name: Cave spider
hp: [2,6]
ac: 16
attacks: [BITE, HURT]
""")
print(monster1, type(monster1))

monster2 = Monster(name='Cave lizard', hp=[3, 6], ac=16, attacks=['BITE', 'HURT'])
print(yaml.dump(monster2))

運(yùn)行結(jié)果：

Monster(name=Cave spider, hp=[2, 6], ac=16, attacks=['BITE', 'HURT']) < class '__main__.Monster' >
!Monster
ac: 16
attacks: [BITE, HURT]
hp: [3, 6]
name: Cave lizard

這里面調(diào)用統(tǒng)一的 yaml.load()，就能把任意一個(gè) yaml 序列載入成一個(gè) Python Object；而調(diào)用統(tǒng)一的 yaml.dump()，就能把一個(gè) YAMLObject 子類(lèi)序列化。

對(duì)于 load() 和 dump() 的使用者來(lái)說(shuō)，他們完全不需要提前知道任何類(lèi)型信息，這讓超動(dòng)態(tài)配置編程成了可能。比方說(shuō)，在一個(gè)智能語(yǔ)音助手的大型項(xiàng)目中，我們有 1 萬(wàn)個(gè)語(yǔ)音對(duì)話場(chǎng)景，每一個(gè)場(chǎng)景都是不同團(tuán)隊(duì)開(kāi)發(fā)的。作為智能語(yǔ)音助手的核心團(tuán)隊(duì)成員，我不可能去了解每個(gè)子場(chǎng)景的實(shí)現(xiàn)細(xì)節(jié)。

在動(dòng)態(tài)配置實(shí)驗(yàn)不同場(chǎng)景時(shí)，經(jīng)常是今天我要實(shí)驗(yàn)場(chǎng)景 A 和 B 的配置，明天實(shí)驗(yàn) B 和 C 的配置，光配置文件就有幾萬(wàn)行量級(jí)，工作量不可謂不小。而應(yīng)用這樣的動(dòng)態(tài)配置理念，就可以讓引擎根據(jù)配置文件，動(dòng)態(tài)加載所需要的 Python 類(lèi)。

對(duì)于 YAML 的使用者也很方便，只要簡(jiǎn)單地繼承 yaml.YAMLObject，就能讓你的 Python Object 具有序列化和逆序列化能力。

據(jù)說(shuō)即使是在大廠 Google 的 Python 開(kāi)發(fā)者，發(fā)現(xiàn)能深入解釋 YAML 這種設(shè)計(jì)模式優(yōu)點(diǎn)的人，大概只有 10%。而能知道類(lèi)似 YAML 的這種動(dòng)態(tài)序列化 / 逆序列化功能正是用 metaclass 實(shí)現(xiàn)的人，可能只有 1% 了。而能夠?qū)AML 怎樣用 metaclass 實(shí)現(xiàn)動(dòng)態(tài)序列化 / 逆序列化功能講出一二的可能只有 0.1%了。

對(duì)于YAMLObject 的 load和dump() 功能，簡(jiǎn)單來(lái)說(shuō)，我們需要一個(gè)全局的注冊(cè)器，讓 YAML 知道，序列化文本中的!Monster需要載入成 Monster 這個(gè) Python 類(lèi)型，Monster 這個(gè) Python 類(lèi)型需要被序列化為!Monster標(biāo)簽開(kāi)頭的字符串。

一個(gè)很自然的想法就是，那我們建立一個(gè)全局變量叫 registry，把所有需要逆序列化的 YAMLObject，都注冊(cè)進(jìn)去。比如下面這樣：

registry = {}
 
def add_constructor(target_class):
    registry[target_class.yaml_tag] = target_class

然后，在 Monster 類(lèi)定義后面加上下面這行代碼：

add_constructor(Monster)

這樣的缺點(diǎn)很明顯，對(duì)于 YAML 的使用者來(lái)說(shuō)，每一個(gè) YAML 的可逆序列化的類(lèi) Foo 定義后，都需要加上一句話add_constructor(Foo)。這無(wú)疑給開(kāi)發(fā)者增加了麻煩，也更容易出錯(cuò)，畢竟開(kāi)發(fā)者很容易忘了這一點(diǎn)。

更優(yōu)雅的實(shí)現(xiàn)方式自然是通過(guò)metaclass 解決了這個(gè)問(wèn)題，YAML 的源碼正是這樣實(shí)現(xiàn)的：

class YAMLObjectMetaclass(type):
    def __init__(cls, name, bases, kwds):
        super(YAMLObjectMetaclass, cls).__init__(name, bases, kwds)
        if 'yaml_tag' in kwds and kwds['yaml_tag'] is not None:
            cls.yaml_loader.add_constructor(cls.yaml_tag, cls.from_yaml)
            cls.yaml_dumper.add_representer(cls, cls.to_yaml)
    ## 省略其余定義
 
class YAMLObject(metaclass=YAMLObjectMetaclass):
    yaml_loader = Loader
    yaml_dumper = Dumper
    ## 省略其余定義

可以看到，YAMLObject 把 metaclass 聲明成了 YAMLObjectMetaclass，YAMLObjectMetaclass則會(huì)改變YAMLObject類(lèi)和其子類(lèi)的定義，就是下面這行代碼將YAMLObject 的子類(lèi)加入到了yaml的兩個(gè)全局注冊(cè)表中：

cls.yaml_loader.add_constructor(cls.yaml_tag, cls.from_yaml)
cls.yaml_dumper.add_representer(cls, cls.to_yaml)

YAML 應(yīng)用 metaclass，攔截了所有 YAMLObject 子類(lèi)的定義。也就是說(shuō)，在你定義任何 YAMLObject 子類(lèi)時(shí)，Python 會(huì)強(qiáng)行插入運(yùn)行上面這段代碼，把我們之前想要的add_constructor(Foo)和add_representer(Foo)給自動(dòng)加上。所以 YAML 的使用者，無(wú)需自己去手寫(xiě)add_constructor(Foo)和add_representer(Foo)。

總結(jié)

這次分享主要是簡(jiǎn)單的淺析了 metaclass 的實(shí)現(xiàn)機(jī)制。通過(guò)實(shí)現(xiàn)一個(gè)orm框架并解讀 YAML 的源碼，相信你已經(jīng)對(duì)metaclass 有了不錯(cuò)的理解。

metaclass 是 Python 黑魔法級(jí)別的語(yǔ)言特性，它可以改變類(lèi)創(chuàng)建時(shí)的行為，這種強(qiáng)大的功能使用起來(lái)務(wù)必小心。

看完本文，你覺(jué)得裝飾器和 metaclass 有什么區(qū)別呢？歡迎下方留言和我討論。記得一鍵三連呦，筆芯！