python元类深度理解案例

记录学习   不过写的还是非常好的&＃xff0c;仔细看&＃xff01;

本文转自:&＃xff08;英文版&＃xff09;https://stackoverflow.com/questions/100003/what-is-a-metaclass-in-python

　　　　  (翻译版)   http://python.jobbole.com/21351/

以下代码测试环境为ptyon2.7

类也是对象

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

>>> class ObjectCreator(object):
... pass
... >>> my_object &＃61; ObjectCreator()
>>> print(my_object)
<__main__.ObjectCreator object at 0x8974f2c>

　　但是&＃xff0c;Python中的类还远不止如此。类同样也是一种对象。是的&＃xff0c;没错&＃xff0c;就是对象。只要你使用关键字class&＃xff0c;Python解释器在执行的时候就会创建一个对象。下面的代码段&＃xff1a;

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

　　将在内存中创建一个对象&＃xff0c;名字就是ObjectCreator。这个对象&＃xff08;类&＃xff09;自身拥有创建对象&＃xff08;类实例&＃xff09;的能力&＃xff0c;而这就是为什么它是一个类的原因。但是&＃xff0c;它的本质仍然是一个对象&＃xff0c;于是乎你可以对它做如下的操作&＃xff1a;

　　1)   你可以将它赋值给一个变量

　　2)   你可以拷贝它

　　3)   你可以为它增加属性

　　4)   你可以将它作为函数参数进行传递

　　下面是示例&＃xff1a;

>>> print ObjectCreator # 你可以打印一个类&＃xff0c;因为它其实也是一个对象

>>> def echo(o):
… print o
…
>>> echo(ObjectCreator) # 你可以将类做为参数传给函数

>>> print hasattr(ObjectCreator, &＃39;new_attribute&＃39;)
Fasle
>>> ObjectCreator.new_attribute &＃61; &＃39;foo&＃39; # 你可以为类增加属性
>>> print hasattr(ObjectCreator, &＃39;new_attribute&＃39;)
True
>>> print ObjectCreator.new_attribute
foo
>>> ObjectCreatorMirror &＃61; ObjectCreator # 你可以将类赋值给一个变量
>>> print ObjectCreatorMirror()
<__main__.ObjectCreator object at 0x8997b4c>

　　动态地创建类

因为类也是对象&＃xff0c;你可以在运行时动态的创建它们&＃xff0c;就像其他任何对象一样。首先&＃xff0c;你可以在函数中创建类&＃xff0c;使用class关键字即可。

>>> def choose_class(name):
… if name &＃61;&＃61; &＃39;foo&＃39;:
… class Foo(object):
… pass
… return Foo # 返回的是类&＃xff0c;不是类的实例
… else:
… class Bar(object):
… pass
… return Bar
…
>>> MyClass &＃61; choose_class(&＃39;foo&＃39;)
>>> print MyClass # 函数返回的是类&＃xff0c;不是类的实例

>>> print MyClass() # 你可以通过这个类创建类实例&＃xff0c;也就是对象
<__main__.Foo object at 0x89c6d4c>

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

>>> print type(1)

>>> print type("1")

>>> print type(ObjectCreator)

>>> print type(ObjectCreator())

　　这里&＃xff0c;type有一种完全不同的能力&＃xff0c;它也能动态的创建类。type可以接受一个类的描述作为参数&＃xff0c;然后返回一个类。&＃xff08;我知道&＃xff0c;根据传入参数的不同&＃xff0c;同一个函数拥有两种完全不同的用法是一件很傻的事情&＃xff0c;但这在Python中是为了保持向后兼容性&＃xff09;

type可以像这样工作&＃xff1a;

type(类名, 父类的元组&＃xff08;针对继承的情况&＃xff0c;可以为空&＃xff09;&＃xff0c;包含属性的字典&＃xff08;名称和值&＃xff09;)

　　比如下面的代码&＃xff1a;

>>> class MyShinyClass(object):
… pass

