Python 元类

Python 元类

今天在看 Django models 的源码时，看到了这么一个东西：

class ModelBase(type):
    """Metaclass for all models."""
    def __new__(cls, name, bases, attrs, **kwargs):
        super_new = super().__new__
    ...

当时看到这里的时候我挺疑惑的。为什么 ModelBase 去继承 type？？为什么class可以继承type？？type这玩意儿不是个函数吗？

于是乎我上网查了查，这东西叫做元类。那么什么是元类呢，我开始了我的探索之旅。

什么是元类

在 Python 中，实例对象是由类来创建的，那么类又是什么东西来创建的？其实类是通过元类来创建的。

在平时的编程中，元类基本上不会被用到。

类？对象

在大部分编程语言中，类的作用是来描述如何产生一个对象的代码段，在 Python 中，这点依然是成立的，但是在 Python 中似乎有一些不有一些不太一样的地方，在Python中，类也是一种对象。

来试试看。

class Test:
    pass

print(Test)
print(Test())
print(type(Test))
print(type(Test()))

输出

<class '__main__.Test'>
<__main__.Test object at 0x7fb0decebac0>
<class 'type'>
<class '__main__.Test'>

我们在上述代码中创建了一个类 Test，然后 print 了它本身，还有他的type。咦，实例化之后的 Test()好像没有什么奇怪的地方，但是 Test 类这个对象的 类型 就是 type。

我们再来看一下

print(Test.__class__)

输出

<class 'type'>

在 Python 中，类也是一种对象，只要你使用关键字class，Python解释器在执行的时候就会创建一个对象。

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

那么这个 type 有什么用呢？别急，下面再说说 type。

动态创建类

因为类也是一个对象，所以我们可以在运行的时候动态的创建它，就像创建其他对象一样。我们可以在函数中创建类，比如说。

def create_class(name):
    if name == 'Test':
        class Test:
            pass
        return Test
    else:
        class Other:
            pass
        return Other

MyClass = create_class('Test')
print(MyClass)
print(MyClass())

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

当你使用class关键字时，Python解释器自动创建这个对象。但就和Python中的其他很多地方一样，Python依然有提供给你手动处理的方法。

这里手动处理的方法就是使用 type。

这个函数可以让我们知道一个对象的类型是什么。比如：

>>> type(1)
<class 'int'>
>>> type('test')
<class 'str'>
>>> type(Test)
<class 'type'>
>>> type(Test())
<class '__main__.Test'>

其实除了这种用法以外，我们还可以用 type 来创建类。

使用 type 创建类

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

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

type可以像这样工作：

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

下面的代码：

class Test:  # 创建一个Test类
    pass

Test()  # 创建一个Test类的实例对象

等价于

Test = type("Test", (), {})  # 定义了一个Test类

Test()  # 创建一个Test类的实例对象

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

>>> Test = type("Test_class_name", (), {})
>>> Test
<class '__main__.Test_class_name'>
>>> help(Test)
Help on class Test_class_name in module __main__:

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

用 type 创建带属性的类

我们创建一个卖报纸的人的类。

>>> Person = type('Person', (), {'work': '卖报纸'})
>>> Person
<class '__main__.Person'>
>>> Person.work
'卖报纸'
>>> help(Person)
Help on class Person in module __main__:

class Person(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:
 |
 |  work = '卖报纸'
(END)
>>> Person.__dict__
mappingproxy({'work': '卖报纸', '__module__': '__main__', '__dict__': <attribute '__dict__' of 'Person' objects>, '__weakref__': <attribute '__weakref__' of 'Person' objects>, '__doc__': None})

需要注意的是，这里添加的是类属性不是实例属性。

用 type 创建带有方法的类

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

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

Child = type('Child', (Person, ), {})

我们创建了一个 Child 类来继承person类。看一下继承的mro和class

>>> Child.__mro__
(<class '__main__.Child'>, <class '__main__.Person'>, <class 'object'>)
>>> Child.__class__
<class 'type'>

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

def sell(self):
    # 定义一个普通的函数，一会儿加入类中
    return self.work

Child = type('Child', (Person, ), {'sell': sell})

# 设置静态方法
@staticmethod
def static_method():
    print("static method...")

# 设置类方法
@classmethod
def class_method(cls):
    print(cls.work)

Child = type('Child', (Person, ), {'sell': sell, 'static_method': static_method, 'class_method': class_method})

元类

之前说了这么多，那么到底什么是元类呢？

元类就是拿来创建类的东西，我们创建类就是为来创建类的实例化对象，但是在 Python 中类也是一种对象。

元类就是拿来创建这些类（对象）的，元类就是类的类。

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

# 也可以用type
MyClass = type('MyClass', (), {})

这是因为函数type实际上是一个元类。type就是Python在背后用来创建所有类的元类。

那为什么type会全部采用小写形式而不是Type呢？这可能是为了和str, int等保持一致性，str是用来创建字符串对象的类，而int是用来创建整数对象的类。type就是创建类对象的类。Python中所有的东西，都是对象。这包括整数、字符串、函数以及类。它们全部都是对象，而且它们都是从一个类创建而来，这个类就是type。

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

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

__metaclass__属性

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

看看例子：

python2

class Test:
    __metaclass__ = MetaClass
    ...

python3

class Bar(object, metaclass=MetaClass):
    ...

如果这么做了，Python就会用元类来创建类 Test。如果类Foo还没有在内存中创建，Python 会在类的定义中寻找__metaclass__属性，如果找到了，Python 就会用它来创建类 Test，否则，就会用内建的 type 来创建这个类。

当写出如下代码时:

class ChildTest(Test):
    pass

Python会做如下的操作：

那么在metaclass中放置些什么代码呢？

可以创建一个类的东西。那么什么可以用来创建一个类呢？type，或者任何使用到type或者子类化type的类都可以，反正最终还是需要type的。

自定义元类

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

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

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

#-*- 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)

结果如下：

==============================
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):

    # __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

就元类本身的作用来说：

为何使用元类

引用Python界的领袖 Tim Peters 的原话

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