深入理解Python中的元类

译注：这是一篇在Stack overflow上很热的帖子。提问者自称已经掌握了有关Python OOP编程中的各类概念，但始终以为元类(metaclass)难以理解。他知道这确定和自省有关，但仍然以为不太明白，但愿你们能够给出一些实际的例子和代码片断以帮助理解，以及在什么状况下须要进行元编程。因而e-satis同窗给出了神通常的回复，该回复得到了985点的赞同点数，更有人评论说这段回复应该加入到Python的官方文档中去。而e-satis同窗本人在Stack Overflow中的声望积分也高达64271分。如下就是这篇精彩的回复（提示：很是长）

类也是对象

在理解元类以前，你须要先掌握Python中的类。Python中类的概念借鉴于Smalltalk，这显得有些奇特。在大多数编程语言中，类就是一组用来描述如何生成一个对象的代码段。在Python中这一点仍然成立：

1 2 3 4 5 6

>>>classObjectCreator(object): …      pass … >>> my_object=ObjectCreator() >>>printmy_object <__main__.ObjectCreatorobjectat0x8974f2c>

可是，Python中的类还远不止如此。类一样也是一种对象。是的，没错，就是对象。只要你使用关键字class，Python解释器在执行的时候就会建立一个对象。下面的代码段：

1 2 3

>>>classObjectCreator(object): …      pass …

将在内存中建立一个对象，名字就是ObjectCreator。这个对象（类）自身拥有建立对象（类实例）的能力，而这就是为何它是一个类的缘由。可是，它的本质仍然是一个对象，因而乎你能够对它作以下的操做：

1)   你能够将它赋值给一个变量

2)   你能够拷贝它

3)   你能够为它增长属性

4)   你能够将它做为函数参数进行传递

下面是示例：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

>>>printObjectCreator    # 你能够打印一个类，由于它其实也是一个对象 <class'__main__.ObjectCreator'> >>>defecho(o): …      printo … >>> echo(ObjectCreator)                # 你能够将类作为参数传给函数 <class'__main__.ObjectCreator'> >>>printhasattr(ObjectCreator,'new_attribute') Fasle >>> ObjectCreator.new_attribute='foo'#  你能够为类增长属性 >>>printhasattr(ObjectCreator,'new_attribute') True >>>printObjectCreator.new_attribute foo >>> ObjectCreatorMirror=ObjectCreator# 你能够将类赋值给一个变量 >>>printObjectCreatorMirror() <__main__.ObjectCreatorobjectat0x8997b4c>

 

动态地建立类

由于类也是对象，你能够在运行时动态的建立它们，就像其余任何对象同样。首先，你能够在函数中建立类，使用class关键字便可。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

>>>defchoose_class(name): …      ifname=='foo': …          classFoo(object): …              pass …          returnFoo    # 返回的是类，不是类的实例 …      else: …          classBar(object): …              pass …          returnBar … >>> MyClass=choose_class('foo') >>>printMyClass             # 函数返回的是类，不是类的实例 <class'__main__'.Foo> >>>printMyClass()           # 你能够经过这个类建立类实例，也就是对象 <__main__.Fooobjectat0x89c6d4c>

但这还不够动态，由于你仍然须要本身编写整个类的代码。因为类也是对象，因此它们必须是经过什么东西来生成的才对。当你使用class关键字时，Python解释器自动建立这个对象。但就和Python中的大多数事情同样，Python仍然提供给你手动处理的方法。还记得内建函数type吗？这个古老但强大的函数可以让你知道一个对象的类型是什么，就像这样：

1 2 3 4 5 6 7 8

>>>printtype(1) <type'int'> >>>printtype("1") <type'str'> >>>printtype(ObjectCreator) <type'type'> >>>printtype(ObjectCreator()) <class'__main__.ObjectCreator'>

这里，type有一种彻底不一样的能力，它也能动态的建立类。type能够接受一个类的描述做为参数，而后返回一个类。（我知道，根据传入参数的不一样，同一个函数拥有两种彻底不一样的用法是一件很傻的事情，但这在Python中是为了保持向后兼容性）

type能够像这样工做：

1	type(类名, 父类的元组（针对继承的状况，能够为空），包含属性的字典（名称和值）)

好比下面的代码：

1 2	>>>classMyShinyClass(object): …      pass

能够手动像这样建立：

1 2 3 4 5

>>> MyShinyClass=type('MyShinyClass', (), {}) # 返回一个类对象 >>>printMyShinyClass <class'__main__.MyShinyClass'> >>>printMyShinyClass() #  建立一个该类的实例 <__main__.MyShinyClassobjectat0x8997cec>

你会发现咱们使用“MyShinyClass”做为类名，而且也能够把它当作一个变量来做为类的引用。类和变量是不一样的，这里没有任何理由把事情弄的复杂。

type 接受一个字典来为类定义属性，所以

1 2	>>>classFoo(object): …       bar=True

能够翻译为：

1	>>> Foo=type('Foo', (), {'bar':True})

而且能够将Foo当成一个普通的类同样使用：

1 2 3 4 5 6 7 8 9

>>>printFoo <class'__main__.Foo'> >>>printFoo.bar True >>> f=Foo() >>>printf <__main__.Fooobjectat0x8a9b84c> >>>printf.bar True

固然，你能够向这个类继承，因此，以下的代码：

1 2	>>>classFooChild(Foo): …      pass

就能够写成：

1 2 3 4 5

>>> FooChild=type('FooChild', (Foo,),{}) >>>printFooChild <class'__main__.FooChild'> >>>printFooChild.bar  # bar属性是由Foo继承而来 True

