Python 中的元类是什么？

作为对象的类

在了解元类之前，您需要掌握 Python 中的类。 Python 对什么是类有一个非常奇特的想法，这是从 Smalltalk 语言中借来的。

在大多数语言中，类只是描述如何生成对象的代码片段。在 Python 中也是如此：

>>> class ObjectCreator(object):
...       pass
...

>>> my_object = ObjectCreator()
>>> print(my_object)
<__main__.ObjectCreator object at 0x8974f2c>

但是类不仅仅是 Python 中的类。类也是对象。

是的，对象。

只要您使用关键字 class，Python 就会执行它并创建一个对象。该指令

>>> class ObjectCreator(object):
...       pass
...

在内存中创建一个名为 ObjectCreator 的对象。

这个对象（类）本身能够创建对象（实例），这就是它是类的原因。

但是，它仍然是一个对象，因此：

您可以将其分配给变量

你可以复制它

您可以为其添加属性

您可以将其作为函数参数传递

例如：

>>> print(ObjectCreator) # you can print a class because it's an object
<class '__main__.ObjectCreator'>
>>> def echo(o):
...       print(o)
...
>>> echo(ObjectCreator) # you can pass a class as a parameter
<class '__main__.ObjectCreator'>
>>> print(hasattr(ObjectCreator, 'new_attribute'))
False
>>> ObjectCreator.new_attribute = 'foo' # you can add attributes to a class
>>> print(hasattr(ObjectCreator, 'new_attribute'))
True
>>> print(ObjectCreator.new_attribute)
foo
>>> ObjectCreatorMirror = ObjectCreator # you can assign a class to a variable
>>> print(ObjectCreatorMirror.new_attribute)
foo
>>> print(ObjectCreatorMirror())
<__main__.ObjectCreator object at 0x8997b4c>

动态创建类

由于类是对象，因此您可以像任何对象一样动态创建它们。

首先，您可以使用 class 在函数中创建一个类：

>>> def choose_class(name):
...     if name == 'foo':
...         class Foo(object):
...             pass
...         return Foo # return the class, not an instance
...     else:
...         class Bar(object):
...             pass
...         return Bar
...
>>> MyClass = choose_class('foo')
>>> print(MyClass) # the function returns a class, not an instance
<class '__main__.Foo'>
>>> print(MyClass()) # you can create an object from this class
<__main__.Foo object at 0x89c6d4c>

但它不是那么动态的，因为你仍然需要自己编写整个类。

由于类是对象，因此它们必须由某些东西生成。

当您使用 class 关键字时，Python 会自动创建此对象。但与 Python 中的大多数事情一样，它为您提供了一种手动完成的方法。

还记得函数 type 吗？让您知道对象是什么类型的旧函数：

>>> print(type(1))
<type 'int'>
>>> print(type("1"))
<type 'str'>
>>> print(type(ObjectCreator))
<type 'type'>
>>> print(type(ObjectCreator()))
<class '__main__.ObjectCreator'>

嗯，type 有一个完全不同的能力，它还可以动态创建类。 type 可以将类的描述作为参数，并返回一个类。

（我知道，根据您传递给它的参数，同一个函数可以有两种完全不同的用途，这是愚蠢的。由于 Python 的向后兼容性，这是一个问题）

type 以这种方式工作：

type(name, bases, attrs)

在哪里：

名称：类的名称

bases：父类的元组（用于继承，可以为空）

attrs：包含属性名称和值的字典

例如：

>>> class MyShinyClass(object):
...       pass

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

>>> MyShinyClass = type('MyShinyClass', (), {}) # returns a class object
>>> print(MyShinyClass)
<class '__main__.MyShinyClass'>
>>> print(MyShinyClass()) # create an instance with the class
<__main__.MyShinyClass object at 0x8997cec>

您会注意到我们使用 MyShinyClass 作为类的名称和保存类引用的变量。它们可以不同，但没有理由使事情复杂化。

type 接受一个字典来定义类的属性。所以：

>>> class Foo(object):
...       bar = True

可以翻译成：

>>> Foo = type('Foo', (), {'bar':True})

并用作普通类：

