python元类

什么是元类

我们知道，实例对象是由类来创建，那么类又是由什么来创建的呢？ 答案就是元类。

元类基本都不会用到，但是就算不用到，也应该去熟悉一下概念。

类也是对象

在大多数编程语言中，类就是一组用来描述如何生成一个对象的代码段。在Python中这一点仍然成立：

 

In [1]: class FatBoy(object): 
   ...:     pass 
   ...:                                                                                                                    

In [2]: fb = FatBoy()                                                                                                      

In [3]: print(fb)                                                                                                          
<__main__.FatBoy object at 0x7fbd18f73b38>

In [4]: id(fb)                                                                                                             
Out[4]: 140450144402232

In [5]:  

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

下面的代码段：

 

In [1]: class FatBoy(object): 
   ...:     pass 
   ...:       

将在内存中创建一个对象，名字就是FatBoy。这个对象（类对象FatBoy）拥有创建对象（实例对象）的能力。但是，它的本质仍然是一个对象，于是乎你可以对它做如下的操作：

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

下面是示例：

 

# 可以打印一个类，因为它其实也是一个对象
In [5]: print(FatBoy)                                                                                                      
<class '__main__.FatBoy'>

In [6]:         
                                                                                                           
# 可以将它作为函数参数进行传递
In [6]: def print_object(obj): 
   ...:     print(obj) 
   ...:                                                                                                                                                                                                                                     

In [7]: print_object(FatBoy)                                                                                               
<class '__main__.FatBoy'>

In [8]:                                                                                                                    

# 可以为它增加属性
In [8]: FatBoy.hobby = "肥仔可乐水"                                                                                        

# 查看该属性是否存在
In [9]: print(hasattr(FatBoy,'hobby'))                                                                                     
True

# 打印该属性
In [10]: print(FatBoy.hobby)                                                                                               
肥仔可乐水

In [11]:                                                                                                                   

# 可以将它赋值给一个变量
In [11]: FatBoss = FatBoy                                                                                                  

# 查看FatBoss是否是类
In [12]: print(FatBoss)                                                                                                    
<class '__main__.FatBoy'>

# 查看FatBoss有无hobby属性
In [13]: print(hasattr(FatBoss,'hobby'))                                                                                   
True

# 打印看看hobby属性，发现完全将FatBoy复制过来了。
In [14]: print(FatBoss.hobby)                                                                                              
肥仔可乐水

In [15]:  

动态地创建类

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

 

In [15]: def choose_class(name): 
    ...:     if name == 'foo': 
    ...:         class Foo(object): 
    ...:             pass 
    ...:         return Foo # 返回的是类，不是类的实例 
    ...:     else: 
    ...:         class Bar(object): 
    ...:             pass 
    ...:         return Bar 
    ...:                                                                                                                   

In [16]: MyClass = choose_class('foo')                                                                                     

## 可以看出MyClass就是一个类，Foo类
In [17]: print(MyClass)                                                                                                    
<class '__main__.choose_class.<locals>.Foo'>

## 可以通过这个类创建类实例，也就是对象
In [18]: print(MyClass())                                                                                                  
<__main__.choose_class.<locals>.Foo object at 0x7fbd19c4e550>

In [19]:   

但这还不够动态，因为你仍然需要自己编写整个类的代码。由于类也是对象，所以它们必须是通过什么东西来生成的才对。

当你使用class关键字时，Python解释器自动创建这个对象。但就和Python中的大多数事情一样，Python仍然提供给你手动处理的方法。

还记得类型函数type()吗？这个古老但强大的函数能够让你知道一个对象的类型是什么，就像这样：

 

In [19]: print(type(1)) # 数值的类型                                                                                       
<class 'int'>

In [20]: type(1)                                                                                                           
Out[20]: int

In [21]: print(type("fat boy")) # 字符串类型                                                                               
<class 'str'>

In [22]: type("fat boy")                                                                                                   
Out[22]: str

In [23]: print(type(FatBoy())) # 实例对象类型                                                                              
<class '__main__.FatBoy'>

In [24]: type(FatBoy())                                                                                                    
Out[24]: __main__.FatBoy

In [25]: print(type(FatBoy)) # 类的类型                                                                                    
<class 'type'>

In [26]: type(FatBoy)                                                                                                      
Out[26]: type

In [27]:  

仔细观察上面的运行结果，发现使用type对FatBoy查看类型是，答案为type， 是不是有些惊讶。

使用type创建类

type还有一种完全不同的功能，动态的创建类。

type可以接受一个类的描述作为参数，然后返回一个类。（要知道，根据传入参数的不同，同一个函数拥有两种完全不同的用法是一件很傻的事情，但这在Python中是为了保持向后兼容性）

type可以像这样工作：

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

比如下面的代码：

 

In [27]: class Test: # 定义一个Test类 
    ...:     pass 
    ...:                                                                                                                   

In [28]: Test() # 创建一个Test类实例对象                                                                                   
Out[28]: <__main__.Test at 0x7fbd19bf0cf8>

In [29]:  

可以手动像这样创建：

 

