Pyhton中的元类

Posted 2021-02-01 soga238

目录

• 前言
• 一切皆对象
• 动态的创建类
• 到底什么是元类
• 自定义元类
• 为什么要用metaclass类而不是函数
• 结语

前言

本片文章主要是StackOverflow上关于元类解释的高赞文章的译文，顺便加了一点个人的理解。 想看原文的同学可以直接点击 What-are-metaclasses-in-python。

环境使用Python2

一切皆对象

在Python中，一切皆对象。 字符串、列表、字典和函数是对象，类也是对象。因此你可以：

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

下面是示例：

class ObjectCreator(object):
    pass

print (ObjectCreator)   # 你可以打印一个类，因为它其实也是一个类

def echo(o):    # 作为函数参数
    print (o)

echo(ObjectCreator)

print (hasattr(ObjectCreator, ‘new_attribute‘))

ObjectCreator.new_attribute = ‘foo‘ # 手动添加属性
print (hasattr(ObjectCreator, ‘new_attribute‘))
print (ObjectCreator.new_attribute)

ObjectCreatorMirror = ObjectCreator # 赋值给变量
print (ObjectCreatorMirror())

运行结果为:

<class ‘__main__.ObjectCreator‘>
<class ‘__main__.ObjectCreator‘>
False
True
foo
<__main__.ObjectCreator object at 0x000000000337B6A0>

动态的创建类

因为类也是对象， 所以你可以在运行时动态的创建它们，就像其它对象一样。 首先，你可以在函数中使用 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)     # the function returns a class, not an instance
print (MyClass())   # you can create an object from this class

运行结果：

<class ‘__main__.Foo‘>
<__main__.Foo object at 0x00000000038FB710>

但是这还不够动态，因为你仍然需要自己编写整个类的代码。 由于类也是对象，所以它们必须通过一些东西生成。 当你使用 class 关键字时，Python解释器自动创建这个对象。

但就和Python中大多数事情一样，Python仍然给你提供了手动处理的办法。 还记得内置函数 type 吗？ 这个古老但强大的函数能够让你知道一个对象的类型是什么，就像这样：

print(type(1))
print(type("1"))
print(type(ObjectCreator))
print(type(ObjectCreator()))

输出结果：

<type ‘int‘>
<type ‘str‘>
<type ‘type‘>
<class ‘__main__.ObjectCreator‘>

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

type 可以像这样工作：

type(name of the class, tuple of the parent class(for inheritance, canbe empty), dictionary containing attributes names and values)

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

比如下面的代码：

class MyShinyClass(object):
    pass

可以通过下面这种方式手动创建：

MyShinyClass = type(‘MyShinyClass‘, (), {})
print (MyShinyClass)
print (MyShinyClass())

# result
<class ‘__main__.MyShinyClass‘>
<__main__.MyShinyClass object at 0x000000000318B710>

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

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

class Foo(object):
    bar = True

可以翻译为：

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

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

print (Foo)
f = Foo()
print (f)
print (f.bar)

# result
<__main__.MyShinyClass object at 0x0000000002CDB710>
<class ‘__main__.Foo‘>
<__main__.Foo object at 0x0000000002CDB710>
True

当然，你可以像这个类继承，就像下面的代码一样：

FooChild = type(‘FooChild‘, (Foo, ), {})
print (FooChild)
print (FooChild.bar)

# result
<class ‘__main__.FooChild‘>
True

最终你会希望为你的类增加方法，只需要定义一个有着恰当名称的函数，并将其作为属性赋值就可以了。

def echo_bar(self):
    print (self.bar)

FooChild = type(‘FooChild‘, (Foo, ), {"echo_bar": echo_bar})
print (hasattr(Foo, ‘echo_bar‘))
print (hasattr(FooChild, ‘echo_bar‘))
my_foo = FooChild()
my_foo.echo_bar()

# result
False
True
True

你可以看到，在Python中，类也是对象，你可以动态的创建类。这就是当你使用关键字 class 时，Python在幕后做的事情，而这就是通过元类来实现的。

到底什么是元类

重点来了！

元类就是用来创建类的东西。 你创建类就是为了创建类的实例对象，不是吗？ 但是我们已经学习到Python中的类是对象。 好吧，元类就是用来创建这些类（对象） 的， 元类就是类的类，你可以理解为：

