深入理解Python中的元类(metaclass)以及元类实现单例模式

时间 2019-12-06

标签深入理解 python metaclass 以及实现模式栏目 Python 繁體版

原文原文链接

在看一些框架源代码的过程当中碰到不少元类的实例，看起来很吃力很晦涩；在看python cookbook中关于元类建立单例模式的那一节有些疑惑。所以花了几天时间研究下元类这个概念。经过学习元类，我对python的面向对象有了更加深刻的了解。这里将一篇写的很是好的文章基本照搬过来吧，这是一篇在Stack overflow上很热的帖子，我看http://blog.jobbole.com/21351/这篇博客对其进行了翻译。python

1、理解类也是对象

在理解元类以前，你须要先掌握Python中的类。Python中类的概念借鉴于Smalltalk，这显得有些奇特。在大多数编程语言中，类就是一组用来描述如何生成一个对象的代码段。在Python中这一点仍然成立：sql

class ObjectCreator(object):
    pass

my_object = ObjectCreator()
print my_object
#输出：<__main__.ObjectCreator object at 0x8974f2c>

可是，Python中的类还远不止如此。类一样也是一种对象。只要你使用关键字class，Python解释器在执行的时候就会建立一个对象。下面的代码段：数据库

class ObjectCreator(object):
     pass

将在内存中建立一个对象，名字就是ObjectCreator。这个对象（类）自身拥有建立对象（类实例）的能力，而这就是为何它是一个类的缘由。可是，它的本质仍然是一个对象，因而你能够对它作以下的操做：
你能够将它赋值给一个变量，你能够拷贝它，你能够为它增长属性，你能够将它做为函数参数进行传递。编程

下面是示例：app

print ObjectCreator     # 你能够打印一个类，由于它其实也是一个对象
#输出：<class '__main__.ObjectCreator'>

Idef echo(o):
     print o

echo(ObjectCreator)                 # 你能够将类作为参数传给函数
#输出：<class '__main__.ObjectCreator'>
print hasattr(ObjectCreator, 'new_attribute')
#输出：False

ObjectCreator.new_attribute = 'foo' #  你能够为类增长属性
print hasattr(ObjectCreator, 'new_attribute')
#输出：True
print ObjectCreator.new_attribute
#输出：foo

ObjectCreatorMirror = ObjectCreator # 你能够将类赋值给一个变量
print ObjectCreatorMirror()
#输出：<__main__.ObjectCreator object at 0x108551310>

2、动态地建立类

一、经过return class动态的构建须要的类框架

由于类也是对象，你能够在运行时动态的建立它们，就像其余任何对象同样。首先，你能够在函数中建立类，使用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              # 函数返回的是类，不是类的实例
#输出：<class '__main__.Foo'>

print MyClass()            # 你能够经过这个类建立类实例，也就是对象
#输出：<__main__.Foo object at 0x1085ed950

二、经过type函数构造类ide

但这还不够动态，由于你仍然须要本身编写整个类的代码。因为类也是对象，因此它们必须是经过什么东西来生成的才对。当你使用class关键字时，Python解释器自动建立这个对象。但就和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(类名, 父类的元组（针对继承的状况，能够为空），包含属性的字典（名称和值）)

好比下面的代码：

class MyShinyClass(object):
    pass

能够手动经过type建立，其实

MyShinyClass = type('MyShinyClass', (), {})  # 返回一个类对象
print MyShinyClass
#输出：<class '__main__.MyShinyClass'>
print MyShinyClass()  #  建立一个该类的实例
#输出：<__main__.MyShinyClass object at 0x1085cd810>

你会发现咱们使用“MyShinyClass”做为类名，而且也能够把它当作一个变量来做为类的引用。

接下来咱们经过一个具体的例子看看type是如何建立类的，范例：

1、构建Foo类 #构建目标代码
class Foo(object):
    bar = True
#使用type构建
Foo = type('Foo', (), {'bar':True})

2.继承Foo类 #构建目标代码：
class FooChild(Foo):
    pass
#使用type构建
FooChild = type('FooChild', (Foo,),{})

print FooChild
#输出：<class '__main__.FooChild'>
print FooChild.bar   # bar属性是由Foo继承而来
#输出：True

3.为Foochild类增长方法 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

能够看到，在Python中，类也是对象，你能够动态的建立类。这就是当咱们使用关键字class时Python在幕后作的事情，而这就是经过元类来实现的。

3、元类

一、什么是元类

经过上文的描述，咱们知道了Python中的类也是对象。元类就是用来建立这些类（对象）的，元类就是类的类，你能够这样理解为：

MyClass = MetaClass()    #元类建立
MyObject = MyClass()     #类建立实例
实际上MyClass就是经过type()来创建立出MyClass类，它是type()类的一个实例；同时MyClass自己也是类，也能够建立出本身的实例，这里就是MyObject