>>> print(Foo)
<class '__main__.Foo'>
>>> print(Foo.bar)
True
>>> f = Foo()
>>> print(f)
<__main__.Foo object at 0x8a9b84c>
>>> print(f.bar)
True

当然，你可以继承它，所以：

>>>   class FooChild(Foo):
...         pass

将会：

>>> FooChild = type('FooChild', (Foo,), {})
>>> print(FooChild)
<class '__main__.FooChild'>
>>> print(FooChild.bar) # bar is inherited from Foo
True

最终，你会想要为你的类添加方法。只需定义一个具有适当签名的函数并将其分配为属性。

>>> def echo_bar(self):
...       print(self.bar)
...
>>> FooChild = type('FooChild', (Foo,), {'echo_bar': echo_bar})
>>> hasattr(Foo, 'echo_bar')
False
>>> hasattr(FooChild, 'echo_bar')
True
>>> my_foo = FooChild()
>>> my_foo.echo_bar()
True

并且你可以在动态创建类之后添加更多的方法，就像在正常创建的类对象中添加方法一样。

>>> def echo_bar_more(self):
...       print('yet another method')
...
>>> FooChild.echo_bar_more = echo_bar_more
>>> hasattr(FooChild, 'echo_bar_more')
True

你知道我们要去哪里：在 Python 中，类是对象，你可以动态地创建一个类。

这就是 Python 在使用关键字 class 时所做的事情，它通过使用元类来做到这一点。

什么是元类（最后）

元类是创建类的“东西”。

你定义类是为了创建对象，对吧？

但是我们了解到 Python 类是对象。

好吧，元类是创建这些对象的原因。它们是班级的班级，您可以这样描绘它们：

MyClass = MetaClass()
my_object = MyClass()

您已经看到 type 允许您执行以下操作：

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

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

现在你想知道“为什么它是小写的，而不是 Type？”

好吧，我想这是与 str（创建字符串对象的类）和 int（创建整数对象的类）的一致性问题。 type 只是创建类对象的类。

您可以通过检查 __class__ 属性看到这一点。

一切，我的意思是一切，都是 Python 中的对象。这包括整数、字符串、函数和类。它们都是对象。所有这些都是从一个类创建的：

>>> age = 35
>>> age.__class__
<type 'int'>
>>> name = 'bob'
>>> name.__class__
<type 'str'>
>>> def foo(): pass
>>> foo.__class__
<type 'function'>
>>> class Bar(object): pass
>>> b = Bar()
>>> b.__class__
<class '__main__.Bar'>

现在，任何 __class__ 的 __class__ 是什么？

>>> age.__class__.__class__
<type 'type'>
>>> name.__class__.__class__
<type 'type'>
>>> foo.__class__.__class__
<type 'type'>
>>> b.__class__.__class__
<type 'type'>

因此，元类只是创建类对象的东西。

如果你愿意，你可以称它为“类工厂”。

type 是 Python 使用的内置元类，当然，您也可以创建自己的元类。

__metaclass__ 属性

在 Python 2 中，您可以在编写类时添加 __metaclass__ 属性（请参阅下一节了解 Python 3 语法）：

class Foo(object):
    __metaclass__ = something...
    [...]

如果您这样做，Python 将使用元类来创建类 Foo。

小心，这很棘手。

您先编写 class Foo(object)，但尚未在内存中创建类对象 Foo。

Python 将在类定义中查找 __metaclass__。如果找到它，它将使用它来创建对象类 Foo。如果没有，它将使用 type 创建类。

多读几遍。

当你这样做时：

class Foo(Bar):
    pass

Python 执行以下操作：

Foo 中是否有 __metaclass__ 属性？

如果是，请使用 __metaclass__ 中的内容在内存中创建一个名为 Foo 的类对象（我说的是类对象，请留在我这里。）。

如果 Python 找不到 __metaclass__，它将在 MODULE 级别查找 __metaclass__，并尝试执行相同的操作（但仅适用于不继承任何内容的类，基本上是旧式类）。

然后，如果它根本找不到任何 __metaclass__，它将使用 Bar（第一个父级）自己的元类（可能是默认的 type。）来创建类对象。

