9.14 捕獲類的屬性定義順序

問題

你想自動記錄一個類中屬性和方法定義的順序，然后可以利用它來做很多操作（比如序列化、映射到數(shù)據(jù)庫等等）。

解決方案

利用元類可以很容易的捕獲類的定義信息。下面是一個例子，使用了一個OrderedDict來記錄描述器的定義順序：

from collections import OrderedDict

# A set of descriptors for various types
class Typed:
    _expected_type = type(None)
    def __init__(self, name=None):
        self._name = name

    def __set__(self, instance, value):
        if not isinstance(value, self._expected_type):
            raise TypeError('Expected ' + str(self._expected_type))
        instance.__dict__[self._name] = value

class Integer(Typed):
    _expected_type = int

class Float(Typed):
    _expected_type = float

class String(Typed):
    _expected_type = str

# Metaclass that uses an OrderedDict for class body
class OrderedMeta(type):
    def __new__(cls, clsname, bases, clsdict):
        d = dict(clsdict)
        order = []
        for name, value in clsdict.items():
            if isinstance(value, Typed):
                value._name = name
                order.append(name)
        d['_order'] = order
        return type.__new__(cls, clsname, bases, d)

    @classmethod
    def __prepare__(cls, clsname, bases):
        return OrderedDict()

在這個元類中，執(zhí)行類主體時描述器的定義順序會被一個 OrderedDict``捕獲到，生成的有序名稱從字典中提取出來并放入類屬性 ``_order 中。這樣的話類中的方法可以通過多種方式來使用它。例如，下面是一個簡單的類，使用這個排序字典來實現(xiàn)將一個類實例的數(shù)據(jù)序列化為一行CSV數(shù)據(jù)：

class Structure(metaclass=OrderedMeta):
    def as_csv(self):
        return ','.join(str(getattr(self,name)) for name in self._order)

# Example use
class Stock(Structure):
    name = String()
    shares = Integer()
    price = Float()

    def __init__(self, name, shares, price):
        self.name = name
        self.shares = shares
        self.price = price

我們在交互式環(huán)境中測試一下這個Stock類：

>>> s = Stock('GOOG',100,490.1)
>>> s.name
'GOOG'
>>> s.as_csv()
'GOOG,100,490.1'
>>> t = Stock('AAPL','a lot', 610.23)
Traceback (most recent call last):
    File "<stdin>", line 1, in <module>
    File "dupmethod.py", line 34, in __init__
TypeError: shares expects <class 'int'>
>>>

討論

本節(jié)一個關(guān)鍵點就是OrderedMeta元類中定義的 __prepare__() 方法。這個方法會在開始定義類和它的父類的時候被執(zhí)行。它必須返回一個映射對象以便在類定義體中被使用到。我們這里通過返回了一個OrderedDict而不是一個普通的字典，可以很容易的捕獲定義的順序。

如果你想構(gòu)造自己的類字典對象，可以很容易的擴展這個功能。比如，下面的這個修改方案可以防止重復(fù)的定義：

from collections import OrderedDict

class NoDupOrderedDict(OrderedDict):
    def __init__(self, clsname):
        self.clsname = clsname
        super().__init__()
    def __setitem__(self, name, value):
        if name in self:
            raise TypeError('{} already defined in {}'.format(name, self.clsname))
        super().__setitem__(name, value)

class OrderedMeta(type):
    def __new__(cls, clsname, bases, clsdict):
        d = dict(clsdict)
        d['_order'] = [name for name in clsdict if name[0] != '_']
        return type.__new__(cls, clsname, bases, d)

    @classmethod
    def __prepare__(cls, clsname, bases):
        return NoDupOrderedDict(clsname)

下面我們測試重復(fù)的定義會出現(xiàn)什么情況：

>>> class A(metaclass=OrderedMeta):
... def spam(self):
... pass
... def spam(self):
... pass
...
Traceback (most recent call last):
    File "<stdin>", line 1, in <module>
    File "<stdin>", line 4, in A
    File "dupmethod2.py", line 25, in __setitem__
        (name, self.clsname))
TypeError: spam already defined in A
>>>

最后還有一點很重要，就是在 __new__() 方法中對于元類中被修改字典的處理。盡管類使用了另外一個字典來定義，在構(gòu)造最終的 class 對象的時候，我們?nèi)匀恍枰獙⑦@個字典轉(zhuǎn)換為一個正確的 dict 實例。通過語句 d = dict(clsdict) 來完成這個效果。

對于很多應(yīng)用程序而已，能夠捕獲類定義的順序是一個看似不起眼卻又非常重要的特性。例如，在對象關(guān)系映射中，我們通常會看到下面這種方式定義的類：

class Stock(Model):
    name = String()
    shares = Integer()
    price = Float()

在框架底層，我們必須捕獲定義的順序來將對象映射到元組或數(shù)據(jù)庫表中的行（就類似于上面例子中的 as_csv() 的功能）。這節(jié)演示的技術(shù)非常簡單，并且通常會比其他類似方法（通常都要在描述器類中維護一個隱藏的計數(shù)器）要簡單的多。