Python 元类探究

python语言中关于元类是高级的topic, 查阅了廖雪峰Python教程, StackOverflowPEP3115相关文档后,一个简单的总结。

1 Python类和对象

metaclassclassinstance之间的关系可以用下图来表示

类定义了对象有哪些行为,而元类也定义了类有哪些行为。在python中创建一个类的声明 为

class Foo(*bases, **kws):
    pass
class Foo(base1, base1, metaclass=mymeta):
    pass

使用了metaclass关键字,而mymeta控制类创建的过程,每一个可调用的对象都可以成为元类。

2 type关键字

python中每一个都是对象,数字为对象,字符串为对象,实例是对象,上述集成体系中可以知道,类也是对象,在python中使用type可以查阅每个对象所属的类别。

>>> type(1)
>>> 'int'
>>> type('abc')
>>> 'str'
>>> foo = Foo()
>>> type(foo)
>>> '__main__.Foo'
>>> type(Foo)
>>> 'type'

同样使用每个对象的__class__属性可以查看该对象所属的类别,从上述中可以查看,每个自定类的都是type类的实例。因此python除了使用class关键字定义类之外,还可以使用type关键词来创建类

type(name_of_class, 
     tuple_of_parent_class (for inheritance, can be empty), 
     dictionary_containing_attributes_names_and_values)

因此创建Foo类可以采取type方式。

>>>def bar():
>>>    print('bar')
>>>Foo = type('Foo', (object,), dict(bar=bar))
>>>Foo.bar()
>>>bar

由此可以知道在python中当我们使用class关键词创建类的时候,最后都会转换为上述中的type语句。

3 metaclass控制类生成

如果在class创建类的过程中指定了metaclass关键字参数,那么该值将会拦截该类生成的过程。

3.1 函数形式

创建一个metaclass函数,作为将类的所有属性都改写成大写。

def upper_attr(cls_name, cls_parents, cls_attrs):
    atts = ((name, value) for name, value in cls_attrs.items() if not name.startswith('__')))
    uppercase_attrs =  dict((name.upper(), value) for name, value in attrs)
    return type(cls_name, cls_parents, uppercase_attrs)
class Foo(object, metaclass=upper_attr):
    bar='pip'
print(hasattr(Foo, 'bar'))
>>> False
print(hasattr(Foo, 'BAR'))
>>> True

3.2 使用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 type.__new__(cls, name, bases, uppercase_attr)
class Foo(object, metaclass=UpperAttrMetaclass):
    bar='pip'
print(hasattr(Foo, 'bar'))
>>> False
print(hasattr(Foo, 'BAR'))
>>> True

4 元类使用

4.1 单例模式

每个类在创建对象的时候,都使用(*args, **kw),只要在type中定义__call__方法即可。

class Singleton(type):
    def __init__(self, *args, **kw):
        self.__instance = None
        super().__init__(*args, **kw)
    
    def __call__(self, *args, **kw):
        if self.__instance is None:
            self.__instance = super().__call__(*args, **kw)
            return self.__instance
        else:
            return self.__instance
class Spam(metaclass=Singleton):
    def __init__(self):
        print('Creating Spam')

4.2 ORM框架

python 中的ORM框架中使用了大量的元类

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

class ModelMetaclass(type):
    def __new__(cls, name, bases, attrs):
        if name=='Model':
            return type.__new__(cls, name, bases, attrs)
        print('Found model: %s' % name)
        mappings = dict()
        for k, v in attrs.items():
            if isinstance(v, Field):
                print('Found mapping: %s ==> %s' % (k, v))
                mappings[k] = v
        for k in mappings.keys():
            attrs.pop(k)
        attrs['__mappings__'] = mappings # 保存属性和列的映射关系
        attrs['__table__'] = name # 假设表名和类名一致
        return type.__new__(cls, name, bases, attrs)
        
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__.items():
            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)) 
        
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()
Comments
Write a Comment