Python 元类实现 ORM

仅供学习,转载请注明出处

元类实现ORM

上一篇章大概讲述了元类的概念,实现使用元类的方式修改一个类的属性大小写修改的功能。

那么下面可以更加深层次的使用方式,使用元类来实现数据库操作的ORM功能。

ORM是什么

ORM 是 python编程语言后端web框架 Django的核心思想,“Object Relational Mapping”,即对象-关系映射,简称ORM。

一个句话理解就是:创建一个实例对象,用创建它的类名当做数据表名,用创建它的类属性对应数据表的字段,当对这个实例对象操作时,能够对应MySQL语句。

示例代码如下:

demo:

class User(父类省略):
    uid = ('uid', "int unsigned")
    name = ('username', "varchar(30)")
    email = ('email', "varchar(30)")
    password = ('password', "varchar(30)")
    ...省略...


u = User(uid=12345, name='Michael', email='test@orm.org', password='my-pwd')
u.save()
# 对应如下sql语句
# insert into User (username,email,password,uid)
# values ('Michael','test@orm.org','my-pwd',12345)

说明:

  • 所谓的ORM就是让开发者在操作数据库的时候,能够像操作对象时通过xxxx.属性=yyyy一样简单,这是开发ORM的初衷。
  • 只不过ORM的实现较为复杂,Django中已经实现了 很复杂的操作,本次篇章主要通过完成一个 insert相类似的ORM,理解其中的道理就就可以了。
就只是简单一个insert么

是呀,只要能够明白了insert的ORM基本实现,其他的也是可以迅速写写。

要实现一个大功能之前,首先实现一个小功能,不要急。

定义一个User类,然后使用元类可以截取打印User类中的相关属性

# 定义元类
class ModelMetaclass(type):

    def __new__(cls,name,bases,attrs):
        print("cls=",cls)
        print("name=",name)
        print("bases=",bases)
        print("attrs=",attrs)

        return type.__new__(cls,name,bases,attrs)

# 定义User类
class User(metaclass=ModelMetaclass):
    # 定义User表的字段以及字段类型
    uid = ('uid',"int unsigned")
    name = ('username',"varchar(30)")
    email = ('email',"varchar(30)")
    password = ('password',"varchar(30)")

def main():
    u = User()

if __name__ == "__main__":
    main()

运行如下:

D:\Python37\python3.exe D:/pythonProject/test/orm.py
cls= <class '__main__.ModelMetaclass'>
name= User
bases= ()
attrs= {'__module__': '__main__', '__qualname__': 'User', 'uid': ('uid', 'int unsigned'), 'name': ('username', 'varchar(30)'), 'email': ('email', 'varchar(30)'), 'password': ('password', 'varchar(30)')}

Process finished with exit code 0

可以从运行的结果中看出,元类能够成功拦截打印将要创建的类名以及该类定义个相关属性。

类名:User
属性:{'__module__': '__main__', '__qualname__': 'User', 'uid': ('uid', 'int unsigned'), 'name': ('username', 'varchar(30)'), 'email': ('email', 'varchar(30)'), 'password': ('password', 'varchar(30)')}

ORM如果需要创建表结构的时候,就会需要相关映射关系,如下:
uid ==> ('uid', 'int unsigned')
name ==> ('username', 'varchar(30)')
email ==> ('email', 'varchar(30)')
password ==> ('password', 'varchar(30)')

那么下面来看看如何写一下这个映射关系。

编写字段映射关系

首先打印获取一下attrs属性字典的值来看看,如下:

运行如下:

好了,从结果来看,已经可以获取到User类的属性了,那么下面使用isinstance((attrs值,),tuple) 来判断是否为元组,然后将这个映射关系打印出来看看。

运行看看:

那么下面可以将这个元组内容写入一个映射字典当中,保存起来。

好了,从上面的执行中,我已经将User类的属性中的元组保存到mappings字典中。

然后将这个字典保存到元组属性中,给User类来调用,看看行不行。

执行看看:

从上面的结果来看,元类可以通过attrs该list来传递映射字典。

好了,从上面的操作来看,已经大概理解了元类如何拦截创建类的属性,并且将修改后的结果再次传递给创建类。

那么下面,我们再来看看,如果我需要插入一条用户数据。大概可以执行如下示例:
u = User(uid=12345, name='Michael', email='test@orm.org', password='my-pwd')
u.save()

编写通过传递元组给User类,然后打印出相关元组值出来看看

好了,如果这样的方式来创建类,的确就可以接收到了一个字典。

但是如果想要构造成为一个insert语句,这里的name是需要改写为username的。那么此时此刻,就可以前面通过元组传递过来的__mappings__映射字段来处理字段名称的切换。

编写save方法,根据__mappings__映射来构造insert语句

好了,从图中已经可以知道了如何设置类的值,并且传递打印类的值。

下面就是根据__mappings__的映射关系,将对应的name改为username等,然后构建为一个insert的SQL语句。

看着打印出来的结果,大概可以知道该如何进行映射修改了。

好了,根据这个获取到的值,那么就可以构造SQL语句了。

