Python_元类
什么是元类
我们知道,实例对象是由类创建的,那么类又是由什么创建的呢? 答案就是元类。
元类基本不会用到,但是就算不用,也应该去熟悉一下概念。
理解类也是对象
在大多数编程语言中,类就是一组用来描述如何生成一个对象的代码段。在Python中这一点仍然成立:
class ObjectCreator(object): pass my_object = ObjectCreator() print(my_object) # 返回:<__main__.ObjectCreator object at 0x0000000001D356A0>
但是,Python中的类还远不止如此。类同样也是一种对象。只要你使用关键字class,Python解释器在执行的时候就会创建一个对象。下面的代码段:
class ObjectCreator(object): pass
将在内存中创建一个对象,名字就是ObjectCreator。这个对象(类)自身拥有创建对象(类实例)的能力,而这就是为什么它是一个类的原因。但是,它的本质仍然是一个对象,于是你可以对它做如下的操作:
- 你可以将它赋值给一个变量
- 你可以拷贝它
- 你可以为它增加属性
- 你可以将它作为函数参数进行传递
下面是示例
class ObjectCreator(object): pass # 你可以打印一个类,因为它其实也是一个对象 print(ObjectCreator) # <class '__main__.ObjectCreator'> def print_obj(obj): print(obj) # 你可以将类做为参数传给函数 print_obj(ObjectCreator) # <class '__main__.ObjectCreator'> # 你可以为类增加属性 ObjectCreator.new_attribute = 'foo' # 查看属性是否存在 print(hasattr(ObjectCreator, 'new_attribute')) # 输出True # 打印该属性 print(ObjectCreator.new_attribute) # 输出foo # 可以为将类赋值给变量 new_obj = ObjectCreator print(new_obj) # 输出<class '__main__.ObjectCreator'>
动态地创建类
因为类也是对象,你可以在运行时动态的创建它们,就像其他任何对象一样。首先,你可以在函数中创建类,使用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 0x1085ed950
但这还不够动态,因为你仍然需要自己编写整个类的代码。由于类也是对象,所以它们必须是通过什么东西来生成的才对。
当你使用class关键字时,Python解释器自动创建这个对象。但就和Python中的大多数事情一样,Python仍然提供给你手动处理的方法。
还记得类型函数type()
吗?这个古老但强大的函数能够让你知道一个对象的类型是什么,就像这样:
class Foo(object): pass print(type(1)) # 输出<class 'int'> print(type("1")) # 输出<class 'str'> print(type(Foo())) # 输出<class '__main__.Foo'> print(type(Foo)) # 输出<class 'type'>
仔细观察上面的运行结果,发现使用type对FatBoy查看类型是,答案为type, 是不是有些惊讶。
使用type创建类
type还有一种完全不同的功能,动态的创建类。
type可以接受一个类的描述作为参数,然后返回一个类。(要知道,根据传入参数的不同,同一个函数拥有两种完全不同的用法是一件很傻的事情,但这在Python中是为了保持向后兼容性)
type可以像这样工作:
type(类名, 由父类名称组成的元组(针对继承的情况,可以为空),包含属性的字典(名称和值))
比如下面的代码:
class Test: pass # 创建一个Test类实例对象 print(Test()) # 输出<__main__.Test object at 0x0000000002469128>
可以手动像这样创建:
# 定义一个Test2类 test2 = type("Test2", (), {}) # 创建一个Test2类实例对象 print(test2()) # 输出<__main__.Test2 object at 0x0000000002119B70>
我们使用"Test2"作为类名,并且也可以把它当做一个变量来作为类的引用。类和变量是不同的,这里没有任何理由把事情弄的复杂。
即type函数中第1个实参,也可以叫做其他的名字,这个名字表示类的名字,如下:
# type的第一个实参 Foo 就是类名,然后传递给变量 Foo Foo = type("Foo", (), {}) print(Foo) # 查看 Foo 的类描述,就是 Foo 类 print(help(Foo)) """ 输出: class Foo(builtins.object) | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) """
使用type创建带有属性的类
创建一个 Animal 类,增加属性 run:跑得很快Animal = type("Animal", (), {"run": "跑得很快"}) print(Animal) # 输出<class '__main__.Animal'> print(Animal.run) # 跑得很快 print(help(Animal)) """ class Animal(builtins.object) | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | run = '跑得很快' """ print(Animal.__dict__) """ {'run': '跑得很快', '__module__': '__main__', '__dict__': <attribute '__dict__' of 'Animal' objects>, '__weakref__': <attribute '__weakref__' of 'Animal' objects>, '__doc__': None} """
注意:添加的属性是类属性,并不是实例属性
现在我们已经知道 type 的第三个参数是用来设置类属性的,那么第二个参数元组是干什么的呢?
第二个参数元组是用来填写继承的父类名称,演示如下:
# 定义一个父类 class Father(object): rich = "很有钱" # 定义一个儿子类,继承父亲的rich类属性 Son = type("Son", (Father,), {}) print(Son.rich) # 输出很有钱 # 看看 Son 类的MRO顺序 print(Son.__mro__) # 输出(<class '__main__.Son'>, <class '__main__.Father'>, <class 'object'>)
使用type创建带有方法的类
类通常都会有类方法,下面来看看怎么使用type的方式来创建类方法。# 定义一个父类 class Father(object): rich = "很有钱" # 定义一个普通的函数,用于加入类充当方法 def play(self): return self.rich # 定义一个儿子类,继承父亲的rich类属性 Son = type("Son", (Father,), {"play": play}) print(Son.rich) son = Son() print(son.play) # 返回:<bound method play of <__main__.Son object at 0x000000000284D128>> print(son.play()) # 返回:很有钱
上面演示的这个方法属于实例方法,那么静态方法、类方法这些该怎么创建呢?
# 定义一个父类 class Father(object): rich = "很有钱" # 定义一个普通的函数,用于加入类充当方法 def play(self): return self.rich # 为类定义静态方法 @staticmethod def static_method(): return "static method..." # 定义一个儿子类,继承父亲的rich类属性 Son = type("Son", (Father,), {"play": play, "static_method": static_method}) print(Son.static_method) # 返回:<function static_method at 0x000000000280F2F0> print(Son.static_method()) # 返回:static method...
从上面的几个示例,基本已经知道了如何使用type来定义方法。
那么再来思考一下,到底什么是元类
元类就是用来创建类的“东西”。你创建类就是为了创建类的实例对象,不是吗?但是我们已经学习到了Python中的类也是对象。
元类就是用来创建这些类(对象)的,元类就是类的类,你可以这样理解为:
MyClass = MetaClass() # 使用元类创建出一个对象,这个对象称为“类” my_object = MyClass() # 使用“类”来创建出一个对象,这个对象称为“实例对象”
你已经看到了type可以让你像这样做:
MyClass = type('MyClass', (), {})
# 查看age整数的类属性 age = 18 print(age.__class__) # 输出:<class 'int'> # 查看name字符串的类属性 name = '张三' print(name.__class__) # 输出:<class 'str'> # 查看函数方法的类属性 def sell(): pass print(sell.__class__) # 输出:<class 'function'> # 查看实例的类属性 class Foo(object): pass foo = Foo() print(foo.__class__) # 输出:<class '__main__.Foo'>
从上面的示例,大概知道了整型、字符串等等的类属性。那么类(__class__
)的类属性(__class__
)又是什么呢?
# 查看age整数的类属性 age = 18 print(age.__class__.__class__) # 输出:<class 'type'> # 查看name字符串的类属性 name = '张三' print(name.__class__.__class__) # 输出:<class 'type'> # 查看函数方法的类属性 def sell(): pass print(sell.__class__.__class__) # 输出:<class 'type'> # 查看实例的类属性 class Foo(object): pass foo = Foo() print(foo.__class__.__class__) # 输出:<class 'type'>
可以看出,不管是什么类型的类,最终的创建元类都是type
。
因此,元类就是创建类这种对象的东西。type就是Python的内建元类,当然了,你也可以创建自己的元类。
__metaclass__
属性
上面已经知道了如何使用type这个元类来创建类,那么如何创建自己的元类呢??
此情此景需要用到__metaclass__
属性。
其实仔细回想一下,就是类似闭包的处理方式,下面来演示看看。
class FatBoss(object): __metaclass__ = something… ...省略...
__metaclass__
属性,如果找到了,Python就会用它来创建类Foo,如果没有找到,就会用内建的type来创建这个类。大致过程:
当你写如下代码时 :
class FatBossGril(FatBoss): pass
FatBossGril
中有__metaclass__
这个属性吗?如果有,那么Python会通过__metaclass__
创建一个名字为FatBossGril
的类(对象)- 如果Python没有找到
__metaclass__
,它会继续在FatBoss
(父类)中寻找__metaclass__
属性,并尝试做和前面同样的操作。 - 如果Python在任何父类中都找不到
__metaclass__
,它就会在模块层次中去寻找__metaclass__
,并尝试做同样的操作。 - 如果还是找不到
__metaclass__
,Python就会用内置的type
来创建这个类对象。
__metaclass__
中放置些什么代码呢?答案就是:可以创建一个类的东西。那么什么可以用来创建一个类呢?type
,或者任何使用到type
或者子类化type
的类都可以,反正最终还是需要type
的。自定义元类
元类的主要目的就是为了当创建类时能够自动地改变类(不改变类的内部代码,从而改变类,与闭包的原理相似!)。
假想一个很傻的例子,你决定在你的模块里所有的类的属性都应该是大写形式。有好几种方法可以办到,但其中一种就是通过在模块级别设定__metaclass__
。采用这种方法,这个模块中的所有类都会通过这个元类来创建,我们只需要告诉元类把所有的属性都改成大写形式就万事大吉了。
幸运的是,__metaclass__
实际上可以被任意调用,它并不需要是一个正式的类。所以,我们这里就先以一个简单的函数作为例子开始。
def upper_attr(class_name, class_parents, class_attr): # 自定义的元类必须包含3个形参 # 第一个形参(class_name) 会保存类的名字 Foo # 第二个形参(class_parents) 会保存类的父类 object # 第三个形参(class_attr) 会以字典的方式保存所有的类属性 # 遍历属性字典,把不是__开头的属性名字变为大写 new_attr = {} print("="*30) for name, value in class_attr.items(): print("name=%s and value=%s" % (name, value)) # 打印所有类属性出来 if not name.startswith("__"): new_attr[name.upper()] = value print("name.upper()=", name.upper()) print("value=", value) # 调用type来创建一个类 return type(class_name, class_parents, new_attr) class Foo(object, metaclass=upper_attr): # 当没有参数 metacass时,默认调用type bar = 'bip' print("="*30) print("check Foo exist bar attr=", hasattr(Foo, 'bar')) print("check Foo exist BAR attr=", hasattr(Foo, 'BAR')) f = Foo() print("print f.BAR=", f.BAR)
输出结果
============================== name=__module__ and value=__main__ name=__qualname__ and value=Foo name=bar and value=bip name.upper()= BAR value= bip ============================== check Foo exist bar attr= False check Foo exist BAR attr= True print f.BAR= bip
从上面的例子中,使用元类的方式,将Foo类中的属性bar
修改为BAR
。在这是使用的def 方法
来作为类似元类的做法,下面使用class来定义元类。
#-*- coding:utf-8 -*- #def UpperAttrMetaClass(class_name, class_parents, class_attr): class UpperAttrMetaClass(type): # 继承type元类 # __new__ 是在__init__之前被调用的特殊方法 # __new__是用来创建对象并返回之的方法 # 而__init__只是用来将传入的参数初始化给对象 # 你很少用到__new__,除非你希望能够控制对象的创建 # 这里,创建的对象是类,我们希望能够自定义它,所以我们这里改写__new__ # 如果你希望的话,你也可以在__init__中做些事情 # 还有一些高级的用法会涉及到改写__call__特殊方法,但是我们这里不用 def __new__(cls, class_name, class_parents, class_attr): # 遍历属性字典,把不是__开头的属性名字变为大写 new_attr = {} print("="*30) for name, value in class_attr.items(): print("name=%s and value=%s" % (name,value)) # 打印所有类属性出来 if not name.startswith("__"): new_attr[name.upper()] = value print("name.upper()=",name.upper()) print("value=",value) # 调用type来创建一个类 return type(class_name, class_parents, new_attr) class Foo(object, metaclass=UpperAttrMetaClass): bar = 'bip' print("="*30) print("check Foo exist bar attr=",hasattr(Foo, 'bar')) print("check Foo exist BAR attr=",hasattr(Foo, 'BAR')) f = Foo() print("print f.BAR=",f.BAR)
输出结果
============================== name=__module__ and value=__main__ name=__qualname__ and value=Foo name=bar and value=bip name.upper()= BAR value= bip ============================== check Foo exist bar attr= False check Foo exist BAR attr= True print f.BAR= bip
但是,这种方式其实不是OOP。我们直接调用了type,而且我们没有改写父类的__new__方法。现在让我们这样去处理:
# -*- coding:utf-8 -*- # def UpperAttrMetaClass(class_name, class_parents, class_attr): class UpperAttrMetaClass(type): # __new__ 是在__init__之前被调用的特殊方法 # __new__是用来创建对象并返回之的方法 # 而__init__只是用来将传入的参数初始化给对象 # 你很少用到__new__,除非你希望能够控制对象的创建 # 这里,创建的对象是类,我们希望能够自定义它,所以我们这里改写__new__ # 如果你希望的话,你也可以在__init__中做些事情 # 还有一些高级的用法会涉及到改写__call__特殊方法,但是我们这里不用 def __new__(cls, class_name, class_parents, class_attr): # 遍历属性字典,把不是__开头的属性名字变为大写 new_attr = {} print("=" * 30) for name, value in class_attr.items(): print("name=%s and value=%s" % (name, value)) # 打印所有类属性出来 if not name.startswith("__"): new_attr[name.upper()] = value print("name.upper()=", name.upper()) print("value=", value) # 复用type.__new__方法 # 这就是基本的OOP编程,没什么魔法。由于type是元类也就是类,因此它本身也是通过__new__方法生成其实例,只不过这个实例是一个类. return type.__new__(cls, class_name, class_parents, new_attr) class Foo(object, metaclass=UpperAttrMetaClass): bar = 'bip' print("=" * 30) print("check Foo exist bar attr=", hasattr(Foo, 'bar')) print("check Foo exist BAR attr=", hasattr(Foo, 'BAR')) f = Foo() print("print f.BAR=", f.BAR)
如果使用super方法的话,我们还可以使它变得更清晰一些。
class UpperAttrMetaClass(type): def __new__(cls, class_name, class_parents, class_attr): # 遍历属性字典,把不是__开头的属性名字变为大写 new_attr = {} for name, value in class_attr.items(): print("name=%s and value=%s" % (name, value)) # 打印所有类属性出来 if not name.startswith("__"): new_attr[name.upper()] = value print("name.upper()=", name.upper()) print("value=", value) return super(UpperAttrMetaClass, cls).__new__(cls, class_name, class_parents, new_attr) class Foo(object, metaclass=UpperAttrMetaClass): bar = 'bip' print("check Foo exist bar attr=", hasattr(Foo, 'bar')) print("check Foo exist BAR attr=", hasattr(Foo, 'BAR')) f = Foo() print("print f.BAR=", f.BAR)
就元类本身而言,它们其实是很简单的:
- 拦截类的创建
- 修改类
- 返回修改之后的类
究竟为什么要使用元类?
现在回到我们的大主题上来,究竟是为什么你会去使用这样一种容易出错且晦涩的特性?好吧,一般来说,日常的业务逻辑开发是不太需要使用到元类的,因为元类是用来拦截和修改类的创建的,用到的场景很少。我能想到最典型的场景就是 ORM。
“元类就是深度的魔法,99%的用户应该根本不必为此操心。如果你想搞清楚究竟是否需要用到元类,那么你就不需要它。那些实际用到元类的人都非常清楚地知道他们需要做什么,而且根本不需要解释为什么要用元类。” —— Python界的领袖 Tim Peters
作者:DevOps海洋的渔夫
链接:https://www.jianshu.com/p/c1ca0b9c777d