【Python入门】17.面向对象编程之 元类metaclass & ORM框架编写

笔记更新于2019年12月2日,
摘要:type的另一功能;__new__( )方法;元类;metaclass属性;ORM典例


*写在前面:为了更好的学习python,博主记录下自己的学习路程。本学习笔记基于廖雪峰的Python教程,如有侵权,请告知删除。欢迎与博主一起学习Pythonヽ( ̄▽ ̄)ノ *


目录

面向对象编程
type( )
new( )
元类
metaclass属性
ORM典例

面向对象编程

在介绍元类之前,我们先深入了解一下type( )和__new__( ),这对后面的介绍十分关键。
type( )
--
在获取对象信息那一节中,我们知道type( )函数可以知道对象的类型。

print(type(123))
<class 'int'> 
print(type('123'))
<class 'str'> 

我们已经十分了解这一功能,那么为什么还要介绍它呢,因为它还有另一个完全不一样的更强大的功能!!!∑(゚Д゚ノ)ノ

type( )函数可以创建一个新的类。它依次传入三个参数:

1.一个字符串,表示类名;
2.一个tuple,表示继承的父类集合,可为空;
3.一个dict,表示属性或方法,包括名称和值,可为空。

举个例子:

def fn(self):                                         # 先定义一个函数作为方法
    print('Hello, %s' % self.name)

A = type('A', (object,), {'name' : 'a', 'say' : fn})  
# 创建了一个名字为A,继承object类,有name属性并且值为a, 把函数fn作为say方法

这里需要注意的是传入tuple时,如果只有一个参数,那么记得在后面加逗号。执行结果:

>>>a=A()
>>>a.say()
Hello, a 

上面创建A类的代码与下面等价:

class A(object):
    name = 'a'
    def say(self):
        print('Hello, %s' % self.name)

__new__( )

__new__( )方法的用途是创建一个类,但它不能像type( )那样单独使用,它接收四个参数,然后返回一个新类。需要依次传入的四个参数是:

1.当前要创建新类的对象,cls
2.创建的新类名,name
3.新类继承的父类的集合,bases
4.新类的属性或方法, attrs

可以发现,传入的最后三个参数和type需要的参数是一样的。你可能会困惑,那第一个参数是什么?什么是创建新类的对象?答案就是元类。

元类

我们都知道,实例对象是根据类来创建的,那这些类(对象)就是根据元类来创建的。

我们可以直接通过__class__属性来得知一个对象的类型,如:

>>>'aa'.__class__
<class 'str'>

>>>x = 123
>>>x.__class__
<class 'int'> 

>>>class A(object):
...    pass
>>>a=A()
>>>a.__class__
<class '__main__.A'> 

那么对于一个__class__的__class__属性又是什么呢?

>>>'aa'.__class__.__class__
<class 'type'> 
>>>x.__class__.__class__
<class 'type'> 
>>>a.__class__.__class__
<class 'type'> 

答案是type。实际上type就是一个元类,是Python在背后用来创建所有类的元类。那么能不能自己创建一个像type这样的一个元类呢?当然是可以的。但是一般情况下都去自己创建元类,因为多数情况下是用不到的,下面的内容将介绍如何创建一个元类,并且举了ORM的例子,内容会有点复杂。

__metaclass__属性

在定义一个类的时候,如果加入了__metaclass__属性,那么将会使用指定的元类来创建该类,像这样:

class A(object):
    __metaclass__ = BMetaclass

或者这样:

class A(object, metaclass = BMetaclass):
    pass

如果这样写的话,那么A就会根据元类BMetaclass来创建,一般而言,metaclass的类名总是以Metaclass结尾,表明这是一个metaclass。接下来就需要定义元类BMetaclass。

需要注意的是元类B需要继承type(这是因为万物皆对象,而type是创建对象的源头)

class BMetaclass(type):
    def __new__(cls, name, bases, attrs):
        return type.__new__(cls, name, bases, attrs)

上面是定义一个元类的框架,需要注意以下几点:

1.元类BMetaclass必须继承type(这是因为万物皆对象,而type是创建对象的源头);
2.需要添加__new__( )方法
3.__new__( )方法返回的是一个类,由type.__new__( )生成