注意这里 __metaclass__ 属性不会被继承，父类 (Bar.__class__) 的元类会被继承。如果 Bar 使用通过 type()（而不是 type.__new__()）创建 Bar 的 __metaclass__ 属性，则子类将不会继承该行为。

现在最大的问题是，您可以在 __metaclass__ 中添加什么？

答案是可以创建类的东西。

什么可以创建一个类？ type，或任何子类或使用它的东西。

Python 3 中的元类

Python 3 中设置元类的语法已更改：

class Foo(object, metaclass=something):
    ...

即不再使用__metaclass__ 属性，而是使用基类列表中的关键字参数。

然而，元类的行为保持 largely the same。

在 Python 3 中添加到元类的一件事是，您还可以将属性作为关键字参数传递给元类，如下所示：

class Foo(object, metaclass=something, kwarg1=value1, kwarg2=value2):
    ...

阅读下面的部分，了解 Python 如何处理这个问题。

自定义元类

元类的主要目的是在创建类时自动更改它。

您通常为 API 执行此操作，您希望在其中创建与当前上下文匹配的类。

想象一个愚蠢的例子，你决定模块中的所有类的属性都应该用大写字母写。有几种方法可以做到这一点，但一种方法是在模块级别设置 __metaclass__。

这样，这个模块的所有类都将使用这个元类创建，我们只需要告诉元类将所有属性都转为大写即可。

幸运的是，__metaclass__ 实际上可以是任何可调用的，它不需要是一个正式的类（我知道，名称中带有 'class' 的东西不需要是一个类，去看看......但它很有帮助）。

所以我们将从一个简单的例子开始，使用一个函数。

# the metaclass will automatically get passed the same argument
# that you usually pass to `type`
def upper_attr(future_class_name, future_class_parents, future_class_attrs):
    """
      Return a class object, with the list of its attribute turned
      into uppercase.
    """
    # pick up any attribute that doesn't start with '__' and uppercase it
    uppercase_attrs = {
        attr if attr.startswith("__") else attr.upper(): v
        for attr, v in future_class_attrs.items()
    }

    # let `type` do the class creation
    return type(future_class_name, future_class_parents, uppercase_attrs)

__metaclass__ = upper_attr # this will affect all classes in the module

class Foo(): # global __metaclass__ won't work with "object" though
    # but we can define __metaclass__ here instead to affect only this class
    # and this will work with "object" children
    bar = 'bip'

让我们检查：

>>> hasattr(Foo, 'bar')
False
>>> hasattr(Foo, 'BAR')
True
>>> Foo.BAR
'bip'

现在，让我们做同样的事情，但使用一个真正的类作为元类：

# remember that `type` is actually a class like `str` and `int`
# so you can inherit from it
class UpperAttrMetaclass(type):
    # __new__ is the method called before __init__
    # it's the method that creates the object and returns it
    # while __init__ just initializes the object passed as parameter
    # you rarely use __new__, except when you want to control how the object
    # is created.
    # here the created object is the class, and we want to customize it
    # so we override __new__
    # you can do some stuff in __init__ too if you wish
    # some advanced use involves overriding __call__ as well, but we won't
    # see this
    def __new__(upperattr_metaclass, future_class_name,
                future_class_parents, future_class_attrs):
        uppercase_attrs = {
            attr if attr.startswith("__") else attr.upper(): v
            for attr, v in future_class_attrs.items()
        }
        return type(future_class_name, future_class_parents, uppercase_attrs)

让我们重写上面的内容，但是现在我们知道它们的含义，使用更短和更真实的变量名称：

class UpperAttrMetaclass(type):
    def __new__(cls, clsname, bases, attrs):
        uppercase_attrs = {
            attr if attr.startswith("__") else attr.upper(): v
            for attr, v in attrs.items()
        }
        return type(clsname, bases, uppercase_attrs)

您可能已经注意到额外的参数 cls。它没有什么特别之处：__new__ 总是接收定义它的类作为第一个参数。就像您有 self 用于接收实例作为第一个参数的普通方法，或者为类方法定义类。

但这不是正确的 OOP。我们直接调用 type，而不是覆盖或调用父级的 __new__。让我们这样做：

