深刻理解Python中的元類別(metaclass)

譯註：這是一篇在Stack overflow上很熱的貼文。提問者自稱已經掌握了有關Python OOP程式設計中的各種概念，但始終覺得元類別(metaclass)難以理解。他知道這肯定和自省有關，但仍然覺得不太明白，希望大家可以給一些實際的例子和程式碼片段以幫助理解，以及在什麼情況下需要進行元編程。於是e-satis同學給了神一般的回复，該回复獲得了985點的讚同點數，更有人評論說這段回复應該加入到Python的官方文檔中去。而e-satis同學本人在Stack Overflow的聲望積分也高達64271分。以下就是這篇精彩的回應（提示：非常長）

類別也是物件

在理解元類別之前，你需要先掌握Python中的類別。 Python中類別的概念藉鑑於Smalltalk，這顯得有些奇特。在大多數程式語言中，類別就是一組用來描述如何產生一個物件的程式碼段。在Python中這一點仍然成立：

>>> class ObjectCreator(object):
…       pass
…
>>> my_object = ObjectCreator()
>>> print my_object

   

<__main__.objectcreator object at>

但是，Python中的類別還遠不止如此。類別同樣也是一種物件。是的，沒錯，就是對象。只要你使用關鍵字class，Python解釋器在執行的時候就會建立一個物件。下面的程式碼段：

>>> class ObjectCreator(object):
…       pass
…

   

將在記憶體中建立一個對象，名字就是ObjectCreator。這個物件（類別）本身擁有創建物件（類別實例）的能力，而這就是為什麼它是一個類別的原因。但是，它的本質仍然是一個對象，所以你可以對它做如下的操作：

1)   你可以將它賦值給一個變數

2)   你可以拷貝它

3)   你可以為它增加屬性

4)   你可以將它作為函數參數傳遞

下面是範例：

>>> print ObjectCreator     

# 你可以列印一個類別，因為它其實也是一個物件

            

# 你可以將類別做成參數傳給函數

>>> print 對> new_attribute = 'foo' 

#  你可以增加類別屬性

>>> print hasattr(ObjectCreator, 'new_attribute')

True

>>> print ObjectCreator.new_attribute>

>>> print ObjectCreator.new_attribute>

.你可以將類別賦值給一個變數

>>> print ObjectCreatorMirror()

 

動態地創建類別

因為類別也是對象，你可以在運行時動態的它們，就像其他任何物件一樣。首先，你可以在函數中建立類，使用class關鍵字即可。

>>> def echo(o):
…       print o
…
>>> echo(ObjectCreator)

但這還不夠動態，因為你還是需要自己寫整個類別的程式碼。由於類別也是對象，所以它們必須是透過什麼東西來產生的才對。當你使用class關鍵字時，Python解釋器會自動建立這個物件。但就和Python中的大多數事情一樣，Python仍然提供給你手動處理的方法。還記得內建函數type嗎？這個古老但強大的函數能夠讓你知道一個物件的類型是什麼，就像這樣：

>>> print type(1)

<__main__.objectcreator object at>

>>> print type("1")

>>> print type(ObjectCreator)

>>> print type(ObjectCreator())

這裡，type有一種完全不同的能力，它也能動態的創建。 type可以接受一個類別的描述作為參數，然後傳回一個類別。 （我知道，根據傳入參數的不同，同一個函數擁有兩種完全不同的用法是一件很愚蠢的事情，但這在Python中是為了保持向後相容性）

type可以像這樣工作：

type(類別名稱, 父類別的元組（針對繼承的情況，可以為空），包含屬性的字典（名稱和值）)

例如下面的程式碼：

>>> def choose_class(name):
…       if name == 'foo':
…           class Foo(object):
…               pass
…           return Foo     
# 返回的是类，不是类的实例
…       else:
…           class Bar(object):
…               pass
…           return Bar
…
>>> MyClass = choose_class('foo')
>>> print MyClass              
# 函数返回的是类，不是类的实例
<class &#39;__main__&#39;.Foo>
>>> print MyClass()            
# 你可以通过这个类创建类实例，也就是对象
   
<__main__.Foo object at 0x89c6d4c>

   

可以手動像

這樣創建：