MyClass = MetaClass()
MyObject = MyClass()

附图-对象、类、元类的关系

在Python3中，object是所有类的基类，内置的类、自定义的类都直接或间接的继承自object类（Python2中的新式类需要显示继承object）。如果去查看源码，你会发现， type也继承自object。这就对我们的理解造成了极大的困扰，主要表现在以下三点：

• type是一个metaclass，而且是一个默认的metaclass。 也就是说，type是 object的类型， object是type的一个实例。
• type是object的一个子类，继承object的所有属性和方法。
• type还是一个callable，既实现了 __call__ 方法，可以当成一个函数实现。

我们使用一张图来解释type和object的关系：

附图-type和object关系

type和object有点像 "蛋生鸡" 和 "鸡生蛋" 的关系： type是object的子类， 同时obejct又是type的一个实例。type实例还是它自身。

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

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

这是因为函数type实际上是一个元类。type就是Python在背后用来创建所有类的元类。 现在你想知道那为什么type会全部采用小写形式而不是Type呢? 好吧，我猜这是为了和str保持一致性，str是用来创建字符串对象的类，而int是用来创建整数对象的类。 type就是创建对象的类。你可以通过检查 __class__ 属性来看到这一点。

回到开头，Python中所有的东西都是对象，而且它们都是从同一个类创建而来。

age = 35
print (age.__class__)
name = ‘bob‘
print (name.__class__)

def foo():
    pass
print (foo.__class__)

class Bar(object):
    pass
b = Bar()
print (b.__class__)

# result
<type ‘int‘>
<type ‘str‘>
<type ‘function‘>
<class ‘__main__.Bar‘>

现在，对于任何一个 __class__ 的 __class__ 属性又是什么呢？

print (age.__class__.__class__)
print (foo.__class__.__class__)
print (b.__class__.__class__)

# result
<type ‘type‘>
<type ‘type‘>
<type ‘type‘>

因此，元类就是创建类这种对象的东西。 如果你喜欢的话， 可以把元类称为 "类工厂" （不要和工厂类搞混了） type就是Python的内建元类。 当然了，你也可以创建自己的元类。

__metaclass__ in Python2

Python2 中指明元类的方法是，给类添加 __metaclass__ 属性(Python3语法看下一小节)。 自定义的Metaclass通常以Metaclass或Meta作为后缀进行取名，以示区分。

class Foo(object):
    __metaclass__ = CustomMetaclass

如果你这么做了，Python就会使用元类来创建类Foo。

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

当你写下如下内容时 把下面的内容读上几次。

class Foo(object):
    pass

Python 有 __metaclass__ 这个属性吗？

• 如果有，Python会在内存中通过 __metaclass__ 创建一个名字为Foo的类对象（我说的是类对象，请跟紧我的思路）。

• 如果Python没有找到 __metaclass__ ， 它会继续在Bar(父类)中寻找 __metaclass__属性，并尝试座和前面同样的操作。

• 如果Python在任何父类中都找不到 __metaclass__，它就会在模块层次中寻找 __metaclass__ ， 并尝试同样的操作。

• 如果还是找不到 __metaclass__ ，Python就会用内置的type来创建这个类对象。

补充：metaclass的查找循序可以下Python2文档找到：

The appropriate metaclass is determined by the following precedence rules:

• If dict[‘metaclass‘] exists, it is used.
• Otherwise, if there is at least one base class, its metaclass is used (this looks for a class attribute first and if not found, uses its type).
• Otherwise, if a global variable named metaclass exists, it is used.
• Otherwise, the old-style, classic metaclass (types.ClassType) is used.

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

metaclass in Python3

在Python3中设置元类的语法做出了一些该变，但目前仍然兼容Python2。__metaclass__ 属性不再被使用， 而是使用基类列表中的关键字参数。

class Foo(object, metaclass=CustomMetaclss):
    [...]

自定义元类

元类的主要目的为了在创建类时，能够自动地改变类。通常，你会为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‘

现在让我们再做一次，这一次用一个真正的class来当作元类。