函数type其实是一个元类。type就是Python在背后用来建立全部类的元类。如今你想知道那为何type会所有采用小写形式而不是Type呢？好吧，我猜这是为了和str保持一致性，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__属性又是什么呢？
a.__class__.__class__
#输出：<type 'type'>
age.__class__.__class__
#输出：<type 'type'>
foo.__class__.__class__
#输出：<type 'type'>
b.__class__.__class__
#输出：<type 'type'>

所以，元类就是建立类这种对象的东西， type就是Python的内建元类，固然了，你也能够建立本身的元类。

二、__metaclass__属性

你能够在写一个类的时候为其添加__metaclass__属性,定义了__metaclass__就定义了这个类的元类。

class Foo(object):   #py2
    __metaclass__ = something…


class Foo(metaclass=something):   #py3
    __metaclass__ = something…

例如：当咱们写以下代码时 :

class Foo(Bar):
    pass

在该类并定义的时候，它尚未在内存中生成，知道它被调用。Python作了以下的操做：
1）Foo中有__metaclass__这个属性吗？若是是，Python会在内存中经过__metaclass__建立一个名字为Foo的类对象（我说的是类对象，请紧跟个人思路）。
2）若是Python没有找到__metaclass__，它会继续在父类中寻找__metaclass__属性，并尝试作和前面一样的操做。
3）若是Python在任何父类中都找不到__metaclass__，它就会在模块层次中去寻找__metaclass__，并尝试作一样的操做。
4）若是仍是找不到__metaclass__,Python就会用内置的type来建立这个类对象。

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

3、自定义元类

元类的主要目的就是为了当建立类时可以自动地改变类。一般，你会为API作这样的事情，你但愿能够建立符合当前上下文的类。假想一个很傻的例子，你决定在你的模块里全部的类的属性都应该是大写形式。有好几种方法能够办到，但其中一种就是经过设定__metaclass__。采用这种方法，这个模块中的全部类都会经过这个元类来建立，咱们只须要告诉元类把全部的属性都改为大写形式就万事大吉了。

__metaclass__实际上能够被任意调用，它并不须要是一个正式的类。因此，咱们这里就先以一个简单的函数做为例子开始。

一、使用函数当作元类

# 元类会自动将你一般传给‘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)#返回一个类

class Foo(object):
    __metaclass__ = upper_attr
    bar = 'bip'

print hasattr(Foo, 'bar')
# 输出: False
print hasattr(Foo, 'BAR')
# 输出:True
 
f = Foo()
print f.BAR
# 输出:'bip'

二、使用class来当作元类

因为__metaclass__必须返回一个类。

# 请记住，'type'其实是一个类，就像'str'和'int'同样。因此，你能够从type继承
# __new__ 是在__init__以前被调用的特殊方法，__new__是用来建立对象并返回之的方法，__new_()是一个类方法
# 而__init__只是用来将传入的参数初始化给对象，它是在对象建立以后执行的方法。
# 你不多用到__new__，除非你但愿可以控制对象的建立。这里，建立的对象是类，咱们但愿可以自定义它，因此咱们这里改写__new__
# 若是你但愿的话，你也能够在__init__中作些事情。还有一些高级的用法会涉及到改写__call__特殊方法，可是咱们这里不用，下面咱们能够单独的讨论这个使用

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)
        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编程，没什么魔法。因为type是元类也就是类，所以它自己也是经过__new__方法生成其实例，只不过这个实例是一个类.
        return type.__new__(upperattr_metaclass, future_class_name, future_class_parents, uppercase_attr)

你可能已经注意到了有个额外的参数upperattr_metaclass，这并无什么特别的。类方法的第一个参数老是表示当前的实例，就像在普通的类方法中的self参数同样。固然了，为了清晰起见，这里的名字我起的比较长。可是就像self同样，全部的参数都有它们的传统名称。所以，在真实的产品代码中一个元类应该是像这样的：

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 type.__new__(cls, name, bases, uppercase_attr)

若是使用super方法的话，咱们还可使它变得更清晰一些。

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)

4、使用原来建立ORM的实例

咱们经过建立一个相似Django中的ORM来熟悉一下元类的使用，一般元类用来建立API是很是好的选择，使用元类的编写很复杂但使用者能够很是简洁的调用API。

#咱们想建立一个相似Django的ORM，只要定义字段就能够实现对数据库表和字段的操做。
class User(Model):
    # 定义类的属性到列的映射：
    id = IntegerField('id')
    name = StringField('username')
    email = StringField('email')
    password = StringField('password')

例如：

# 建立一个实例：
u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
# 保存到数据库：
u.save()

接下来我么来实现这么个功能：