>>> MyShinyClass = type('MyShinyClass', (), {})  

# 回傳一個類別物件

>>> print MyShinyClass

>Shi #  建立一個該類別的實例

你會發現我們使用「MyShinyClass」作為類別名，也可以把它當作一個變數來當作類別的參考。類別和變數是不同的，這裡沒有任何理由把事情弄的複雜。

type 接受一個字典來為類別定義屬性，因此

>>> class MyShinyClass(object):
…       pass

   

可以翻譯為：

>>> Foo = type('Foo', (), {'bar':), {'bar':並且可以將Foo當成一個普通的類別一樣使用：

>>> print Foo

<__main__.myshinyclass object at>

>>> print Foo.bar

True

>>> f = Foo()

>>> print f

<__main__.foo object at>

>>> print f.bar

True

当然，你可以向这个类继承，所以，如下的代码：

>>> class FooChild(Foo):

…       pass

就可以写成：

>>> FooChild = type('FooChild', (Foo,),{})

>>> print FooChild

>>> print FooChild.bar   

# bar属性是由Foo继承而来

True

最终你会希望为你的类增加方法。只需要定义一个有着恰当签名的函数并将其作为属性赋值就可以了。

>>> def echo_bar(self):
…       print self.bar
…
>>> FooChild = type('FooChild', (Foo,), {'echo_bar': echo_bar})
>>> hasattr(Foo, 'echo_bar')

   

False

>>> hasattr(FooChild, 'echo_bar')

True

>>> my_foo = FooChild()

>>> my_foo.echo_bar()

True

你可以看到，在Python中，类也是对象，你可以动态的创建类。这就是当你使用关键字class时Python在幕后做的事情，而这就是通过元类来实现的。

 

到底什么是元类（终于到主题了）

元类就是用来创建类的“东西”。你创建类就是为了创建类的实例对象，不是吗？但是我们已经学习到了Python中的类也是对象。好吧，元类就是用来创建这些类（对象）的，元类就是类的类，你可以这样理解 为：

MyClass = MetaClass()

MyObject = MyClass()

你已经看到了type可以让你像这样做：

MyClass = type('MyClass', (), {})

这是因为函数type实际上是一个元类。type就是Python在背后用来创建所有类的元类。现在你想知道那为什么type会全部采用小写形式而不是Type呢？好吧，我猜这是为了和str保持一致性，str是用来创建字符串对象的类，而int是用来创建整数对象的类。type就是创建类对象的类。你可以通过检查__class__属性来看到这一点。Python中所有的东西，注意，我是指所有的东西——都是对象。这包括整数、字符串、函数以及类。它们全部都是对象，而且它们都是从一个类创建而来。

>>> age = 35

>>> age.__class__

>>> name = 'bob'

>>> name.__class__

>>> def foo(): pass

>>>foo.__class__

>>> class Bar(object): pass

>>> b = Bar()

>>> b.__class__

现在，对于任何一个__class__的__class__属性又是什么呢？

>>> a.__class__.__class__

>>> age.__class__.__class__

>>> foo.__class__.__class__

>>> b.__class__.__class__

因此，元类就是创建类这种对象的东西。如果你喜欢的话，可以把元类称为“类工厂”（不要和工厂类搞混了:D） type就是Python的内建元类，当然了，你也可以创建自己的元类。

 

__metaclass__属性

你可以在写一个类的时候为其添加__metaclass__属性。

class Foo(object):

    __metaclass__ = something…

[…]

如果你这么做了，Python就会用元类来创建类Foo。小心点，这里面有些技巧。你首先写下class Foo(object)，但是类对象Foo还没有在内存中创建。Python会在类的定义中寻找__metaclass__属性，如果找到了，Python就会用它来创建类Foo，如果没有找到，就会用内建的type来创建这个类。把下面这段话反复读几次。当你写如下代码时 :

class Foo(Bar):

    pass

Python做了如下的操作：

Foo中有__metaclass__这个属性吗？如果是，Python会在内存中通过__metaclass__创建一个名字为Foo的类对象（我说的是类对象，请紧跟我的思路）。如果Python没有找到__metaclass__，它会继续在Bar（父类）中寻找__metaclass__属性，并尝试做和前面同样的操作。如果Python在任何父类中都找不到__metaclass__，它就会在模块层次中去寻找__metaclass__，并尝试做同样的操作。如果还是找不到__metaclass__,Python就会用内置的type来创建这个类对象。

现在的问题就是，你可以在__metaclass__中放置些什么代码呢？答案就是：可以创建一个类的东西。那么什么可以用来创建一个类呢？type，或者任何使用到type或者子类化type的东东都可以。

 

自定义元类

元类的主要目的就是为了当创建类时能够自动地改变类。通常，你会为API做这样的事情，你希望可以创建符合当前上下文的类。假想一个很傻的例子，你决定在你的模块里所有的类的属性都应该是大写形式。有好几种方法可以办到，但其中一种就是通过在模块级别设定__metaclass__。采用这种方法，这个模块中的所有类都会通过这个元类来创建，我们只需要告诉元类把所有的属性都改成大写形式就万事大吉了。

幸运的是，__metaclass__实际上可以被任意调用，它并不需要是一个正式的类（我知道，某些名字里带有‘class’的东西并不需要是一个class，画画图理解下，这很有帮助）。所以，我们这里就先以一个简单的函数作为例子开始。

# 元类会自动将你通常传给‘type’的参数作为自己的参数传入

def upper_attr(future_class_name, future_class_parents, future_class_attr):
     
'''返回一个类对象，将属性都转为大写形式'''
     
#  选择所有不以'__'开头的属性
    attrs = ((name, value) for name, value in future_class_attr.items() if not name.startswith('__'))
     
# 将它们转为大写形式
    uppercase_attr = dict((name.upper(), value) for name, value in attrs)
  
     
# 通过'type'来做类对象的创建
    return type(future_class_name, future_class_parents, uppercase_attr)
  
__metaclass__ = upper_attr  
#  这会作用到这个模块中的所有类
  
class Foo(object):
     
# 我们也可以只在这里定义__metaclass__，这样就只会作用于这个类中
    bar = 'bip'
print hasattr(Foo, 'bar')
# 输出: False
print hasattr(Foo, 'BAR')
# 输出:True
  
f = Foo()
print f.BAR
# 输出:'bip'

   

现在让我们再做一次，这一次用一个真正的class来当做元类。

# 请记住，'type'实际上是一个类，就像'str'和'int'一样
# 所以，你可以从type继承
class UpperAttrMetaClass(type):
     
# __new__ 是在__init__之前被调用的特殊方法
     
# __new__是用来创建对象并返回之的方法
     
# 而__init__只是用来将传入的参数初始化给对象
     
# 你很少用到__new__，除非你希望能够控制对象的创建
     
# 这里，创建的对象是类，我们希望能够自定义它，所以我们这里改写__new__
     
# 如果你希望的话，你也可以在__init__中做些事情
     
# 还有一些高级的用法会涉及到改写__call__特殊方法，但是我们这里不用
    def __new__(upperattr_metaclass, future_class_name, future_class_parents, future_class_attr):
        attrs = ((name, value) for name, value in future_class_attr.items() if not name.startswith('__'))
        uppercase_attr = dict((name.upper(), value) for name, value in attrs)
        return type(future_class_name, future_class_parents, uppercase_attr)
但是，这种方式其实不是OOP。我们直接调用了type，而且我们没有改写父类的__new__方法。现在让我们这样去处理:
class UpperAttrMetaclass(type):
    def __new__(upperattr_metaclass, future_class_name, future_class_parents, future_class_attr):
        attrs = ((name, value) for name, value in future_class_attr.items() if not name.startswith('__'))
        uppercase_attr = dict((name.upper(), value) for name, value in attrs)

  

         

# 复用type.__new__方法

         

# 这就是基本的OOP编程，没什么魔法

        return type.__new__(upperattr_metaclass, future_class_name, future_class_parents, uppercase_attr)

   

你可能已经注意到了有个额外的参数upperattr_metaclass，这并没有什么特别的。类方法的第一个参数总是表示当前的实例，就像在普通的类方法中的self参数一样。当然了，为了清晰起见，这里的名字我起的比较长。但是就像self一样，所有的参数都有它们的传统名称。因此，在真实的产品代码中一个元类应该是像这样的：

class UpperAttrMetaclass(type):
    def __new__(cls, name, bases, dct):
        attrs = ((name, value) for name, value in dct.items() if not name.startswith('__')
        uppercase_attr  = dict((name.upper(), value) for name, value in attrs)
        return type.__new__(cls, name, bases, uppercase_attr)
如果使用super方法的话，我们还可以使它变得更清晰一些，这会缓解继承（是的，你可以拥有元类，从元类继承，从type继承）
class UpperAttrMetaclass(type):
    def __new__(cls, name, bases, dct):
        attrs = ((name, value) for name, value in dct.items() if not name.startswith('__'))
        uppercase_attr = dict((name.upper(), value) for name, value in attrs)
        return super(UpperAttrMetaclass, cls).__new__(cls, name, bases, uppercase_attr)

   

就是这样，除此之外，关于元类真的没有别的可说的了。使用到元类的代码比较复杂，这背后的原因倒并不是因为元类本身，而是因为你通常会使用元类去做一些晦涩的事情，依赖于自省，控制继承等等。确实，用元类来搞些“黑暗魔法”是特别有用的，因而会搞出些复杂的东西来。但就元类本身而言，它们其实是很简单的：

1)   拦截类的创建

2)   修改类

3)   返回修改之后的类

 