　　可以手动像这样创建&＃xff1a;

>>> MyShinyClass &＃61; type(&＃39;MyShinyClass&＃39;, (), {}) # 返回一个类对象
>>> print MyShinyClass

>>> print MyShinyClass() # 创建一个该类的实例
<__main__.MyShinyClass object at 0x8997cec>　

　　你会发现我们使用“MyShinyClass”作为类名&＃xff0c;并且也可以把它当做一个变量来作为类的引用。类和变量是不同的&＃xff0c;这里没有任何理由把事情弄的复杂。

　　type 接受一个字典来为类定义属性&＃xff0c;因此:

>>> class Foo(object):
… bar &＃61; True

　　可以翻译为&＃xff1a;

>>> Foo &＃61; type(&＃39;Foo&＃39;, (), {&＃39;bar&＃39;:True})

　　并且可以将Foo当成一个普通的类一样使用&＃xff1a;

>>> print Foo

>>> print Foo.bar
True
>>> f &＃61; Foo()
>>> print f
<__main__.Foo object at 0x8a9b84c>
>>> print f.bar
True

　　当然&＃xff0c;你可以向这个类继承&＃xff0c;所以&＃xff0c;如下的代码&＃xff1a;

>>> class FooChild(Foo):
… pass

　　就可以写成&＃xff1a;

>>> FooChild &＃61; type(&＃39;FooChild&＃39;, (Foo,),{})
>>> print FooChild

>>> print FooChild.bar # bar属性是由Foo继承而来
True

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

>>> def echo_bar(self):
… print self.bar
…
>>> FooChild &＃61; type(&＃39;FooChild&＃39;, (Foo,), {&＃39;echo_bar&＃39;: echo_bar})
>>> hasattr(Foo, &＃39;echo_bar&＃39;)
False
>>> hasattr(FooChild, &＃39;echo_bar&＃39;)
True
>>> my_foo &＃61; FooChild()
>>> my_foo.echo_bar()
True

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

　　到底什么是元类&＃xff08;终于到主题了&＃xff09;

元类就是用来创建类的“东西”。你创建类就是为了创建类的实例对象&＃xff0c;不是吗&＃xff1f;但是我们已经学习到了Python中的类也是对象。好吧&＃xff0c;元类就是用来创建这些类&＃xff08;对象&＃xff09;的&＃xff0c;元类就是类的类&＃xff0c;你可以这样理解 为&＃xff1a;

MyClass &＃61; MetaClass()
MyObject &＃61; MyClass()

　　你已经看到了type可以让你像这样做&＃xff1a;

MyClass &＃61; type(&＃39;MyClass&＃39;, (), {})

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

>>> age &＃61; 35
>>> age.__class__

>>> name &＃61; &＃39;bob&＃39;
>>> name.__class__

>>> def foo(): pass
>>>foo.__class__

>>> class Bar(object): pass
>>> b &＃61; Bar()
>>> b.__class__

　　现在&＃xff0c;对于任何一个__class__的__class__属性又是什么呢&＃xff1f;

>>> a.__class__.__class__

>>> age.__class__.__class__

>>> foo.__class__.__class__

>>> b.__class__.__class__

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

　　__metaclass__属性

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

class Foo(object):__metaclass__ &＃61; something…
[…]

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

class Foo(Bar):pass

　　Python做了如下的操作&＃xff1a;

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

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

自定义元类

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

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