首先使用fields的list来保存映射获取的字段名,然后使用args保存对应的值。

下面就可以使用这两个list来构建SQL,如下:

好啦,已经成功获取到了这个SQL语句了。

但是看看这个SQL语句:
insert into User(uid,username,email,password) values(12345,Michael,test@orm.org,my-pwd)
是否发现一些问题?

就是插入数据的使用,如果是int类型,的确不用加上''引号括起来,但是字符串是需要使用引号括起来的。

那么下面再来优化一下,进行数据类型的判断,然后再改变拼接的方式。

好了,字符串的字段已经增加了引号括起来了。

那么下一步再考虑一下,如果我没写一个表的类,都要写一个这样的save方法,肯定很麻烦呀。

那么经过思考,我可以将save方法这部分再抽出来作为一个User的父类呀,既然通用的话。

抽取通用部分为Model类

运行测试如下:

那么再写一个student表的类来看看是否也是正常可以生成SQL语句。

好啦,成功生成SQL了。

最后提供一下完整代码

# 定义元类
class ModelMetaclass(type):

    def __new__(cls,name,bases,attrs):
        # print("cls=",cls)
        # print("name=",name)
        # print("bases=",bases)
        # print("attrs=",attrs)

        # 定义一个映射字典
        mappings = dict()

        for attr in attrs:
            # print("key = ",attr," ,value=",attrs[attr])
            if isinstance(attrs[attr],tuple):
                print("User表的元组属性:")
                print("key = ", attr, " ,value=", attrs[attr])
                mappings[attr] = attrs[attr]

        # print("mappings=",mappings)

        #将mappings字典保存到属性之中,进行返回给User类
        attrs['__mappings__'] = mappings
        #记录表名
        attrs['__table__'] = name

        return type.__new__(cls,name,bases,attrs)

# 定义Model类
class Model(metaclass=ModelMetaclass):
    ## 编写初始化方法,接收元组
    def __init__(self, **kwargs):
        print("init方法中接收的kwargs=", kwargs)
        for key, value in kwargs.items():
            # print("kwargs中的key=%s , value=%s" % (key,value))
            ## 设置属性至该类中
            setattr(self, key, value)

    def save(self):
        fields = []  # 记录字段名
        args = []  # 记录传递过来的参数
        for key, value in self.__mappings__.items():
            print("save=", key, value)
            fields.append(value[0])  # 将字典的值保存到fields中
            args.append(getattr(self, key, None))  # 根据key,也就是例如name='Michael',则设置参数为Michael
            print("save fields=%s , args=%s" % (fields, args))

        # 判断字段类型,判断是否添加引号
        args_tmp = []
        for value in args:
            print("args.value=", value)
            if isinstance(value, int):  # 如果是int类型,则设置为str字符串,用于后续join的拼接
                args_tmp.append(str(value))
            if isinstance(value, str):  # 如果是str类型,则增加引号
                args_tmp.append("""'%s'""" % value)

        print("args_tmp=", args_tmp)

        ## 构建sql insert into User(uid,username,email,password) values(12345,Michael,test@orm,org,my-pwd)
        sql = "insert into %s(%s) values(%s)" % (self.__table__, ','.join(fields), ','.join(args_tmp))
        print("sql=", sql)

    def _test(self):
        print("测试打印元组传递过来的mappings属性")
        print(self.__mappings__)

# 定义User类
class User(Model):
    # 定义User表的字段以及字段类型
    uid = ('uid',"int unsigned")
    name = ('username',"varchar(30)")
    email = ('email',"varchar(30)")
    password = ('password',"varchar(30)")

# 定义Student类
class Student(Model):
    # 定义字段映射关系
    uid = ('uid',"int unsigned")
    name = ('username',"varchar(30)")
    classroom = ('room',"varchar(30)")

def main():
    u = User(uid=12345, name='Michael', email='test@orm.org', password='my-pwd')
    u.save()

    stu = Student(uid=123,name='fatboy',classroom='room1')
    stu.save()

if __name__ == "__main__":
    main()

关注微信公众号,回复【资料】、Python、PHP、JAVA、web,则可获得Python、PHP、JAVA、前端等视频资料。

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

推荐阅读更多精彩内容

  • 1. 简介 1.1 什么是 MyBatis ? MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的...
    笨鸟慢飞阅读 5,474评论 0 4
  • 一. Java基础部分.................................................
    wy_sure阅读 3,807评论 0 11
  • 转载,觉得这篇写 SQLAlchemy Core,写得非常不错。不过后续他没写SQLAlchemy ORM... ...
    非梦nj阅读 5,387评论 1 14
  • 咨询本身就是一个间接推销过程,通过透视求美者内心的想法,采用不让其反感的方法进行营销。在整个咨询过程中,整形咨询师...
    莎莎微整形阅读 272评论 0 0
  • 青蜂寻 百花争 蜜于身便甜可心 花蝶舞 草莹空 乱似纤轻醉旧人 蚕丝绸缎棉似柳 落叶枯灵忆知秋 乾坤掷 阴阳咒 死...
    伊诚ES阅读 282评论 2 5