# 请记住，‘type‘实际上是一个类，就像‘str‘和‘int‘一样。 所以，你可以从type继承
class UpperAttrMetaClass(type):
    # __new__ 是在__init__之前被调用的特殊方法
    # __new__是用来创建对象并返回之的方法
    # 而__init__只是用来将传入的参数初始化给对象
    # 你很少用到__new__，除非你希望能够控制对象的创建
    
    # 这里，创建的对象是类，我们希望能够自定义它，所以我们这里改写__new__
    # 如果你希望的话，你也可以在__init__中做些事情
    # 还有一些高级的用法会涉及到改写__call__特殊方法，但是我们这里不用
    def __new__(upperattr_metaclass, 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)
        return type(future_class_name, future_class_parents, uppercase_attr)

但是，这种方法其实不符合OOP。 我们直接调用了 type, 而且我们没有改写父类的 __new__ 方法。 现在让我们这样处理：

class UpperAttrMetaclass(type):
    def __new__(upperattr_metaclass, 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.__new__方法
        # 这就是基本的OOP编程，没什么魔法
        return type.__new__(upperattr_metaclass, future_class_name, future_class_parents, uppercase_attr)

如果使用super方法的画，我们还可以使它更清晰一些，这会缓解继承（是的，你可以拥有元类，从元类继承，从type继承）

class UpperAttrMetaclass(type):
    def __new__(cls, name, bases, dct):
        attrs = ((name, value) for name, value in dct.items() if not name.startswith(‘__‘))
        uppercase_attr = dict((name.upper(), value) for name, value in attrs)
        return super(UpperAttrMetaclass, cls).__new__(cls, name, bases, uppercase_attr)

就是这样，除此之外，关于元类真的没有别的再好说的了。 使用到元类的代码比较复杂，这背后的原因到并不是因为元类本身，而是因为你通常会使用元类去做一些晦涩的事情，依赖于自省，控制继承等等。 确实，用元类来搞些“黑暗魔法”是特别有用的，因而会搞出些复杂的东西来。 但就元类本身而言，他们其实是很简单的。

1、拦截类的创建

2、修改类

3、返回修改之后的类

为什么要用metaclass类而不是函数

由于 __metaclass__ 可以接受任何可调用的对象，那为何还要使用类呢？ 很显然使用类会更加复杂。 这里有好几个原因：

1、 你的意图会更加清晰， 当你读到UpperAttrMetaclass(type)时，你会知道接下来发生什么。

2、你可以使用OOP编程。 元类可以从元类继承而来，改写父类的方法。 元类甚至还可以使用元类。

3、你可以把代码组织的更好。当你使用元类的时候肯定不会是像我上面举的那种简单场景，通常都是针对比较复杂的问题。将多个方法归总到一个类总是很有帮助，也会使得代码更容易阅读。

4、你可以使用 __new__， __init__ 以及 __call__ 这样的特殊方法。它们能帮你处理不同的任务。 就算通常你可以把所有东西都放在 __new__ 里处理， 有些人还是觉得用 __init__ 更舒服。

5、这个东西的名字叫做metaclass， 肯定非善类，我要小心！

究竟为什么要使用元类

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

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

元类的主要用途使创建API，一个典型的例子使Django ORM。它允许你这样定义：

class Person(models.Model):
    name = models.CharField(max_length=30)
    age = models.IntegerField()

但是如果你想这样做的话：

guy  = Person(name=‘bob‘, age=‘35‘)
print(guy.age)

这并不会返回一个IntegerField对象，而是返回一个int对象， 甚至可以直接从数据库中取出数据。 这是有可能的，因为models.Model定义了metaclass， 而且使用了一些魔法能够将你刚刚定义的简单的Person类转变成对数据库的一个复杂hook。 Django框架将这些看起来很复杂的东西通过简单暴露出一个简单的使用元类的API将其化简，通过这个API重新创建代码，在背后完成真正的工作。

结语

首先，你知道了类是能够创建出类实例的对象。好吧，事实上，类也是实例，当然它们是元类的实例。

class Foo(object): pass
print(id(Foo))
58680680

Python中一切皆对象，它们要么是类的实例，要么是元类的实例，除了type。 type实际上是自己的元类，在纯Python环境中这可不是你能够做到的，这是通过在实现层面耍的小手段做到的。 其次，元类是很复杂的。 对于非常简单的类，你可能不希望通过使用元类来对类做修改。你可以通过其它两种技术来修改类：

1、Monkey patching

2、class decorator

当你需要动态修改类时， 99%的时间里面你最好使用以上两种技术。当然了，其实在99%的时间里你根本不需要动态修改类。