最终你会但愿为你的类增长方法。只须要定义一个有着恰当签名的函数并将其做为属性赋值就能够了。

1 2 3 4 5 6 7 8 9 10 11

>>>defecho_bar(self): …      printself.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中的类也是对象。好吧，元类就是用来建立这些类（对象）的，元类就是类的类，你能够这样理解 为：

1 2	MyClass=MetaClass() MyObject=MyClass()

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

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

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

1 2 3 4 5 6 7 8 9 10 11 12 13

>>> age=35 >>> age.__class__ <type'int'> >>> name='bob' >>> name.__class__ <type'str'> >>>deffoo():pass >>>foo.__class__ <type'function'> >>>classBar(object):pass >>> b=Bar() >>> b.__class__ <class'__main__.Bar'>

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

1 2 3 4 5 6 7 8

>>> a.__class__.__class__ <type'type'> >>> age.__class__.__class__ <type'type'> >>> foo.__class__.__class__ <type'type'> >>> b.__class__.__class__ <type'type'>

所以，元类就是建立类这种对象的东西。若是你喜欢的话，能够把元类称为“类工厂”（不要和工厂类搞混了:D） type就是Python的内建元类，固然了，你也能够建立本身的元类。

 

__metaclass__属性

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

1 2 3

classFoo(object):     __metaclass__=something… […]

若是你这么作了，Python就会用元类来建立类Foo。当心点，这里面有些技巧。你首先写下class Foo(object)，可是类对象Foo尚未在内存中建立。Python会在类的定义中寻找__metaclass__属性，若是找到了，Python就会用它来建立类Foo，若是没有找到，就会用内建的type来建立这个类。把下面这段话反复读几回。当你写以下代码时 :

1 2	classFoo(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，画画图理解下，这颇有帮助）。因此，咱们这里就先以一个简单的函数做为例子开始。

1 2 3 4 5

# 元类会自动将你一般传给‘type’的参数做为本身的参数传入 defupper_attr(future_class_name, future_class_parents, future_class_attr):     '''返回一个类对象，将属性都转为大写形式'''     #  选择全部不以'__'开头的属性     attrs=((name, value)forname, valueinfuture_class_attr.items()ifnotname.startswith('__'))

1 2 3 4 5 6 7 8 9 10 11

# 将它们转为大写形式     uppercase_attr=dict((name.upper(), value)forname, valueinattrs)       # 经过'type'来作类对象的建立     returntype(future_class_name, future_class_parents, uppercase_attr)   __metaclass__=upper_attr #  这会做用到这个模块中的全部类   classFoo(object):     # 咱们也能够只在这里定义__metaclass__，这样就只会做用于这个类中     bar='bip'

1 2 3 4 5 6 7 8

printhasattr(Foo,'bar') # 输出: False printhasattr(Foo,'BAR') # 输出:True   f=Foo() printf.BAR # 输出:'bip'

如今让咱们再作一次，这一次用一个真正的class来当作元类。

1 2 3 4 5 6 7 8 9 10 11 12 13 14

# 请记住，'type'其实是一个类，就像'str'和'int'同样 # 因此，你能够从type继承 classUpperAttrMetaClass(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)forname, valueinfuture_class_attr.items()ifnotname.startswith('__'))         uppercase_attr=dict((name.upper(), value)forname, valueinattrs)         returntype(future_class_name, future_class_parents, uppercase_attr)

可是，这种方式其实不是OOP。咱们直接调用了type，并且咱们没有改写父类的__new__方法。如今让咱们这样去处理:

1 2 3 4 5 6 7 8

classUpperAttrMetaclass(type):     def__new__(upperattr_metaclass, future_class_name, future_class_parents, future_class_attr):         attrs=((name, value)forname, valueinfuture_class_attr.items()ifnotname.startswith('__'))         uppercase_attr=dict((name.upper(), value)forname, valueinattrs)           # 复用type.__new__方法         # 这就是基本的OOP编程，没什么魔法         returntype.__new__(upperattr_metaclass, future_class_name, future_class_parents, uppercase_attr)

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

1 2 3 4 5

classUpperAttrMetaclass(type):     def__new__(cls, name, bases, dct):         attrs=((name, value)forname, valueindct.items()ifnotname.startswith('__')         uppercase_attr =dict((name.upper(), value)forname, valueinattrs)         returntype.__new__(cls, name, bases, uppercase_attr)

若是使用super方法的话，咱们还可使它变得更清晰一些，这会缓解继承（是的，你能够拥有元类，从元类继承，从type继承）

1 2 3 4 5

classUpperAttrMetaclass(type):     def__new__(cls, name, bases, dct):         attrs=((name, value)forname, valueindct.items()ifnotname.startswith('__'))         uppercase_attr=dict((name.upper(), value)forname, valueinattrs)         returnsuper(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。它容许你像这样定义：

1 2 3

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

可是若是你像这样作的话：

1 2	guy =Person(name='bob', age='35') printguy.age

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

 

结语

首先，你知道了类实际上是可以建立出类实例的对象。好吧，事实上，类自己也是实例，固然，它们是元类的实例。

1 2 3

>>>classFoo(object):pass >>>id(Foo) 142630324

Python中的一切都是对象，它们要么是类的实例，要么是元类的实例，除了type。type其实是它本身的元类，在纯Python环境中这可不是你可以作到的，这是经过在实现层面耍一些小手段作到的。其次，元类是很复杂的。对于很是简单的类，你可能不但愿经过使用元类来对类作修改。你能够经过其余两种技术来修改类：

1） Monkey patching

2)   class decorators

当你须要动态修改类时，99%的时间里你最好使用上面这两种技术。固然了，其实在99%的时间里你根本就不须要动态修改类 :D