class UpperAttrMetaclass(type):
    def __new__(cls, clsname, bases, attrs):
        uppercase_attrs = {
            attr if attr.startswith("__") else attr.upper(): v
            for attr, v in attrs.items()
        }
        return type.__new__(cls, clsname, bases, uppercase_attrs)

我们可以使用 super 使其更简洁，这将简化继承（因为是的，您可以拥有元类，从元类继承，从类型继承）：

class UpperAttrMetaclass(type):
    def __new__(cls, clsname, bases, attrs):
        uppercase_attrs = {
            attr if attr.startswith("__") else attr.upper(): v
            for attr, v in attrs.items()
        }
        return super(UpperAttrMetaclass, cls).__new__(
            cls, clsname, bases, uppercase_attrs)

哦，在 Python 3 中，如果您使用关键字参数进行此调用，如下所示：

class Foo(object, metaclass=MyMetaclass, kwarg1=value1):
    ...

它在元类中转换为 this 以使用它：

class MyMetaclass(type):
    def __new__(cls, clsname, bases, dct, kwargs1=default):
        ...

而已。元类真的没有更多的东西了。

使用元类的代码复杂背后的原因不是因为元类，而是因为您通常使用元类来做一些扭曲的事情，依赖于自省、操作继承、__dict__ 等变量等。

事实上，元类对于做黑魔法特别有用，因此也很复杂。但就其本身而言，它们很简单：

拦截类创建

修改类

返回修改后的类

为什么要使用元类类而不是函数？

既然 __metaclass__ 可以接受任何可调用的，为什么要使用一个类，因为它显然更复杂？

这样做有几个原因：

意图很明确。当你阅读 UpperAttrMetaclass(type) 时，你知道接下来会发生什么

您可以使用 OOP。元类可以继承元类，覆盖父方法。元类甚至可以使用元类。

如果您指定了元类类，则类的子类将是其元类的实例，但不使用元类函数。

您可以更好地构建代码。您永远不会将元类用于像上面的示例这样微不足道的事情。它通常用于复杂的事情。能够创建多个方法并将它们分组到一个类中对于使代码更易于阅读非常有用。

您可以挂接 __new__、__init__ 和 __call__。这将允许你做不同的事情，即使通常你可以在 __new__ 中完成所有事情，有些人只是更喜欢使用 __init__。

这些被称为元类，该死！一定是什么意思！

为什么要使用元类？

现在是个大问题。为什么要使用一些晦涩易错的功能？

好吧，通常你不会：

元类是更深层次的魔法，99% 的用户都不应该担心它。如果你想知道你是否需要它们，你就不需要（真正需要它们的人肯定知道他们需要它们，并且不需要解释为什么）。

Python 大师蒂姆·彼得斯

元类的主要用例是创建 API。一个典型的例子是 Django ORM。它允许您定义如下内容：

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

但如果你这样做：

person = Person(name='bob', age='35')
print(person.age)

它不会返回 IntegerField 对象。它将返回一个 int，甚至可以直接从数据库中获取。

这是可能的，因为 models.Model 定义了 __metaclass__，并且它使用了一些魔法，将您刚刚使用简单语句定义的 Person 变成了数据库字段的复杂挂钩。

Django 通过公开一个简单的 API 并使用元类，从这个 API 重新创建代码来完成幕后的真正工作，让复杂的事情看起来很简单。

最后一个字

首先，您知道类是可以创建实例的对象。

好吧，事实上，类本身就是实例。元类。

>>> class Foo(object): pass
>>> id(Foo)
142630324

Python 中的一切都是对象，它们要么是类的实例，要么是元类的实例。

type 除外。

type 实际上是它自己的元类。这不是您可以在纯 Python 中重现的东西，而是通过在实现级别上作弊来完成的。

其次，元类很复杂。您可能不想将它们用于非常简单的类更改。您可以使用两种不同的技术更改类：

猴子补丁

类装饰器

99% 的时间你需要改变班级，你最好使用这些。

但是 98% 的情况下，您根本不需要更改班级。

---

元类是类的类。类定义类的实例（即对象）的行为方式，而元类定义类的行为方式。类是元类的一个实例。

