Day 3 - 编写ORM

有了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字段

primarykey = … # 查找primarykey字段

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.selectone('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是不是很容易呢？