Python中编写ORM框架的入门指引

 更新时间:2015年04月29日 17:10:39   作者:廖雪峰  
这篇文章主要介绍了Python中编写ORM框架的入门指引,示例代码基于Python2.x版本,需要的朋友可以参考下

有了db模块,操作数据库直接写SQL就很方便。但是,我们还缺少ORM。如果有了ORM,就可以用类似这样的语句获取User对象:

user = User.get('123')

而不是写SQL然后再转换成User对象:

u = db.select_one('select * from users where id=?', '123')
user = User(**u)

所以我们开始编写ORM模块:transwarp.orm。
设计ORM接口

和设计db模块类似,设计ORM也是从上层调用者角度来设计。

我们先考虑如何定义一个User对象,然后把数据库表users和它关联起来。

from transwarp.orm import Model, StringField, IntegerField

class User(Model):
  __table__ = 'users'
  id = IntegerField(primary_key=True)
  name = StringField()

注意到定义在User类中的__table__、id和name是类的属性,不是实例的属性。所以,在类级别上定义的属性用来描述User对象和表的映射关系,而实例属性必须通过__init__()方法去初始化,所以两者互不干扰:

# 创建实例:
user = User(id=123, name='Michael')
# 存入数据库:
user.insert()

实现ORM模块

有了定义,我们就可以开始实现ORM模块。

首先要定义的是所有ORM映射的基类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"'Dict' object has no attribute '%s'" % key)

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

Model从dict继承,所以具备所有dict的功能,同时又实现了特殊方法__getattr__()和__setattr__(),所以又可以像引用普通字段那样写:

>>> user['id']
123
>>> user.id
123

Model只是一个基类,如何将具体的子类如User的映射信息读取出来呢?答案就是通过metaclass:ModelMetaclass:

class ModelMetaclass(type):
  def __new__(cls, name, bases, attrs):
    mapping = ... # 读取cls的Field字段
    primary_key = ... # 查找primary_key字段
    __table__ = cls.__talbe__ # 读取cls的__table__字段
    # 给cls增加一些字段:
    attrs['__mapping__'] = mapping
    attrs['__primary_key__'] = __primary_key__
    attrs['__table__'] = __table__
    return type.__new__(cls, name, bases, attrs)

这样,任何继承自Model的类(比如User),会自动通过ModelMetaclass扫描映射关系,并存储到自身的class中。

然后,我们往Model类添加class方法,就可以让所有子类调用class方法:

class Model(dict):

  ...

  @classmethod
  def get(cls, pk):
    d = db.select_one('select * from %s where %s=?' % (cls.__table__, cls.__primary_key__.name), pk)
    return cls(**d) if d else None

User类就可以通过类方法实现主键查找:

user = User.get('123')

往Model类添加实例方法,就可以让所有子类调用实例方法:

class Model(dict):

  ...

  def insert(self):
    params = {}
    for k, v in self.__mappings__.iteritems():
      params[v.name] = getattr(self, k)
    db.insert(self.__table__, **params)
    return self

这样,就可以把一个User实例存入数据库:

user = User(id=123, name='Michael')
user.insert()

最后一步是完善ORM,对于查找,我们可以实现以下方法:

  find_first()

  find_all()

  find_by()

对于count,可以实现:

  

 count_all()

 count_by()

以及update()和delete()方法。

最后看看我们实现的ORM模块一共多少行代码?加上注释和doctest才仅仅300多行。用Python写一个ORM是不是很容易呢?

相关文章

  • python添加列表元素append(),extend()及 insert()

    python添加列表元素append(),extend()及 insert()

    这篇文章主要介绍了python添加列表元素append(),extend()及 insert(),列表是储存元素的数据类型,既然能存储元素,那么就类似数据库一样,增删改查的一些功能就不能少了。下面我们就来先看看添加列表元素方法有哪些,需要的朋友可以参考一下
    2022-03-03
  • Python中Parser的超详细用法实例

    Python中Parser的超详细用法实例

    Parser模块为Python的内部解析器和字节码编译器提供了一个接口,该接口的主要目的是允许Python代码编辑Python表达式的分析树并从中创建可执行代码,这篇文章主要给大家介绍了关于Python中Parser超详细用法的相关资料,需要的朋友可以参考下
    2022-07-07
  • Python并发编程线程消息通信机制详解

    Python并发编程线程消息通信机制详解

    这篇文章主要为大家介绍了Python并发编程之线程消息通信机制的示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2021-10-10
  • 基于Django静态资源部署404的解决方法

    基于Django静态资源部署404的解决方法

    今天小编就为大家分享一篇基于Django静态资源部署404的解决方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-07-07
  • 解决tensorflow由于未初始化变量而导致的错误问题

    解决tensorflow由于未初始化变量而导致的错误问题

    今天小编就为大家分享一篇解决tensorflow由于未初始化变量而导致的错误问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-01-01
  • python操作MySQL 模拟简单银行转账操作

    python操作MySQL 模拟简单银行转账操作

    这篇文章主要介绍了python操作MySQL 模拟简单银行转账操作,需要的朋友可以参考下
    2017-09-09
  • 对Django中的权限和分组管理实例讲解

    对Django中的权限和分组管理实例讲解

    今天小编就为大家分享一篇对Django中的权限和分组管理实例讲解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-08-08
  • Python中创建二维数组

    Python中创建二维数组

    今天小编就为大家分享一篇关于Python中创建二维数组,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-10-10
  • python正则表达式匹配[]中间为任意字符的实例

    python正则表达式匹配[]中间为任意字符的实例

    今天小编就为大家分享一篇python正则表达式匹配[]中间为任意字符的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-12-12
  • 详解Python字典小结

    详解Python字典小结

    这篇文章主要介绍了详解Python字典小结,详细的介绍了什么是字典且创建字典和示例,非常具有实用价值,需要的朋友可以参考下
    2018-10-10

最新评论