9.18 以編程方式定義類

問題

你在寫一段代碼，最終需要?jiǎng)?chuàng)建一個(gè)新的類對(duì)象。你考慮將類的定義源代碼以字符串的形式發(fā)布出去。并且使用函數(shù)比如 exec() 來執(zhí)行它，但是你想尋找一個(gè)更加優(yōu)雅的解決方案。

解決方案

你可以使用函數(shù) types.new_class() 來初始化新的類對(duì)象。你需要做的只是提供類的名字、父類元組、關(guān)鍵字參數(shù)，以及一個(gè)用成員變量填充類字典的回調(diào)函數(shù)。例如：

# stock.py
# Example of making a class manually from parts

# Methods
def __init__(self, name, shares, price):
    self.name = name
    self.shares = shares
    self.price = price
def cost(self):
    return self.shares * self.price

cls_dict = {
    '__init__' : __init__,
    'cost' : cost,
}

# Make a class
import types

Stock = types.new_class('Stock', (), {}, lambda ns: ns.update(cls_dict))
Stock.__module__ = __name__

這種方式會(huì)構(gòu)建一個(gè)普通的類對(duì)象，并且安裝你的期望工作：

>>> s = Stock('ACME', 50, 91.1)
>>> s
<stock.Stock object at 0x1006a9b10>
>>> s.cost()
4555.0
>>>

這種方法中，一個(gè)比較難理解的地方是在調(diào)用完 types.new_class() 對(duì) Stock.__module__ 的賦值。每次當(dāng)一個(gè)類被定義后，它的 __module__ 屬性包含定義它的模塊名。這個(gè)名字用于生成 __repr__() 方法的輸出。它同樣也被用于很多庫，比如 pickle 。因此，為了讓你創(chuàng)建的類是“正確”的，你需要確保這個(gè)屬性也設(shè)置正確了。

如果你想創(chuàng)建的類需要一個(gè)不同的元類，可以通過 types.new_class() 第三個(gè)參數(shù)傳遞給它。例如：

>>> import abc
>>> Stock = types.new_class('Stock', (), {'metaclass': abc.ABCMeta},
...                         lambda ns: ns.update(cls_dict))
...
>>> Stock.__module__ = __name__
>>> Stock
<class '__main__.Stock'>
>>> type(Stock)
<class 'abc.ABCMeta'>
>>>

第三個(gè)參數(shù)還可以包含其他的關(guān)鍵字參數(shù)。比如，一個(gè)類的定義如下：

class Spam(Base, debug=True, typecheck=False):
    pass

那么可以將其翻譯成如下的 new_class() 調(diào)用形式：

Spam = types.new_class('Spam', (Base,),
                        {'debug': True, 'typecheck': False},
                        lambda ns: ns.update(cls_dict))

new_class() 第四個(gè)參數(shù)最神秘，它是一個(gè)用來接受類命名空間的映射對(duì)象的函數(shù)。通常這是一個(gè)普通的字典，但是它實(shí)際上是 __prepare__() 方法返回的任意對(duì)象，這個(gè)在9.14小節(jié)已經(jīng)介紹過了。這個(gè)函數(shù)需要使用上面演示的 update() 方法給命名空間增加內(nèi)容。

討論

很多時(shí)候如果能構(gòu)造新的類對(duì)象是很有用的。有個(gè)很熟悉的例子是調(diào)用 collections.namedtuple() 函數(shù)，例如：

>>> Stock = collections.namedtuple('Stock', ['name', 'shares', 'price'])
>>> Stock
<class '__main__.Stock'>
>>>

namedtuple() 使用 exec() 而不是上面介紹的技術(shù)。但是，下面通過一個(gè)簡(jiǎn)單的變化，我們直接創(chuàng)建一個(gè)類：

import operator
import types
import sys

def named_tuple(classname, fieldnames):
    # Populate a dictionary of field property accessors
    cls_dict = { name: property(operator.itemgetter(n))
                for n, name in enumerate(fieldnames) }

    # Make a __new__ function and add to the class dict
    def __new__(cls, *args):
        if len(args) != len(fieldnames):
            raise TypeError('Expected {} arguments'.format(len(fieldnames)))
        return tuple.__new__(cls, args)

    cls_dict['__new__'] = __new__

    # Make the class
    cls = types.new_class(classname, (tuple,), {},
                        lambda ns: ns.update(cls_dict))

    # Set the module to that of the caller
    cls.__module__ = sys._getframe(1).f_globals['__name__']
    return cls

這段代碼的最后部分使用了一個(gè)所謂的”框架魔法”，通過調(diào)用 sys._getframe() 來獲取調(diào)用者的模塊名。另外一個(gè)框架魔法例子在2.15小節(jié)中有介紹過。

下面的例子演示了前面的代碼是如何工作的：

>>> Point = named_tuple('Point', ['x', 'y'])
>>> Point
<class '__main__.Point'>
>>> p = Point(4, 5)
>>> len(p)
2
>>> p.x
4
>>> p.y
5
>>> p.x = 2
Traceback (most recent call last):
    File "<stdin>", line 1, in <module>
AttributeError: can't set attribute
>>> print('%s %s' % p)
4 5
>>>

這項(xiàng)技術(shù)一個(gè)很重要的方面是它對(duì)于元類的正確使用。你可能像通過直接實(shí)例化一個(gè)元類來直接創(chuàng)建一個(gè)類：

Stock = type('Stock', (), cls_dict)

這種方法的問題在于它忽略了一些關(guān)鍵步驟，比如對(duì)于元類中 __prepare__() 方法的調(diào)用。通過使用 types.new_class() ，你可以保證所有的必要初始化步驟都能得到執(zhí)行。比如，types.new_class() 第四個(gè)參數(shù)的回調(diào)函數(shù)接受 __prepare__() 方法返回的映射對(duì)象。

如果你僅僅只是想執(zhí)行準(zhǔn)備步驟，可以使用 types.prepare_class() 。例如：

import types
metaclass, kwargs, ns = types.prepare_class('Stock', (), {'metaclass': type})

它會(huì)查找合適的元類并調(diào)用它的 __prepare__() 方法。然后這個(gè)元類保存它的關(guān)鍵字參數(shù)，準(zhǔn)備命名空間后被返回。

更多信息, 請(qǐng)參考 PEP 3115 ,以及 Python documentation .