1. 程式人生 > >Python中使用type、metaclass動態創建方法和屬性

Python中使用type、metaclass動態創建方法和屬性

用戶 一個 基礎 元素 錯誤 raise 理解 子類 use

1: type()

我們知道動態語言和靜態語言最大的不同,就是函數和類的定義,不是編譯時定義的,而是運行時動態創建的。

比方說我們要定義一個Person的class:

class Person(object):
    def name(self, name=Kaven):
        print(My name is: %s. % name)

p = Person()
p.name()
print(type(Person))
print(type(p))

輸出:

1 My name is: Kaven.
2 <class type
> 3 <class __main__.Person>

我們說class的定義是運行時動態創建的,而創建class的方法就是使用type()函數。

type()函數既可以返回一個對象的類型,又可以創建出新的類型,比如,我們可以通過type()函數創建出Person類,而無需通過class Person(object)的定義:

# -*- coding: utf-8 -*-
def func(self, name=Kaven): # 自定義函數
    print(My name is: %s. % name)

Person = type(
Person, (object,), dict(name=func)) # 創建Person class h = Person() h.name() print(type(Person) =, type(Person)) print(type(h) =, type(h))

輸出:

1 My name is: Kaven.
2 type(Person) = <class type>
3 type(h) = <class __main__.Person>

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

  1. class的名稱;
  2. 繼承的父類集合,註意Python支持多重繼承,如果只有一個父類,使用tuple的單元素寫法;
  3. class的方法名稱與函數綁定,這裏我們把函數func綁定到方法名name上。

通過type()函數創建的類和直接寫class是完全一樣的,因為Python解釋器遇到class定義時,僅僅是掃描一下class定義的語法,然後調用type()函數創建出class。

正常情況下,我們都用class X 來定義類,但是,type()函數也允許我們動態創建出類來,也就是說,動態語言本身支持運行期動態創建類,

這和靜態語言有非常大的不同,要在靜態語言運行期創建類,必須構造源代碼字符串再調用編譯器,或者借助一些工具生成字節碼實現,本質上都是動態編譯,會非常復雜。

2: metaclass

除了使用type()動態創建類以外,要控制類的創建行為,還可以使用metaclass。

metaclass,我們這樣理解就是:

當我們定義了類以後,就可以根據這個類創建出實例,所以:先定義類,然後創建實例。

但是如果我們想創建出類呢?那就必須根據metaclass創建出類,所以:先定義metaclass,然後創建類。最後創建實例。

所以,metaclass允許你創建類或者修改類。換句話說,你可以把類看成是metaclass創建出來的“實例”。

正常情況下,我們不會碰到需要使用metaclass的情況,所以,以下內容我盡我所理解的描述清楚,因為基本上大家可能不會用到。

我們先看一個簡單的例子,這個metaclass可以給我們自定義的MyFriend增加一個add方法:

定義FriendMetaclass,按照默認習慣,metaclass的類名總是以Metaclass結尾,以便清楚地表示這是一個metaclass:

# metaclass是創建類,所以必須從`type`類型派生:
class FriendMetaclass(type):
    def __new__(newcls, name, bases, attrs):
        attrs[add] = lambda self, value: self.append(value)
        return type.__new__(newcls, name, bases, attrs)

定義了FriendMetaclass,我們在定義類的時候還要指示使用FriendMetaclass來定制類,傳入關鍵字參數metaclass

# 指示使用FriendMetaclass來定制類
class MyFriend(list, metaclass=FriendMetaclass):
    pass

當我們傳入關鍵字參數metaclass時,魔術就生效了,它指示Python解釋器在創建MyFriend時,要通過FriendMetaclass.__new__()來創建,

在此,我們可以修改類的定義,比如,加上新的方法,然後,返回修改後的定義。

__new__()方法接收到的參數依次是:

  1. 當前準備創建的類的對象;

  2. 類的名字;

  3. 類繼承的父類集合;

  4. 類的方法集合。

完整代碼如下:

# -*- coding: utf-8 -*-

