深入理解Python中的元类(metaclass)

544次阅读  |  发布于5年以前

译注:这是一篇在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 0x8974f2c>

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

复制代码 代码如下:

class ObjectCreator(object):
… pass

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

1.你可以将它赋值给一个变量
2.你可以拷贝它
3.你可以为它增加属性
4.你可以将它作为函数参数进行传递

下面是示例:

复制代码 代码如下:

print ObjectCreator # 你可以打印一个类,因为它其实也是一个对象
<class 'main.ObjectCreator'>
def echo(o):
… print o

echo(ObjectCreator) # 你可以将类做为参数传给函数
<class 'main.ObjectCreator'>
print hasattr(ObjectCreator, 'new_attribute')
Fasle
ObjectCreator.new_attribute = 'foo' # 你可以为类增加属性
print hasattr(ObjectCreator, 'new_attribute')
True
print ObjectCreator.new_attribute
foo
ObjectCreatorMirror = ObjectCreator # 你可以将类赋值给一个变量
print ObjectCreatorMirror()
<main.ObjectCreator object at 0x8997b4c>

动态地创建类

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

复制代码 代码如下:

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 'main'.Foo>
print MyClass() # 你可以通过这个类创建类实例,也就是对象
<main.Foo object at 0x89c6d4c>

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

复制代码 代码如下:

print type(1)
<type 'int'>
print type("1")
<type 'str'>
print type(ObjectCreator)
<type 'type'>
print type(ObjectCreator())
<class 'main.ObjectCreator'>

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

type可以像这样工作:

复制代码 代码如下:

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

比如下面的代码:

复制代码 代码如下:

class MyShinyClass(object):
… pass

可以手动像这样创建:

复制代码 代码如下:

MyShinyClass = type('MyShinyClass', (), {}) # 返回一个类对象
print MyShinyClass
<class 'main.MyShinyClass'>
print MyShinyClass() # 创建一个该类的实例
<main.MyShinyClass object at 0x8997cec>

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

type 接受一个字典来为类定义属性,因此

复制代码 代码如下:

class Foo(object):
… bar = True

可以翻译为:

复制代码 代码如下:

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

并且可以将Foo当成一个普通的类一样使用:

复制代码 代码如下:

print Foo
<class 'main.Foo'>
print Foo.bar
True
f = Foo()
print f
<main.Foo object at 0x8a9b84c>
print f.bar
True

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

复制代码 代码如下:

class FooChild(Foo):
… pass

就可以写成:

复制代码 代码如下:

FooChild = type('FooChild', (Foo,),{})
print FooChild
<class 'main.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
<type 'int'>
name = 'bob'
name.class
<type 'str'>
def foo(): pass
foo.class
<type 'function'>
class Bar(object): pass
b = Bar()
b.class
<class 'main.Bar'>

现在,对于任何一个class的class属性又是什么呢?

复制代码 代码如下:

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属性。

复制代码 代码如下:

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'

Copyright© 2013-2020

All Rights Reserved 京ICP备2023019179号-8