In [29]: Test2 = type("Test2",(),{}) # 定义了一个Test2类                                                                   

In [30]: Test2() # 创建一个Test2类实例对象                                                                                 
Out[30]: <__main__.Test2 at 0x7fbd19b91208>

In [31]:  

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

即type函数中第1个实参，也可以叫做其他的名字，这个名字表示类的名字，如下：

 

## type的第一个实参 FatBoss 就是类名，然后传递给变量 FatBoy
In [1]: FatBoy = type("FatBoss",(),{})

In [2]: FatBoy
Out[2]: __main__.FatBoss

## 查看FatBoy的类描述，就是FatBoss类
In [3]: help(FatBoy)
Help on class FatBoss in module __main__:

class FatBoss(builtins.object)
 |  Data descriptors defined here:
 |
 |  __dict__
 |      dictionary for instance variables (if defined)
 |
 |  __weakref__
 |      list of weak references to the object (if defined)

使用type创建带有属性的类

创建一个胖子老板类，增加属性hobby：胖子老板卖槟榔

 

In [5]: FatBoss = type('FatBoss',(),{'hobby':"胖子老板卖槟榔"})

In [6]: FatBoss
Out[6]: __main__.FatBoss

In [7]: FatBoss.hobby
Out[7]: '胖子老板卖槟榔'

In [8]: help(FatBoss)
Help on class FatBoss in module __main__:

class FatBoss(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:
 |
 |  hobby = '胖子老板卖槟榔'


In [9]: FatBoss.__dict__
Out[9]: 
mappingproxy({'hobby': '胖子老板卖槟榔',
              '__module__': '__main__',
              '__dict__': <attribute '__dict__' of 'FatBoss' objects>,
              '__weakref__': <attribute '__weakref__' of 'FatBoss' objects>,
              '__doc__': None})

In [10]: 

注意：添加的属性是类属性，并不是实例属性

现在我们已经知道 type 的第三个参数是用来设置类属性的，那么第二个参数元组是干什么的呢？

第二个参数元组是用来填写继承的父类名称，演示如下：

 

## 定义胖子老板的女儿类，继承胖子老板类
In [10]: FatBossGril = type("FatBossGril",(FatBoss,),{})

## 那么这里来看看是否继承了胖子老板的hobby爱好，下面可以看出是正常继承的。
In [11]: FatBossGril.hobby
Out[11]: '胖子老板卖槟榔'

## 再看看FatBossGril的继承MRO
In [12]: FatBossGril.__mro__
Out[12]: (__main__.FatBossGril, __main__.FatBoss, object)

In [13]: FatBossGril.__class__
Out[13]: type

In [14]: 

使用type创建带有方法的类

类通常都会有类方法，下面来看看怎么使用type的方式来创建类方法。

 

In [14]: def sell(self): # 定义一个普通的函数，等下加入胖子老板类
    ...:     print(self.hobby)
    ...: 

In [15]: hasattr(FatBoss,'hobby')
Out[15]: True

In [16]: FatBossGril = type('FatBossGril',(FatBoss,),{'sell':sell})

In [17]: hasattr(FatBossGril,'sell')
Out[17]: True

In [18]: hasattr(FatBossGril,'hobby')
Out[18]: True

In [21]: fatbossgril = FatBossGril()

In [22]: fatbossgril.sell()
胖子老板卖槟榔

In [23]: 

上面演示的这个方法属于实例方法，那么静态方法、类方法这些该怎么创建呢？

设置静态方法

 

In [25]: @staticmethod
    ...: def static_method():
    ...:     print("static method...")
    ...: 

In [26]: FatBossGril = type('FatBossGril',(FatBoss,),{'sell':sell,'static_method':static_method})

In [27]: FatBossGril.static_method
Out[27]: <function __main__.static_method()>

In [28]: FatBossGril.static_method()
static method...

静态方法不需要实例化就可以使用，下面再来看看类方法。

设置类方法

 

In [31]: @classmethod
    ...: def class_method(cls):
    ...:     print(cls.hobby)
    ...:

In [32]: FatBossGril = type('FatBossGril',(FatBoss,),{'sell':sell,'static_method':static_method,'class_method':class_method})

In [33]: FatBossGril.class_method
Out[33]: <bound method class_method of <class '__main__.FatBossGril'>>

In [34]: FatBossGril.class_method()
胖子老板卖槟榔

In [35]: 

从上面的几个示例，基本已经知道了如何使用type来定义方法。

那么再来思考一下，到底什么是元类

元类就是用来创建类的“东西”。你创建类就是为了创建类的实例对象，不是吗？但是我们已经学习到了Python中的类也是对象。

元类就是用来创建这些类（对象）的，元类就是类的类，你可以这样理解为：

 

MyClass = MetaClass() # 使用元类创建出一个对象，这个对象称为“类”
my_object = MyClass() # 使用“类”来创建出实例对象

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

 

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

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

 

## 查看age整数的类属性
In [35]: age = 23

In [36]: age.__class__
Out[36]: int

## 查看name字符串的类属性
In [37]: name = '肥仔白'

In [38]: name.__class__
Out[38]: str

## 查看函数方法的类属性
In [39]: def sell():
    ...:     pass
    ...: 

In [40]: sell.__class__
Out[40]: function

## 查看实例的类属性
In [41]: class FatBoss(object):
    ...:     pass
    ...: 

In [42]: fb = FatBoss()

In [43]: fb.__class__
Out[43]: __main__.FatBoss

In [44]: 

从上面的示例，大概知道了整型、字符串等等的类属性。那么类（__class__）的类属性（__class__）又是什么呢？

 

In [44]: age.__class__
Out[44]: int

In [45]: age.__class__.__class__
Out[45]: type

In [46]: name.__class__.__class__
Out[46]: type

In [47]: sell.__class__
Out[47]: function

In [48]: sell.__class__.__class__
Out[48]: type

In [49]: fb.__class__
Out[49]: __main__.FatBoss

In [50]: fb.__class__.__class__
Out[50]: type

In [51]: fb.__class__.__class__.__class__
Out[51]: type

In [52]: 

可以看出，不管是什么类型的类，最终的创建元类都是type。

因此，元类就是创建类这种对象的东西。type就是Python的内建元类，当然了，你也可以创建自己的元类。

__metaclass__属性

上面已经知道了如何使用type这个元类来创建类，那么如何创建自己的元类呢？？
此情此景需要用到__metaclass__属性。

其实仔细回想一下，就是类似闭包的处理方式，下面来演示看看。

 

class FatBoss(object):
    __metaclass__ = something…
    ...省略...

如果你这么做了，Python就会用元类来创建类Foo。小心点，这里面有些技巧。你首先写下class Foo(object)，但是类Foo还没有在内存中创建。Python会在类的定义中寻找__metaclass__属性，如果找到了，Python就会用它来创建类Foo，如果没有找到，就会用内建的type来创建这个类。

大致过程：

• 当你写如下代码时 :

 

class FatBossGril(FatBoss):
    pass

• Python就会做如下的操作：
  • FatBossGril中有__metaclass__这个属性吗？如果有，那么Python会通过__metaclass__创建一个名字为FatBossGril的类(对象)
  • 如果Python没有找到__metaclass__，它会继续在FatBoss（父类）中寻找__metaclass__属性，并尝试做和前面同样的操作。
  • 如果Python在任何父类中都找不到__metaclass__，它就会在模块层次中去寻找__metaclass__，并尝试做同样的操作。
  • 如果还是找不到__metaclass__,Python就会用内置的type来创建这个类对象。

现在的问题就是，你可以在__metaclass__中放置些什么代码呢？答案就是：可以创建一个类的东西。那么什么可以用来创建一个类呢？type，或者任何使用到type或者子类化type的类都可以，反正最终还是需要type的。

自定义元类

元类的主要目的就是为了当创建类时能够自动地改变类。

假想一个很傻的例子，你决定在你的模块里所有的类的属性都应该是大写形式。有好几种方法可以办到，但其中一种就是通过在模块级别设定__metaclass__。采用这种方法，这个模块中的所有类都会通过这个元类来创建，我们只需要告诉元类把所有的属性都改成大写形式就万事大吉了。

幸运的是，__metaclass__实际上可以被任意调用，它并不需要是一个正式的类。所以，我们这里就先以一个简单的函数作为例子开始。

python2中

 

[root@server81 test]# cat test1.py 
#-*- coding:utf-8 -*-
def upper_attr(class_name, class_parents, class_attr):

    # 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 # 设置Foo类的元类为upper_attr
    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)