# metaclass是創建類,所以必須從`type`類型派生:
class FriendMetaclass(type):
    def __new__(newcls, name, bases, attrs):
        attrs[add] = lambda self, value: self.append(value)
        return type.__new__(newcls, name, bases, attrs)


# 指示使用FriendMetaclass來定制類
class MyFriend(list, metaclass=FriendMetaclass):
    pass


L = MyFriend()
L.add(喬峰)
L.add(慕容復)
L.add(鳩摩智)
L.add(玄燈大師)
print(L) # [‘喬峰‘, ‘慕容復‘, ‘鳩摩智‘, ‘玄燈大師‘]

動態修改有什麽意義呢?直接在MyFriend定義中寫上add()方法不是更簡單嗎?正常情況下,確實應該直接寫,通過metaclass修改純屬裝逼。

但是,總會遇到需要通過metaclass修改類定義的場景。ORM就是一個典型的例子。

我們知道ORM即對象-關系映射,就是把關系數據庫的一行映射為一個對象,也就是一個類對應一個表,這樣,寫代碼更簡單,不用直接操作SQL語句。

要編寫一個ORM框架,所有的類都只能動態定義,因為只有使用者才能根據表的結構定義出對應的類來。

讓我們來嘗試編寫一個ORM框架。
編寫底層模塊的第一步,就是先把調用接口寫出來。比如,使用者如果使用這個ORM框架,想定義一個User類來操作對應的數據庫表User,比如我們期待他寫出這樣的代碼:

# -*- coding: utf-8 -*-

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


# 創建一個實例:
u = User(id=1, name=loose, email=[email protected], password=123456)
# 保存到數據庫:
u.save()

其中,父類Model和屬性類型StringFieldIntegerField是由ORM框架提供的,剩下的魔術方法比如save()全部由metaclass自動完成。雖然metaclass的編寫會比較復雜,但ORM的使用者用起來卻非常簡單。

現在,我們就按上面的接口來實現該ORM。

首先來定義Field類,它負責保存數據庫表的字段名和字段類型

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的基礎上,進一步定義各種類型的Field,比如StringFieldIntegerField等等:

class StringField(Field):

    def __init__(self, name):
        super(StringField, self).__init__(name, varchar(20))


class IntegerField(Field):

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

下一步,就是編寫最復雜的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  # 保存屬性和列的映射關系
        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))

當用戶定義一個class User(Model)時,Python解釋器首先在當前類User的定義中查找metaclass,如果沒有找到,就繼續在父類Model中查找metaclass

如果找到了,就使用Model中定義的metaclassModelMetaclass來創建User類,也就是說,metaclass可以隱式地繼承到子類,但子類自己卻感覺不到。

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

  1. 排除掉對Model類的修改。

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

  3. 把表名保存到__table__中,這裏簡化為表名默認為類名。

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

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

完整代碼如下:

# -*- coding: utf-8 -*-

 簡單 ORM 使用 metaclass 示例 


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)


class StringField(Field):

    def __init__(self, name):
        super(StringField, self).__init__(name, varchar(20))


class IntegerField(Field):

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


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  # 保存屬性和列的映射關系
        attrs[__table__] = name  # 假設表名和類名一致
        return type.__new__(cls, name, bases, attrs)


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))


# testing code:

class User(Model):
    id = IntegerField(id)
    name = StringField(username)
    email = StringField(email)
    password = StringField(password)


u = User(id=1, name=loose, email=[email protected], password=123456)
u.save()

輸出:

1 Found model: User
2 Found mapping: id ==> <IntegerField:id>
3 Found mapping: name ==> <StringField:username>
4 Found mapping: email ==> <StringField:email>
5 Found mapping: password ==> <StringField:password>
6 SQL: insert into User (id,username,email,password) values (?,?,?,?)
7 ARGS: [1, loose, [email protected], 123456]

可以看到,save()方法已經打印出了可執行的SQL語句,以及參數列表,只需要真正連接到數據庫,執行該SQL語句,就可以完成真正的功能。

以上只是簡單的編寫ORM示例,實際應用會更復雜。有描述不當的清隨時指正哈

Python中使用type、metaclass動態創建方法和屬性