虽然在 Python 中您可以对元类使用任意可调用对象（如 Jerub 所示），但更好的方法是使其本身成为实际类。 type 是 Python 中常用的元类。 type 本身就是一个类，它是它自己的类型。您将无法纯粹在 Python 中重新创建类似 type 的内容，但 Python 会作弊。要在 Python 中创建自己的元类，您真的只想继承 type。

元类最常用作类工厂。当您通过调用类创建对象时，Python 通过调用元类创建一个新类（当它执行“类”语句时）。结合普通的 __init__ 和 __new__ 方法，元类因此允许您在创建类时做“额外的事情”，例如使用某个注册表注册新类或完全用其他东西替换该类。

执行 class 语句时，Python 首先将 class 语句的主体作为普通代码块执行。生成的命名空间（一个字典）保存了类的属性。元类是通过查看待成为类的基类（继承了元类）、待成为类的 __metaclass__ 属性（如果有）或 __metaclass__ 全局变量来确定的。然后使用类的名称、基类和属性调用元类以实例化它。

然而，元类实际上定义了一个类的type，而不仅仅是它的工厂，所以你可以用它们做更多的事情。例如，您可以在元类上定义普通方法。这些元类方法类似于类方法，因为它们可以在没有实例的类上调用，但它们也不像类方法，因为它们不能在类的实例上调用。 type.__subclasses__() 是 type 元类上的方法示例。您还可以定义普通的“魔术”方法，例如 __add__、__iter__ 和 __getattr__，以实现或更改类的行为方式。

下面是一个点点滴滴的汇总示例：

def make_hook(f):
    """Decorator to turn 'foo' method into '__foo__'"""
    f.is_hook = 1
    return f

class MyType(type):
    def __new__(mcls, name, bases, attrs):

        if name.startswith('None'):
            return None

        # Go over attributes and see if they should be renamed.
        newattrs = {}
        for attrname, attrvalue in attrs.iteritems():
            if getattr(attrvalue, 'is_hook', 0):
                newattrs['__%s__' % attrname] = attrvalue
            else:
                newattrs[attrname] = attrvalue

        return super(MyType, mcls).__new__(mcls, name, bases, newattrs)

    def __init__(self, name, bases, attrs):
        super(MyType, self).__init__(name, bases, attrs)

        # classregistry.register(self, self.interfaces)
        print "Would register class %s now." % self

    def __add__(self, other):
        class AutoClass(self, other):
            pass
        return AutoClass
        # Alternatively, to autogenerate the classname as well as the class:
        # return type(self.__name__ + other.__name__, (self, other), {})

    def unregister(self):
        # classregistry.unregister(self)
        print "Would unregister class %s now." % self

class MyObject:
    __metaclass__ = MyType


class NoneSample(MyObject):
    pass

# Will print "NoneType None"
print type(NoneSample), repr(NoneSample)

class Example(MyObject):
    def __init__(self, value):
        self.value = value
    @make_hook
    def add(self, other):
        return self.__class__(self.value + other.value)

# Will unregister the class
Example.unregister()

inst = Example(10)
# Will fail with an AttributeError
#inst.unregister()

print inst + inst
class Sibling(MyObject):
    pass

ExampleSibling = Example + Sibling
# ExampleSibling is now a subclass of both Example and Sibling (with no
# content of its own) although it will believe it's called 'AutoClass'
print ExampleSibling
print ExampleSibling.__mro__

---

请注意，此答案适用于 Python 2.x，因为它是在 2008 年编写的，元类在 3.x 中略有不同。

元类是让“类”发挥作用的秘诀。新样式对象的默认元类称为“类型”。

class type(object)
  |  type(object) -> the object's type
  |  type(name, bases, dict) -> a new type

元类需要 3 个参数。 'name'、'bases' 和 'dict'

这里是秘密开始的地方。在这个示例类定义中查找名称、基数和字典的来源。

class ThisIsTheName(Bases, Are, Here):
    All_the_code_here
    def doesIs(create, a):
        dict

让我们定义一个元类来演示“类：”如何调用它。

def test_metaclass(name, bases, dict):
    print 'The Class Name is', name
    print 'The Class Bases are', bases
    print 'The dict has', len(dict), 'elems, the keys are', dict.keys()

    return "yellow"

