python元类的应用

·  阅读 22

看backtrader时看到其中有with_metaclass这样的代码。这个元类之前有看到,但没怎么理解过。在网上找了一些相应的文章帮助理解。

  • 参考文档:

lotabout.me/2018/Unders…

type(name, bases, attrs)
复制代码

参数:

  • name:Class名称,字符串类型,存放新类的名字
  • bases:父类的元组类型,指定类的基类/父类(对于继承,可以为空)
  • attrs:包含属性名称和值的字典,存放该类的所有属性(attributes)和方法(method)
MyShinyClass = type('MyShinyClass', (), {}) # 返回一个类对象
复制代码

例如下面的类:

class Base:
    counter = 10
​
class Derived(Base):
    def get_counter(self):
        return self.counter
​
x = Derived()
x.get_counter()
#> 10
复制代码

我们可以调用 type(...) 来动态创建这两个类:

Base = type('Base', (), {'counter': 10})
Derived = type('Derived', (Base,), dict(get_counter=lambda self: self.counter))
​
x = Derived()
x.get_counter()
#> 10
复制代码

要创建一个class对象,type()函数依次传入3个参数:

  1. class的名称;
  2. 继承的父类集合,注意Python支持多重继承,如果只有一个父类,别忘了tuple的单元素写法;
  3. class的方法名称与函数绑定,这里我们把函数fn绑定到方法名hello上。

通过type()函数创建的类和直接写class是完全一样的,因为Python解释器遇到class定义时,仅仅是扫描一下class定义的语法,然后调用type()函数创建出class。

正常情况下,我们都用class Xxx...来定义类,但是,type()函数也允许我们动态创建出类来,也就是说,动态语言本身支持运行期动态创建类,这和静态语言有非常大的不同,要在静态语言运行期创建类,必须构造源代码字符串再调用编译器,或者借助一些工具生成字节码实现,本质上都是动态编译,会非常复杂。

metaclass

除了使用type()动态创建类以外,要控制类的创建行为,还可以使用metaclass。

metaclass,直译为元类,简单的解释就是:

当我们定义了类以后,就可以根据这个类创建出实例,所以:先定义类,然后创建实例。

但是如果我们想创建出类呢?那就必须根据metaclass创建出类,所以:先定义metaclass,然后创建类。

连接起来就是:先定义metaclass,就可以创建类,最后创建实例。

所以,metaclass允许你创建类或者修改类。换句话说,你可以把类看成是metaclass创建出来的“实例”。

metaclass是Python面向对象里最难理解,也是最难使用的魔术代码。正常情况下,你不会碰到需要使用metaclass的情况,所以,以下内容看不懂也没关系,因为基本上你不会用到。

元类的应用:

强制子类实现特定方法

假设你是一个库的作者,例如下面的代码,其中的方法 foo 要求子类实现方法 bar

# library code
class Base(object):
    def foo(self):
        return self.bar()
​
# user code
class Derived(Base):
    def bar():
        return None
复制代码

但作为库的作者,我们根本无法预测用户会写出什么样的代码,有什么方法能强制用户在子类中实现方法 bar 呢?用 meta-class 可以做到。

class Meta(type):
    def __new__(cls, name, bases, namespace, **kwargs):
        if name != 'Base' and 'bar' not in namespace:
            raise TypeError('bad user class')
        return super().__new__(cls, name, bases, namespace, **kwargs)
​
class Base(object, metaclass=Meta):
    def foo(self):
        return self.bar()
复制代码

现在,我们尝试定义一个不包含 bar 方法的子类,在类的定义(或者说生成)阶段就会报错:

>>> class Derived(Base):
...     pass
...
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 4, in __new__
TypeError: bad user class
复制代码

注册所有子类

有时我们会希望获取继承了某个类的子类,例如,实现了基类 Fruit,想知道都有哪些子类继承了它,用元类就能实现这个功能:

class Meta(type):
    def __init__(cls, name, bases, namespace, **kwargs):
        super().__init__(name, bases, namespace, **kwargs)
        if not hasattr(cls, 'registory'):
            # this is the base class
            cls.registory = {}
        else:
            # this is the subclass
            cls.registory[name.lower()] = cls
​
class Fruit(object, metaclass=Meta):
    pass
​
class Apple(Fruit):
    pass
​
class Orange(Fruit):
    pass
复制代码

之后,我们可以查看所有 Fruit 的子类:

>>> Fruit.registory
{'apple': <class '__main__.Apple'>, 'orange': <class '__main__.Orange'>}
复制代码

一个事例说明了元编程的用意:修改普通类的成员:www.liaoxuefeng.com/wiki/101695…

class Field:
    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__(mcs, name, bases, attrs):
        if name == 'Model':
            return type.__new__(mcs, name, bases, attrs)
        print("Found Model: %s" % name)
        mapping = dict()
        fields = list()
        # 将属性保存到mapping中
        for k, v in attrs.items():
            if isinstance(v, Field):
                print('Found mapping : %s ==> %s' % (k, v))
                mapping[k] = v
                fields.append(k)
        # 将Model中的Field删除
        for k in mapping.keys():
            attrs.pop(k)
​
        attrs['__fields__'] = list(map(lambda f: '`%s`' % f, fields))
        attrs['__mapping__'] = mapping
        attrs['__table__'] = name
        return type.__new__(mcs, name, bases, attrs)
​
​
class Model(dict, metaclass=ModelMetaclass):
    def __init__(self, **kwargs):
        super(Model, self).__init__(kwargs)
​
    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.__mapping__.items():
            print("%s------%s" % (k, v))
            fields.append(v.name)
            params.append('?')
            args.append(getattr(self, k, None))
​
        sql = 'insert into %s (%s) values (%s)' % (self.__table__, ','.join(self.__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()
复制代码

当用户定义一个class User(Model)时,Python解释器首先在当前类User的定义中查找metaclass,如果没有找到,就继续在父类Model中查找metaclass,找到了,就使用Model中定义的metaclassModelMetaclass来创建User类,也就是说,metaclass可以隐式地继承到子类,但子类自己却感觉不到。

ModelMetaclass中,一共做了几件事情:

  1. 排除掉对Model类的修改;
  2. 在当前类(比如User)中查找定义的类的所有属性,如果找到一个Field属性,就把它保存到一个__mappings__的dict中,同时从类属性中删除该Field属性,否则,容易造成运行时错误(实例的属性会遮盖类的同名属性);
  3. 把表名保存到__table__中,这里简化为表名默认为类名。

Model类中,就可以定义各种操作数据库的方法,比如save()delete()find()update等等。

我们实现了save()方法,把一个实例保存到数据库中。因为有表名,属性到字段的映射和属性值的集合,就可以构造出INSERT语句。

编写代码试试:

u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
u.save()
复制代码

输出如下:

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

可以看到,save()方法已经打印出了可执行的SQL语句,以及参数列表,只需要真正连接到数据库,执行该SQL语句,就可以完成真正的功能。

不到100行代码,我们就通过metaclass实现了一个精简的ORM框架,是不是非常简单?

\

分类:
后端
标签:
分类:
后端
标签:
收藏成功!
已添加到「」, 点击更改