#coding:utf-8
#1、首先来定义Field类，它负责保存数据库表的字段名和字段类型：
class Field(object):
    def __init__(self, name, column_type):
        self.name = name
        self.column_type = column_type
    def __str__(self):
        return '<%s:%s>' % (self.__class__.__name__, self.name)

class StringField(Field):
    def __init__(self, name):
        super(StringField, self).__init__(name, 'varchar(100)')

class IntegerField(Field):
    def __init__(self, name):
        super(IntegerField, self).__init__(name, 'bigint')

#2、定义元类，控制Model对象的建立
class ModelMetaclass(type):
    '''定义元类'''
    def __new__(cls, name, bases, attrs):
        if name=='Model':
            return super(ModelMetaclass,cls).__new__(cls, name, bases, attrs)
        mappings = dict()
        for k, v in attrs.iteritems():
            # 保存类属性和列的映射关系到mappings字典
            if isinstance(v, Field):
                print('Found mapping: %s==>%s' % (k, v))
                mappings[k] = v
        for k in mappings.iterkeys():
            #将类属性移除，使定义的类字段不污染User类属性，只在实例中能够访问这些key
            attrs.pop(k)
        attrs['__table__'] = name.lower() # 假设表名和为类名的小写,建立类时添加一个__table__类属性
        attrs['__mappings__'] = mappings # 保存属性和列的映射关系，建立类时添加一个__mappings__类属性
        return super(ModelMetaclass,cls).__new__(cls, name, bases, attrs)

#3、编写Model基类
class Model(dict):
    __metaclass__ = ModelMetaclass

    def __init__(self, **kw):
        super(Model, self).__init__(**kw)

    def __getattr__(self, key):
        try:
            return self[key]
        except KeyError:
            raise AttributeError(r"'Model' object has no attribute '%s'" % key)

    def __setattr__(self, key, value):
        self[key] = value

    def save(self):
        fields = []
        params = []
        args = []
        for k, v in self.__mappings__.iteritems():
            fields.append(v.name)
            params.append('?')
            args.append(getattr(self, k, None))
        sql = 'insert into %s (%s) values (%s)' % (self.__table__, ','.join(fields), ','.join(params))
        print('SQL: %s' % sql)
        print('ARGS: %s' % str(args))

#最后，咱们使用定义好的ORM接口，使用起来很是的简单。
class User(Model):
    # 定义类的属性到列的映射：
    id = IntegerField('id')
    name = StringField('username')
    email = StringField('email')
    password = StringField('password')

# 建立一个实例：
u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
# 保存到数据库：
u.save()

#输出
# Found mapping: email==><StringField:email>
# Found mapping: password==><StringField:password>
# Found mapping: id==><IntegerField:id>
# Found mapping: name==><StringField:username>
# SQL: insert into User (password,email,username,id) values (?,?,?,?)
# ARGS: ['my-pwd', 'test@orm.org', 'Michael', 12345]

ORM代码

5、使用new方法和元类方式分别实现单例模式

一、__new__、__init__、__call__的介绍

在讲到使用元类建立单例模式以前，比需了解__new__这个内置方法的做用，在上面讲元类的时候咱们用到了__new__方法来实现类的建立。然而我在那以前仍是对__new__这个方法和__init__方法有必定的疑惑。所以这里花点时间对其概念作一次了解和区分。

__new__方法负责建立一个实例对象，在对象被建立的时候调用该方法它是一个类方法。__new__方法在返回一个实例以后，会自动的调用__init__方法，对实例进行初始化。若是__new__方法不返回值，或者返回的不是实例，那么它就不会自动的去调用__init__方法。

__init__ 方法负责将该实例对象进行初始化，在对象被建立以后调用该方法，在__new__方法建立出一个实例后对实例属性进行初始化。__init__方法能够没有返回值。

__call__方法其实和类的建立过程和实例化没有多大关系了，定义了__call__方法才能被使用函数的方式执行。

例如：
class A(object):
    def __call__(self):
        print "__call__ be called"

a = A()
a()
#输出
#__call__ be called

打个比方帮助理解：若是将建立实例的过程比做建一个房子。

那么class就是一个房屋的设计图，他规定了这个房子有几个房间，每一个人房间的大小朝向等。这个设计图就是累的结构
__new__就是一个房屋的框架，每一个具体的房屋都须要先搭好框架后才能进行专修，固然现有了房屋设计才能有具体的房屋框架出来。这个就是从类到类实例的建立。
__init__就是装修房子的过程，对房屋的墙面和地板等颜色材质的丰富就是它该作的事情，固然先有具体的房子框架出来才能进行装饰了。这个就是实例属性的初始化，它是在__new__出一个实例后才能初始化。
__call__就是房子的电话，有了固定电话，才能被打电话嘛（就是经过括号的方式像函数同样执行）。