[root@server81 test]# 

运行如下：

 

[root@server81 test]# python test1.py 
==============================
name=bar and value=bip
('name.upper()=', 'BAR')
('value=', 'bip')
name=__module__ and value=__main__
name=__metaclass__ and value=<function upper_attr at 0x251c578>
==============================
('check Foo exist bar attr=', False)
('check Foo exist BAR attr=', True)
('print f.BAR=', 'bip')
[root@server81 test]# 

python3中

 

[root@server81 test]# cat test1.py 
#-*- coding:utf-8 -*-
def upper_attr(class_name, class_parents, class_attr):

    # 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): # python3 与 2的写法唯一区别
    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)
[root@server81 test]# 

运行如下：

 

[root@server81 test]# python3 test1.py 
==============================
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
[root@server81 test]# 

从上面的例子中，使用元类的方式，将Foo类中的属性bar修改为BAR。在这是使用的def 方法来作为类似元类的做法，下面使用class来定义元类。

 

[root@server81 test]# cat test1.py 
#-*- 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来创建一个类
        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)
[root@server81 test]# 

运行如下：

 

[root@server81 test]# python3 test1.py 
==============================
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
[root@server81 test]# 

就元类本身而言，它们其实是很简单的：

• 拦截类的创建
• 修改类
• 返回修改之后的类

究竟为什么要使用元类？

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

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

作者：Devops海洋的渔夫
链接：https://www.jianshu.com/p/c1ca0b9c777d
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。