为什么要用metaclass类而不是函数?

由于__metaclass__可以接受任何可调用的对象，那为何还要使用类呢，因为很显然使用类会更加复杂啊？这里有好几个原因：

1）  意图会更加清晰。当你读到UpperAttrMetaclass(type)时，你知道接下来要发生什么。

2） 你可以使用OOP编程。元类可以从元类中继承而来，改写父类的方法。元类甚至还可以使用元类。

3）  你可以把代码组织的更好。当你使用元类的时候肯定不会是像我上面举的这种简单场景，通常都是针对比较复杂的问题。将多个方法归总到一个类中会很有帮助，也会使得代码更容易阅读。

4） 你可以使用__new__, __init__以及__call__这样的特殊方法。它们能帮你处理不同的任务。就算通常你可以把所有的东西都在__new__里处理掉，有些人还是觉得用__init__更舒服些。

5） 哇哦，这东西的名字是metaclass，肯定非善类，我要小心！

 

究竟为什么要使用元类？

现在回到我们的大主题上来，究竟是为什么你会去使用这样一种容易出错且晦涩的特性？好吧，一般来说，你根本就用不上它：

“元类就是深度的魔法，99%的用户应该根本不必为此操心。如果你想搞清楚究竟是否需要用到元类，那么你就不需要它。那些实际用到元类的人都非常清楚地知道他们需要做什么，而且根本不需要解释为什么要用元类。”  —— Python界的领袖 Tim Peters