接下来就是往中间添加代码来定义创建的元类了。如在廖雪峰的官方网站中,创建了一个可以调用add的list类。

class ListMetaclass(type):
    def __new__(cls, name, bases, attrs):
        attrs['add'] = lambda self, value: self.append(value)
        return type.__new__(cls, name, bases, attrs)
>>> L = MyList()
>>> L.add(1)
>> L
[1]

实际上,在敲下了类似class A(object)的代码后,Python执行了以下的操作:

第一步:检查A类里面有没有__metaclass__属性,如果有,则按照metaclass来创建类对象,若没有执行下一步;

第二步:检查A的父类有没有__metaclass__属性,如果有,则按照metaclass来创建类对象,若没有执行下一步;

第三步:检查模块层次中有没有__metaclass__属性,如果有,则按照metaclass来创建类对象,若没有执行下一步;

第四步:用内置的type来创建类对象。

可见如果把__metaclass__属性放置在模块层次,那么所有的类都会根据__metaclass__属性来创建,若只是放在某一类的内部,则只针对该类。

ORM典例

(前方高能!)
(以下内容转自廖雪峰的官方网站,博主看了一遍,大概明白其中的原理。在后面还会用到的时候会回来巩固的 ̄▽ ̄)

ORM全称“Object Relational Mapping”,即对象-关系映射,就是把关系数据库的一行映射为一个对象,也就是一个类对应一个表,这样,写代码更简单,不用直接操作SQL语句。

要编写一个ORM框架,所有的类都只能动态定义,因为只有使用者才能根据表的结构定义出对应的类来。

让我们来尝试编写一个ORM框架。

编写底层模块的第一步,就是先把调用接口写出来。比如,使用者如果使用这个ORM框架,想定义一个User类来操作对应的数据库表User,我们期待他写出这样的代码:

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

其中,父类Model和属性类型StringField、IntegerField是由ORM框架提供的,剩下的魔术方法比如save()全部由metaclass自动完成。虽然metaclass的编写会比较复杂,但ORM的使用者用起来却异常简单。

现在,我们就按上面的接口来实现该ORM。

首先来定义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)

在Field的基础上,进一步定义各种类型的Field,比如StringField,IntegerField等等:

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

下一步,就是编写最复杂的ModelMetaclass了:

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)

以及基类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__.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)时,Python解释器首先在当前类User的定义中查找metaclass,如果没有找到,就继续在父类Model中查找metaclass,找到了,就使用Model中定义的metaclass的ModelMetaclass来创建User类,也就是说,metaclass可以隐式地继承到子类,但子类自己却感觉不到。

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

排除掉对Model类的修改;

在当前类(比如User)中查找定义的类的所有属性,如果找到一个Field属性,就把它保存到一个mappings的dict中,同时从类属性中删除该Field属性,否则,容易造成运行时错误(实例的属性会遮盖类的同名属性);

把表名保存到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语句,就可以完成真正的功能。


以上就是本节的全部内容,感谢你的阅读。

下一节内容:18.错误处理

有任何问题与想法,欢迎评论与吐槽。

和博主一起学习Python吧( ̄▽ ̄)~*

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容

  • 1. 使用__slots__ 正常情况下,当我们定义了一个class,创建了一个class的实例后,我们可以给该实...
    时间之友阅读 292评论 0 1
  • 什么是元类? 理解元类(metaclass)之前,我们先了解下Python中的OOP和类(Class) 面向对象全...
    时间之友阅读 324评论 0 0
  • 我还记得去年跨年给你打电话你在酒吧嗨 结果16年你就戒吧了 今年你在ktv嗨还是没和我一起 好可惜 明年争取一起跨...
    uloveu阅读 122评论 0 0
  • 据说80%的人都有拖延症,其实数据错了,至少99%的人都有拖延症。回想一下,你有没有被老师催过作业,有没有被领导催...
    汾阳盛世阅读 274评论 0 0
  • 我们买房投资的过程,说它简单吧其实也有点复杂,说它复杂吧其实也简单。今天我要在这里说到的细节,不是指怎么签协...
    爱书狂鸦阅读 217评论 1 1