class TestName(object, None, int, 1):
    __metaclass__ = test_metaclass
    foo = 1
    def baz(self, arr):
        pass

print 'TestName = ', repr(TestName)

# output => 
The Class Name is TestName
The Class Bases are (<type 'object'>, None, <type 'int'>, 1)
The dict has 4 elems, the keys are ['baz', '__module__', 'foo', '__metaclass__']
TestName =  'yellow'

现在，一个真正有意义的例子，这将自动使列表中的变量“属性”设置在类上，并设置为无。

def init_attributes(name, bases, dict):
    if 'attributes' in dict:
        for attr in dict['attributes']:
            dict[attr] = None

    return type(name, bases, dict)

class Initialised(object):
    __metaclass__ = init_attributes
    attributes = ['foo', 'bar', 'baz']

print 'foo =>', Initialised.foo
# output=>
foo => None

请注意，Initialised 通过元类 init_attributes 获得的神奇行为不会传递给 Initialised 的子类。

这是一个更具体的示例，展示了如何将“类型”子类化以创建一个在创建类时执行操作的元类。这很棘手：

class MetaSingleton(type):
    instance = None
    def __call__(cls, *args, **kw):
        if cls.instance is None:
            cls.instance = super(MetaSingleton, cls).__call__(*args, **kw)
        return cls.instance

class Foo(object):
    __metaclass__ = MetaSingleton

a = Foo()
b = Foo()
assert a is b

---

其他人已经解释了元类如何工作以及它们如何适应 Python 类型系统。这是它们可以用于什么的示例。在我编写的测试框架中，我想跟踪定义类的顺序，以便以后可以按此顺序实例化它们。我发现使用元类最容易做到这一点。

class MyMeta(type):

    counter = 0

    def __init__(cls, name, bases, dic):
        type.__init__(cls, name, bases, dic)
        cls._order = MyMeta.counter
        MyMeta.counter += 1

class MyType(object):              # Python 2
    __metaclass__ = MyMeta

class MyType(metaclass=MyMeta):    # Python 3
    pass

任何属于 MyType 子类的东西都会获得一个类属性 _order，该属性记录了定义类的顺序。

---

元类的一种用途是自动向实例添加新属性和方法。

例如，如果您查看 Django models，它们的定义看起来有点混乱。看起来好像您只定义类属性：

class Person(models.Model):
    first_name = models.CharField(max_length=30)
    last_name = models.CharField(max_length=30)

然而，在运行时，Person 对象充满了各种有用的方法。请参阅 source 了解一些惊人的元分类。

---

我认为 ONLamp 对元类编程的介绍写得很好，尽管已经有好几年了，但它对这个主题给出了很好的介绍。

http://www.onlamp.com/pub/a/python/2003/04/17/metaclasses.html（存档于 https://web.archive.org/web/20080206005253/http://www.onlamp.com/pub/a/python/2003/04/17/metaclasses.html）

简而言之：类是创建实例的蓝图，元类是创建类的蓝图。很容易看出，在 Python 中，类也需要是一流的对象才能启用此行为。

我自己从来没有写过，但我认为元类最好的用法之一可以在 Django framework 中看到。模型类使用元类方法来启用编写新模型或表单类的声明式风格。当元类创建类时，所有成员都可以自定义类本身。

创建新模型

启用此功能的元类

剩下要说的是：如果你不知道元类是什么，那么你不需要它们的概率是 99%。

---

什么是元类？你用它们做什么？

TLDR：元类实例化并定义类的行为，就像类实例化并定义实例的行为一样。

伪代码：

>>> Class(...)
instance

上面应该看起来很熟悉。那么，Class 来自哪里？它是元类的一个实例（也是伪代码）：

>>> Metaclass(...)
Class

在实际代码中，我们可以传递默认元类 type，以及实例化类所需的一切，然后我们得到一个类：

>>> type('Foo', (object,), {}) # requires a name, bases, and a namespace
<class '__main__.Foo'>

换个说法

类之于实例就像元类之于类。当我们实例化一个对象时，我们得到一个实例： >>> object() # 类的实例化