在Python中使用元類的教程

type()

動態語言和靜態語言最大的不同，就是函數和類的定義，不是編譯時間定義的，而是運行時動態建立的。

比方說我們要定義一個Hello的class，就寫一個hello.py模組：

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

當Python解譯器載入hello模組時，就會依次執行該模組的所有語句，執行結果就是動態建立出一個Hello的class對象，測試如下：

>>> from hello import Hello>>> h = Hello()>>> h.hello()Hello, world.>>> print(type(Hello))>>> print(type(h))

type()函數可以查看一個類型或變數的類型，Hello是一個class，它的類型就是type，而h是一個執行個體，它的類型就是class Hello。

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

type()函數既可以返回一個對象的類型，又可以建立出新的類型，比如，我們可以通過type()函數建立出Hello類，而無需通過class Hello(object)...的定義：

>>> def fn(self, name='world'): # 先定義函數...   print('Hello, %s.' % name)...>>> Hello = type('Hello', (object,), dict(hello=fn)) # 建立Hello class>>> h = Hello()>>> h.hello()Hello, world.>>> print(type(Hello))>>> print(type(h))

要建立一個class對象，type()函數依次傳入3個參數：

1. class的名稱；
2. 繼承的父類集合，注意Python支援多重繼承，如果只有一個父類，別忘了tuple的單元素寫法；
3. class的方法名稱與函數綁定，這裡我們把函數fn綁定到方法名hello上。

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

正常情況下，我們都用class Xxx...來定義類，但是，type()函數也允許我們動態建立出類來，也就是說，動態語言本身支援運行期動態建立類，這和靜態語言有非常大的不同，要在靜態語言運行期建立類，必須構造原始碼字串再調用編譯器，或者藉助一些工具產生位元組碼實現，本質上都是動態編譯，會非常複雜。
metaclass

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

metaclass，直譯為元類，簡單的解釋就是：

當我們定義了類以後，就可以根據這個類建立出執行個體，所以：先定義類，然後建立執行個體。

但是如果我們想建立出類呢？那就必鬚根據metaclass建立出類，所以：先定義metaclass，然後建立類。

串連起來就是：先定義metaclass，就可以建立類，最後建立執行個體。

所以，metaclass允許你建立類或者修改類。換句話說，你可以把類看成是metaclass建立出來的“執行個體”。

metaclass是Python物件導向裡最難理解，也是最難使用的魔術代碼。正常情況下，你不會碰到需要使用metaclass的情況，所以，以下內容看不懂也沒關係，因為基本上你不會用到。

我們先看一個簡單的例子，這個metaclass可以給我們自訂的MyList增加一個add方法：

定義ListMetaclass，按照預設習慣，metaclass的類名總是以Metaclass結尾，以便清楚地表示這是一個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) class MyList(list):  __metaclass__ = ListMetaclass # 指示使用ListMetaclass來定製類

當我們寫下__metaclass__ = ListMetaclass語句時，魔術就生效了，它指示Python解譯器在建立MyList時，要通過ListMetaclass.__new__()來建立，在此，我們可以修改類的定義，比如，加上新的方法，然後，返回修改後的定義。

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

• 當前準備建立的類的對象；
• 類的名字；
• 類繼承的父類集合；
• 類的方法集合。

測試一下MyList是否可以調用add()方法：

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

而普通的list沒有add()方法：

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

動態修改有什麼意義？直接在MyList定義中寫上add()方法不是更簡單嗎？正常情況下，確實應該直接寫，通過metaclass修改純屬變態。

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

ORM全稱“Object Relational Mapping”，即對象-關係映射，就是把關聯式資料庫的一行映射為一個對象，也就是一個類對應一個表，這樣，寫代碼更簡單，不用直接操作SQL語句。

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

讓我們來嘗試編寫一個ORM架構。

編寫底層模組的第一步，就是先把調用介面寫出來。比如，使用者如果使用這個ORM架構，想定義一個User類來操作對應的資料庫表User，我們期待他寫出這樣的代碼：

class User(Model):  # 定義類的屬性到列的映射：  id = IntegerField('id')  name = StringField('username')  email = StringField('email')  password = StringField('password') # 建立一個執行個體：u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')# 儲存到資料庫：u.save()

其中，父類Model和屬性類型StringField、IntegerField是由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，比如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')

下一步，就是編寫最複雜的ModelMetaclass了：

class ModelMetaclass(type):  def __new__(cls, name, bases, attrs):    if name=='Model':      return type.__new__(cls, name, bases, attrs)    mappings = dict()    for k, v in attrs.iteritems():      if isinstance(v, Field):        print('Found mapping: %s==>%s' % (k, v))        mappings[k] = v    for k in mappings.iterkeys():      attrs.pop(k)    attrs['__table__'] = name # 假設表名和類名一致    attrs['__mappings__'] = mappings # 儲存屬性和列的映射關係    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__.iteritems():      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中定義的__metaclass__的ModelMetaclass來建立User類，也就是說，metaclass可以隱式地繼承到子類，但子類自己卻感覺不到。

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

• 排除掉對Model類的修改；
• 在當前類（比如User）中尋找定義的類的所有屬性，如果找到一個Field屬性，就把它儲存到一個__mappings__的dict中，同時從類屬性中刪除該Field屬性，否則，容易造成執行階段錯誤；
• 把表名儲存到__table__中，這裡簡化為表名預設為類名。

在Model類中，就可以定義各種操作資料庫的方法，比如save()，delete()，find()，update等等。

我們實現了save()方法，把一個執行個體儲存到資料庫中。因為有表名，屬性到欄位的映射和屬性值的集合，就可以構造出INSERT語句。

編寫代碼試試：

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

輸出如下：

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

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

不到100行代碼，我們就通過metaclass實現了一個精簡的ORM架構，完整的代碼從這裡下載：

https://github.com/michaelliao/learn-python/blob/master/metaclass/simple_orm.py

最後解釋一下類屬性和執行個體屬性。直接在class中定義的是類屬性：

class Student(object):  name = 'Student'

執行個體屬性必須通過執行個體來綁定，比如self.name = 'xxx'。來測試一下：

>>> # 建立執行個體s：>>> s = Student()>>> # 列印name屬性，因為執行個體並沒有name屬性，所以會繼續尋找class的name屬性：>>> print(s.name)Student>>> # 這和調用Student.name是一樣的：>>> print(Student.name)Student>>> # 給執行個體綁定name屬性：>>> s.name = 'Michael'>>> # 由於執行個體屬性優先順序比類屬性高，因此，它會屏蔽掉類的name屬性：>>> print(s.name)Michael>>> # 但是類屬性並未消失，用Student.name仍然可以訪問：>>> print(Student.name)Student>>> # 如果刪除執行個體的name屬性：>>> del s.name>>> # 再次調用s.name，由於執行個體的name屬性沒有找到，類的name屬性就顯示出來了：>>> print(s.name)Student

因此，在編寫程式的時候，千萬不要把執行個體屬性和類屬性使用相同的名字。

在我們編寫的ORM中，ModelMetaclass會刪除掉User類的所有類屬性，目的就是避免造成混淆。

