python3高级知识--元类(metaclass)深度剖析
一、简介
在面向对象的程序设计中类和对象是其重要角色,我们知道对象是由类实例化而来,那么类又是怎么生成的呢?答案是通过元类。本篇文章将介绍元类相关知识,并剖析元类生成类的过程,以及元类的使用等内容,希望能帮助到正在学习python的同仁。
一、一切皆对象
在python中有这样一句话“一切皆对象”,没错你所知道的dict、class、int、func等等都是对象,让我们来看以下一段代码来进行说明:
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # Author:wd class Foo(object): pass def func(): print('func') print(Foo.__class__) print(func.__class__) print(int.__class__) print(func.__class__.__class__) 结果: <class 'type'> <class 'function'> <class 'type'> <class 'type'>
说明:__class__方法用于查看当前对象由哪个类生成的,正如结果所见其中Foo和int这些类(对象)都是由type创建,而函数则是由function类创建,而function类则也是由type创建,究其根本所有的这些类对象都是由type穿件。这里的type就是python内置的元类,接下来谈谈type。
二、关于type
上面我们谈到了所有的类(对象)都是由type生成,那么不妨我们看看type定义,以下是python3.6中内置type定义部分摘抄:
class type(object): """ type(object_or_name, bases, dict) type(object) -> the object's type type(name, bases, dict) -> a new type """ def mro(self): # real signature unknown; restored from __doc__ """ mro() -> list return a type's method resolution order """ return []
type(类名,该类所继承的父类元祖,该类对应的属性字典(k,v))
利用该语法我们来穿件一个类(对象)Foo:
Foo=type('Foo',(object,),{'Name':'wd'}) print(Foo) print(Foo.Name) 结果: <class '__main__.Foo'> wd
当然也可以实例化这个类(对象):
Foo=type('Foo',(object,),{'Name':'wd'}) obj=Foo() print(obj.Name) print(obj) print(obj.__class__) 结果: wd <__main__.Foo object at 0x104482438> <class '__main__.Foo'>
这样创建方式等价于:
class Foo(object): Name='wd'
其实上面的过程也就是我们使用class定义类生成的过程,而type就是python中的元类。
三、元类
什么是元类
经过以上的介绍,说白了元类就是创建类的类,有点拗口,姑且把这里称为可以创建类对象的类。列如type就是元类的一种,其他的元类都是通过继承type或使用type生成的。通过元类我们可以控制一个类创建的过程,以及包括自己定制一些功能。 例如,下面动态的为类添加方法:
def get_name(self): print(self.name) class MyType(type): def __new__(cls, cls_name, bases, dict_attr): dict_attr['get_name'] = get_name #将get_name 作为属性添加到类属性中 return super(MyType, cls).__new__(cls, cls_name, bases, dict_attr) class Foo(metaclass=MyType): def __init__(self, name): self.name = name obj = Foo('wd') obj.get_name()#调用该方法 结果: wd
使用元类
介绍类类元类,我们知道其主要目的就是为了当创建类时能够自动地改变类,在以上的列子中我们介绍了使用方法,其中就像stackoverflow中关于对元类的使用建议一样,绝大多数的应用程序都非必需使用元类,并且使用它可能会对你的代码带来一定的复杂性,但是就元类的使用而言其实很简单,其场景在于:
1.对创建的类进行校验(拦截);
2.修改类;
3.为该类定制功能;
使用元类是时候经典类和新式类时候有些不同,新式类通过参数metaclass,经典类通过__metaclass__属性:
class Foo(metaclass=MyType): #新式类 pass class Bar: # 经典类 __metaclass__ = MyType pass
在解释元类的时候有提到过,元类可以是type,也可以是继承type的类,当然还可以是函数,只要它是可调用的。但是有个必要的前提是该函数使用的是具有type功能的函数,否则生成的对象可能就不是你想要的(在后续的原理在进行讲解)。以下示例将给出使用函数作为元类来创建类:
def class_creater(cls_name, bases, dict_attr): return type(cls_name, bases, dict_attr) class Foo(metaclass=class_creater): def __init__(self,name): self.name=name obj=Foo('wd') print(obj.name) #wd
原理
- 获取类名,以示例中class Foo为例,类名是Foo。
- 获取父类,默认object,以元祖的形式,如(object,Foo)
- 获取类的属性字典(也叫名称空间)
- 将这三个参数传递给元类(也就是metaclass参数指定的类),如果没有metaclass参数则使用type生成类。
元类创建类的过程
class Foo(object): def __init__(self, name): print('this is __init__') self.name = name def __new__(cls, *args, **kwargs): print('this is __new__') return object.__new__(cls) def __call__(self, *args, **kwargs): print("this is __call__") obj=Foo('wd') # 实例化 obj() # 触发__call__ 结果: this is __new__ this is __init__ this is __call__
有了这个知识,再来看看使用元类生成类,以下代码定义来一个元类继承来type,我们重写__new__和__init__方法(其实什么也没干),为了说明类的生成过程:
class MyType(type): def __init__(self, cls_name, bases, cls_attr): print("Mytype __init__", cls_name, bases) def __new__(cls, cls_name, bases, cls_attr): print("Mytype __new__", cls_name, bases) return super(MyType, cls).__new__(cls, cls_name, bases, cls_attr) class Foo(metaclass=MyType): def __init__(self, name): print('this is __init__') self.name = name def __new__(cls, *args, **kwargs): print('this is __new__') return object.__new__(cls) print("line -------") obj = Foo('wd') # 实例化 结果: Mytype __new__ Foo () Mytype __init__ Foo () line ------- this is __new__ this is __init__
解释说明:
- 首先metaclass接受一个可调用的对象,而在这里该对象是一个类,也就是说会执行MyType(),并把cls_name,bases,cls_attr传递给MyType,这不就是MyType的示例化过程吗,所以你在结果中可以看到,分割线是在”Mytype __new__”和“Mytype __init__”之后输出,接下来在看MyType。
- MyType元类的实例化过程和普通类一样,先执行自己__new__方法,在执行自己的__init__方法,在这里请注意__new__方法是控制MyType类生成的过程,而__init__则是实例化过程,用于生成类Foo。这样一来是不是对类的生成过程有了非常深刻的认识。
class MyType(type): def __init__(self, cls_name, bases, cls_attr): print("Mytype __init__", cls_name, bases) def __new__(cls, cls_name, bases, cls_attr): print("Mytype __new__", cls_name, bases) return super(MyType, cls).__new__(cls, cls_name, bases, cls_attr) def __call__(self, *args, **kwargs): print('Mytype __call__') class Foo(metaclass=MyType): def __init__(self, name): print('this is __init__') self.name = name def __new__(cls, *args, **kwargs): print('this is __new__') return object.__new__(cls) def __call__(self, *args, **kwargs): print("this is __call__") print("before -------") obj = Foo('wd') # 实例化 print("after -------") print(obj) 结果: Mytype __new__ Foo () Mytype __init__ Foo () before ------- Mytype __call__ after ------- None
你会发现,当Foo实例化时候执行了元类的__call__,你从python的一切皆对象的方式来看,一切都是顺理成章的,因为这里的Foo其实是元类的对象,对象+()执行元类的__call__方法。请注意,在Foo进行实例化时候返回的对象是None,这是因为__call__方法返回的就是None,所以在没有必要的前提下最好不要随意重写元类的__call__方法,这会影响到类的实例化。__call__方法在元类中作用是控制类生成时的调用过程。
通过__call__方法我们能得出结果就是__call__方法返回什么,我们最后得到的实例就是什么。还是刚才栗子,我们让Foo实例化以后变成一个字符串:
class MyType(type): def __init__(self, cls_name, bases, cls_attr): print("Mytype __init__", cls_name, bases) def __new__(cls, cls_name, bases, cls_attr): return super(MyType, cls).__new__(cls, cls_name, bases, cls_attr) def __call__(self, *args, **kwargs): return 'this is wd' class Foo(metaclass=MyType): def __init__(self, name): print('this is __init__') self.name = name def __new__(cls, *args, **kwargs): print('this is __new__') return object.__new__(cls) def __call__(self, *args, **kwargs): print("this is __call__") obj = Foo('wd') # 实例化 print(type(obj),obj) 结果: Mytype __init__ Foo () <class 'str'> this is wd
既然__call__方法返回什么,我们实例化生成的对象就是什么,那么在正常的流程是返回的是Foo的对象,而Foo的对象是由Foo的__new__和Foo的__init__生成的,所以在__call__方法的内部又有先后调用了Foo类的__new__方法和__init__方法,如果我们重写元类的__call__方法,则应该调用对象的__new__和__init__,如下:
class MyType(type): def __init__(self, cls_name, bases, cls_attr): print("Mytype __init__", cls_name, bases) def __new__(cls, cls_name, bases, cls_attr): return super(MyType, cls).__new__(cls, cls_name, bases, cls_attr) def __call__(self, *args, **kwargs): print("Mytype __call__", ) obj = self.__new__(self) print(self, obj) self.__init__(obj, *args, **kwargs) return obj class Foo(metaclass=MyType): def __init__(self, name): self.name = name def __new__(cls, *args, **kwargs): return object.__new__(cls) obj = Foo('wd') # 实例化 print(obj.name) 结果: Mytype __init__ Foo () Mytype __call__ <class '__main__.Foo'> <__main__.Foo object at 0x1100c9dd8> wd
同样,当函数作为元类时候,metaclass关键字会调用其对应的函数生成类,如果这个函数返回的不是类,而是其他的对象,那么使用该函数定义的类就得到的就是该对象,这也就是为什么我说使用函数作为元类时候,需要有type功能,一个简单的示例:
def func(cls_name, bases, dict_attr): return 'this is wd' class Foo(metaclass=func): def __init__(self, name): self.name = name def __new__(cls, *args, **kwargs): return object.__new__(cls) print(Foo, "|", type(Foo)) # 结果:this is wd | <class 'str'> obj=Foo('wd') #报错
结语