# 元类会自动将你通常传给‘type’的参数作为自己的参数传入
def upper_attr(future_class_name, future_class_parents, future_class_attr):&＃39;&＃39;&＃39;返回一个类对象&＃xff0c;将属性都转为大写形式&＃39;&＃39;&＃39;# 选择所有不以&＃39;__&＃39;开头的属性attrs &＃61; ((name, value) for name, value in future_class_attr.items() if not name.startswith(&＃39;__&＃39;))# 将它们转为大写形式uppercase_attr &＃61; dict((name.upper(), value) for name, value in attrs)# 通过&＃39;type&＃39;来做类对象的创建return type(future_class_name, future_class_parents, uppercase_attr)__metaclass__ &＃61; upper_attr # 这会作用到这个模块中的所有类class Foo(object):# 我们也可以只在这里定义__metaclass__&＃xff0c;这样就只会作用于这个类中bar &＃61; &＃39;bip&＃39;print hasattr(Foo, &＃39;bar&＃39;)
# 输出: False
print hasattr(Foo, &＃39;BAR&＃39;)
# 输出:Truef &＃61; Foo()
print f.BAR
# 输出:&＃39;bip&＃39;

 Python3.x实现上述方式

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

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

　　但是&＃xff0c;这种方式其实不是OOP。我们直接调用了type&＃xff0c;而且我们没有改写父类的__new__方法。现在让我们这样去处理:

class UpperAttrMetaclass(type):def __new__(upperattr_metaclass, future_class_name, future_class_parents, future_class_attr):attrs &＃61; ((name, value) for name, value in future_class_attr.items() if not name.startswith(&＃39;__&＃39;))uppercase_attr &＃61; dict((name.upper(), value) for name, value in attrs)# 复用type.__new__方法# 这就是基本的OOP编程&＃xff0c;没什么魔法return type.__new__(upperattr_metaclass, future_class_name, future_class_parents, uppercase_attr)

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

class UpperAttrMetaclass(type):def __new__(cls, name, bases, dct):attrs &＃61; ((name, value) for name, value in dct.items() if not name.startswith(&＃39;__&＃39;)uppercase_attr &＃61; dict((name.upper(), value) for name, value in attrs)return type.__new__(cls, name, bases, uppercase_attr)

　　如果使用super方法的话&＃xff0c;我们还可以使它变得更清晰一些&＃xff0c;这会缓解继承&＃xff08;是的&＃xff0c;你可以拥有元类&＃xff0c;从元类继承&＃xff0c;从type继承&＃xff09;

class UpperAttrMetaclass(type):def __new__(cls, name, bases, dct):attrs &＃61; ((name, value) for name, value in dct.items() if not name.startswith(&＃39;__&＃39;))uppercase_attr &＃61; dict((name.upper(), value) for name, value in attrs)return super(UpperAttrMetaclass, cls).__new__(cls, name, bases, uppercase_attr)

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

　　1)   拦截类的创建

　　2)   修改类

　　3)   返回修改之后的类

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

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

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

　　2&＃xff09; 你可以使用OOP编程。元类可以从元类中继承而来&＃xff0c;改写父类的方法。元类甚至还可以使用元类。

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

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

　　5&＃xff09; 哇哦&＃xff0c;这东西的名字是metaclass&＃xff0c;肯定非善类&＃xff0c;我要小心&＃xff01;

究竟为什么要使用元类&＃xff1f;

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

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

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

class Person(models.Model):name &＃61; models.CharField(max_length&＃61;30)age &＃61; models.IntegerField()

　　但是如果你像这样做的话&＃xff1a;

guy &＃61; Person(name&＃61;&＃39;bob&＃39;, age&＃61;&＃39;35&＃39;)
print guy.age

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

结语

　　首先&＃xff0c;你知道了类其实是能够创建出类实例的对象。好吧&＃xff0c;事实上&＃xff0c;类本身也是实例&＃xff0c;当然&＃xff0c;它们是元类的实例。

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

　　Python中的一切都是对象&＃xff0c;它们要么是类的实例&＃xff0c;要么是元类的实例&＃xff0c;除了type。type实际上是它自己的元类&＃xff0c;在纯Python环境中这可不是你能够做到的&＃xff0c;这是通过在实现层面耍一些小手段做到的。其次&＃xff0c;元类是很复杂的。对于非常简单的类&＃xff0c;你可能不希望通过使用元类来对类做修改。你可以通过其他两种技术来修改类&＃xff1a;

　　1&＃xff09; Monkey patching

　　2)   class decorators

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