#coding:utf-8
class Foo(object):
    def __new__(cls, *args, **kwargs):
        #__new__是一个类方法，在对象建立的时候调用
        print "excute __new__"
        return super(Foo,cls).__new__(cls,*args,**kwargs)


    def __init__(self,value):
        #__init__是一个实例方法，在对象建立后调用，对实例属性作初始化
        print "excute __init"
        self.value = value


f1 = Foo(1)
print f1.value
f2 = Foo(2)
print f2.value

#输出===：
excute __new__
excute __init
1
excute __new__
excute __init
2
#====能够看出new方法在init方法以前执行

子类若是重写__new__方法，通常依然要调用父类的__new__方法。

class Child(Foo):
    def __new__(cls, *args, **kwargs):        
        return suyper(Child, cls).__new__(cls, *args, **kwargs)

必须注意的是，类的__new__方法以后，必须生成本类的实例才能自动调用本类的__init__方法进行初始化，不然不会自动调用__init__.

class Foo(object):
    def __init__(self, *args, **kwargs):
        print "Foo __init__"
    def __new__(cls, *args, **kwargs):
        return object.__new__(Stranger, *args, **kwargs)

class Stranger(object):
    def __init__(self,name):
        print "class Stranger's __init__ be called"
        self.name = name

foo = Foo("test")
print type(foo) #<class '__main__.Stranger'>
print foo.name #AttributeError: 'Stranger' object has no attribute 'name'

#说明：若是new方法返回的不是本类的实例，那么本类（Foo）的init和生成的类(Stranger)的init都不会被调用

2.实现单例模式：

依照Python官方文档的说法，__new__方法主要是当你继承一些不可变的class时(好比int, str, tuple)，提供给你一个自定义这些类的实例化过程的途径。还有就是实现自定义的metaclass。接下来咱们分别经过这两种方式来实现单例模式。当初在看到cookbook中的元类来实现单例模式的时候对其至关疑惑，所以才有了上面这些对元类的总结。

简单来讲，单例模式的原理就是经过在类属性中添加一个单例断定位ins_flag，经过这个flag判断是否已经被实例化过了,若是被实例化过了就返回该实例。

1)__new__方法实现单例：

class Singleton(object):
    def __new__(cls, *args, **kwargs):
        if not hasattr(cls,"_instance"):
            cls._instance = super(Singleton, cls).__new__(cls, *args, **kwargs)
        return cls._instance


s1 = Singleton()
s2 = Singleton()

print s1 is s2

由于重写__new__方法，因此继承至Singleton的类，在不重写__new__的状况下都将是单例模式。

2）元类实现单例

当初我也很疑惑为何咱们是从写使用元类的__init__方法，而不是使用__new__方法来初为元类增长一个属性。其实我只是上面那一段关于元类中__new__方法迷惑了，它主要用于咱们须要对类的结构进行改变的时候咱们才要重写这个方法。

class Singleton(type):
    def __init__(self, *args, **kwargs):
        print "__init__"
        self.__instance = None
        super(Singleton,self).__init__(*args, **kwargs)

    def __call__(self, *args, **kwargs):
        print "__call__"
        if self.__instance is None:
            self.__instance = super(Singleton,self).__call__(*args, **kwargs)
        return self.__instance


class Foo(object):
    __metaclass__ = Singleton #在代码执行到这里的时候，元类中的__new__方法和__init__方法其实已经被执行了，而不是在Foo实例化的时候执行。且仅会执行一次。


foo1 = Foo()
foo2 = Foo()
print Foo.__dict__  #_Singleton__instance': <__main__.Foo object at 0x100c52f10> 存在一个私有属性来保存属性，而不会污染Foo类（其实仍是会污染，只是没法直接经过__instance属性访问）

print foo1 is foo2  # True

# 输出
# __init__
# __call__
# __call__
# {'__module__': '__main__', '__metaclass__': <class '__main__.Singleton'>, '_Singleton__instance': <__main__.Foo object at 0x100c52f10>, '__dict__': <attribute '__dict__' of 'Foo' objects>, '__weakref__': <attribute '__weakref__' of 'Foo' objects>, '__doc__': None}
# True

基于这个例子：

咱们知道元类(Singleton)生成的实例是一个类(Foo),而这里咱们仅仅须要对这个实例(Foo)增长一个属性(__instance)来判断和保存生成的单例。想一想也知道为一个类添加一个属性固然是在__init__中实现了。
关于__call__方法的调用，由于Foo是Singleton的一个实例。因此Foo()这样的方式就调用了Singleton的__call__方法。不明白就回头看看上一节中的__call__方法介绍。

假如咱们经过元类的__new__方法来也能够实现，但显然没有经过__init__来实现优雅，由于咱们不会为了为实例增长一个属性而重写__new__方法。因此这个形式不推荐。