元类的主要用途是创建API。一个典型的例子是Django ORM。它允许你像这样定义：

class Person(models.Model):
    name = models.CharField(max_length=30)
    age = models.IntegerField()

   

但是如果你像这样做的话：

 
guy  = Person(name='bob', age='35')print guy.age

   

这并不会返回一个IntegerField对象，而是会返回一个int，甚至可以直接从数据库中取出数据。这是有可能的，因为models.Model定义了__metaclass__， 并且使用了一些魔法能够将你刚刚定义的简单的Person类转变成对数据库的一个复杂hook。Django框架将这些看起来很复杂的东西通过暴露出一个简单的使用元类的API将其化简，通过这个API重新创建代码，在背后完成真正的工作。

 

结语

首先，你知道了類別其實是能夠建立出類別實例的物件。好吧，事實上，類別本身也是實例，當然，它們是元類別的實例。

>>>class Foo(object): pass

>>> id(Foo)

Python中的一切都是對象，它們要麼是類別的實例，要麼是元類別的實例，除了type。 type其實是它自己的元類，在純Python環境中這可不是你能夠做到的，這是透過在實作層面耍一些小手段做到的。其次，元類別是很複雜的。對於非常簡單的類，你可能不希望透過使用元類來對類做修改。你可以透過其他兩種技巧來修改類別：

1） Monkey patching

2)   class decorators

當你需要動態修改類別時，99%的時間你最好使用上面這兩種技術。當然了，其實在99%的時間裡你根本就不需要動態修改類別 :D