Python中的元类

如何理解Python中的元类

元类是类的类。就像类定义了类的实例的行为一样，元类定义了类的行为方式。类是元类的实例。

虽然在Python中你可以为元类使用任意的callables（比如Jerub节目），实际上更有用的方法是使它成为一个真正的类本身。type是Python中常用的元类。如果你想知道，是的，type它本身就是一个类，它是它自己的类型。你将无法type在Python中重新创建纯粹的东西，但是Python会有所作为。要在Python中创建自己的元类，你真的只想要子类type。

元类最常用作类工厂。就像你通过调用类来创建类的实例一样，Python通过调用元类来创建一个新类（当它执行'class'语句时）。结合法线__init__和__new__方法，元类因此允许您在创建类时执行“额外的事情”，例如使用某个注册表注册新类，或者甚至完全用其他内容替换类。

当class被执行的语句，Python的首先执行的主体class声明为代码的正常块。生成的命名空间（dict）保存了将要进行的类的属性。元类是通过查看待定类的基类（继承的元类），__metaclass__将要在类的属性（如果有）或__metaclass__全局变量来确定的。然后使用类的名称，基数和属性调用元类来实例化它。

但是，元类实际上定义了类的类型，而不仅仅是它的工厂，所以你可以用它们做更多的事情。例如，您可以在元类上定义常规方法。这些元类方法类似于类方法，因为它们可以在没有实例的类上调用，但它们也不像类方法，因为它们不能在类的实例上调用。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中的类。Python对Smalltalk语言借用的类有一个非常奇特的想法。

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

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

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

但是类比Python更多。类也是对象。

是的，对象。

一旦使用关键字class，Python就会执行它并创建一个OBJECT。指示

>>> 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 of the class,
     tuple of the parent class (for inheritance, can be empty),
     dictionary containing attributes names and values)

例如：

>>> 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执行以下操作：

有__metaclass__属性Foo吗？

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

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

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

这里要小心，__metaclass__不会继承属性，parent（Bar.__class__）的元类将是。如果Bar使用了使用（而不是）__metaclass__创建的属性，则子类将不会继承该行为。Bartype()type.__new__()

现在最大的问题是，你能投入__metaclass__什么？

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

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

Python中的元类3

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

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

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

然而，元类的行为基本保持不变。

自定义元类

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

您通常对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_attr):
    """
      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_attr = {}
    for name, val in future_class_attr.items():
        if not name.startswith('__'):
            uppercase_attr[name.upper()] = val
        else:
            uppercase_attr[name] = val

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

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

print(hasattr(Foo, 'bar'))
# Out: False
print(hasattr(Foo, 'BAR'))
# Out: True

f = Foo()
print(f.BAR)
# Out: '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_attr):

        uppercase_attr = {}
        for name, val in future_class_attr.items():
            if not name.startswith('__'):
                uppercase_attr[name.upper()] = val
            else:
                uppercase_attr[name] = val

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

        uppercase_attr = {}
        for name, val in future_class_attr.items():
            if not name.startswith('__'):
                uppercase_attr[name.upper()] = val
            else:
                uppercase_attr[name] = val

        # reuse the type.__new__ method
        # this is basic OOP, nothing magic in there
        return type.__new__(upperattr_metaclass, future_class_name,
                            future_class_parents, uppercase_attr)

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

当然，为了清楚起见，我在这里使用的名称很长，但同样self，所有的参数都有传统的名称。所以真正的生产元类看起来像这样：

class UpperAttrMetaclass(type):

    def __new__(cls, clsname, bases, dct):

        uppercase_attr = {}
        for name, val in dct.items():
            if not name.startswith('__'):
                uppercase_attr[name.upper()] = val
            else:
                uppercase_attr[name] = val

        return type.__new__(cls, clsname, bases, uppercase_attr)

我们可以通过使用来使它变得更干净super，这将简化继承（因为是的，你可以有元类，继承自元类，继承自类型）：

class UpperAttrMetaclass(type):

    def __new__(cls, clsname, bases, dct):

        uppercase_attr = {}
        for name, val in dct.items():
            if not name.startswith('__'):
                uppercase_attr[name.upper()] = val
            else:
                uppercase_attr[name] = val

        return super(UpperAttrMetaclass, cls).__new__(cls, clsname, bases, uppercase_attr)

而已。实际上没有关于元类的更多信息。

使用元类的代码复杂性背后的原因不是因为元类，而是因为你通常使用元类来依赖于内省，操纵继承，变量__dict__等等来做扭曲的东西。

实际上，元类特别适用于制作黑魔法，因此也很复杂。但它们本身很简单：

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

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

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

有几个原因可以这样做：

目的很明确。当你阅读时UpperAttrMetaclass(type)，你知道会发生什么
你可以使用OOP。Metaclass可以从元类继承，覆盖父方法。元类甚至可以使用元类。
如果指定了元类，但没有使用元类函数，则类的子类将是其元类的实例。
您可以更好地构建代码。你从不使用元类来处理像上面例子那样简单的事情。它通常用于复杂的事情。能够制作多个方法并将它们组合在一个类中对于使代码更易于阅读非常有用。
你可以挂钩__new__，__init__和__call__。这将允许你做不同的东西。即使通常你可以做到这一切__new__，有些人只是更舒服使用__init__。
这些被称为元类，该死的！它必须意味着什么！

你为什么要使用元类？

现在是个大问题。为什么要使用一些不起眼的容易出错的功能？

好吧，通常你不会：

元类是更深刻的魔力，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您刚刚使用简单语句定义的内容转换为数据库字段的复杂钩子。

Django通过公开一个简单的API并使用元类，从这个API重新创建代码来完成幕后的实际工作，从而使复杂的外观变得简单。

最后

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

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

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

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

除了type。

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