用了痛苦的一周时间,不断地尝试摸索,终于实现了最简单的SQLite3 ORM,这只是个测试版,至少自己能看到想要的结果,贡献给大家,希望朋友们少走弯路,把有限的精力花在更有价值的地方.
1.建立工具库util_SQLiteORM.py
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
__author__ = 'TianJiang Gui'
import asyncio, logging
import sqlite3
#---gtj 设置log输出格式
logging.basicConfig(format='%(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s',
level=logging.INFO)
# ---gtj sqlite数据库文件名
db = 'sqlite-data.db'
def log(sql, args=()):
logging.info('SQL: %s' % sql.replace('?','%s'), args or ())
# 返回字典方法,传入一个执行过查询sql语句的cursor对象
def dict_factory(cursor, row):
d = {}
for idx, col in enumerate(cursor.description):
d[col[0]] = row[idx]
return d
def select(sql, args, size=None):
log(sql, args)
connect = sqlite3.connect(db)
connect.row_factory = dict_factory
cursor = connect.cursor()
try:
cursor.execute(sql,args)
rs = cursor.fetchall() # 获取查询结果 sqlite_dict(cursor)#
rows = len(rs)
logging.info('rows returned: %s' % rows)
except Exception as e:
print(u'查询错误...', e)
connect.rollback()
finally:
cursor.close()
connect.close()
return rs
def create_args_string(num):
L = []
for n in range(num):
L.append('?')
return ', '.join(L)
class Field(object):
def __init__(self, name, column_type, primary_key, default):
self.name = name
self.column_type = column_type
self.primary_key = primary_key
self.default = default
def __str__(self):
return '<%s, %s:%s>' % (self.__class__.__name__, self.column_type, self.name)
class StringField(Field):
def __init__(self, name=None, primary_key=False, default=None, ddl='varchar(100)'):
super().__init__(name, ddl, primary_key, default)
class BooleanField(Field):
def __init__(self, name=None, default=False):
super().__init__(name, 'boolean', False, default)
class IntegerField(Field):
def __init__(self, name=None, primary_key=False, default=0):
super().__init__(name, 'int', primary_key, default)
class FloatField(Field):
def __init__(self, name=None, primary_key=False, default=0.0):
super().__init__(name, 'float', primary_key, default)
class TextField(Field):
def __init__(self, name=None, default=None):
super().__init__(name, 'text', False, default)
class ModelMetaclass(type):
def __new__(cls, name, bases, attrs):
if name=='Model':
return type.__new__(cls, name, bases, attrs)
tableName = attrs.get('__table__', None) or name
logging.info('found model: %s (table: %s)' % (name, tableName))
mappings = dict()
fields = []
primaryKey = None
for k, v in attrs.items():
if isinstance(v, Field):
logging.info(' found mapping: %s ==> %s' % (k, v))
mappings[k] = v
if v.primary_key:
# 找到主键:
if primaryKey:
raise Exception('Duplicate primary key for field: %s' % k)
primaryKey = k
else:
fields.append(k)
if not primaryKey:
raise Exception('Primary key not found.')
for k in mappings.keys():
attrs.pop(k)
escaped_fields = list(map(lambda f: '`%s`' % f, fields))
attrs['__mappings__'] = mappings # 保存属性和列的映射关系
attrs['__table__'] = tableName
attrs['__primary_key__'] = primaryKey # 主键属性名
attrs['__fields__'] = fields # 除主键外的属性名
attrs['__select__'] = 'select `%s`, %s from `%s`' % (primaryKey, ', '.join(escaped_fields), tableName)
attrs['__insert__'] = 'insert into `%s` (%s, `%s`) values (%s)' % (tableName, ', '.join(escaped_fields), primaryKey, create_args_string(len(escaped_fields) + 1))
attrs['__update__'] = 'update `%s` set %s where `%s`=?' % (tableName, ', '.join(map(lambda f: '`%s`=?' % (mappings.get(f).name or f), fields)), primaryKey)
attrs['__delete__'] = 'delete from `%s` where `%s`=?' % (tableName, primaryKey)
return type.__new__(cls, name, bases, attrs)
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 getValue(self, key):
return getattr(self, key, None)
def getValueOrDefault(self, key):
value = getattr(self, key, None)
if value is None:
field = self.__mappings__[key]
if field.default is not None:
value = field.default() if callable(field.default) else field.default
logging.debug('using default value for %s: %s' % (key, str(value)))
setattr(self, key, value)
return value
@classmethod
def findAll(cls, where=None, args=None, **kw):
' find objects by where clause. '
sql = [cls.__select__]
if where:
sql.append('where')
sql.append(where)
if args is None:
args = []
orderBy = kw.get('orderBy', None)
if orderBy:
sql.append('order by')
sql.append(orderBy)
limit = kw.get('limit', None)
if limit is not None:
sql.append('limit')
if isinstance(limit, int):
sql.append('?')
args.append(limit)
elif isinstance(limit, tuple) and len(limit) == 2:
sql.append('?, ?')
args.extend(limit)
else:
raise ValueError('Invalid limit value: %s' % str(limit))
rs = select(' '.join(sql), args)
return [cls(**r) for r in rs]
小结:代码中的重点如下(掉黑板),其他代码通过改造廖老师的相关内容.另外有关Sqlite3的操作前置基础文章请参见:
python小技巧大应用--自己写sqlite3的CRUD供应用调用
2.写个测试文件test_SQLiteORM.py
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
' a test SQLite ORM util module '
__author__ = 'TianJiang Gui'
from util_SQLiteORM import *
import time, uuid
def next_id():
return '%015d%s000' % (int(time.time() * 1000), uuid.uuid4().hex)
class Userinfo(Model):
__table__ = 'userinfo'
id = IntegerField(primary_key=True, default=next_id)
name = StringField(ddl='varchar(20)')
age = IntegerField()
def main():
users = Userinfo.findAll()
for user in users:
print(type(user),user)
print('id:',user.id,'name:',user.name,'age:',user.age)
if __name__ == '__main__':
main()
小结:此处用到的sqlite_data.db库和userinfo表都是前文建立,有需要补充阅读的请参见:
3.最后看看运行结果
最后总结: 结果很理想,现实很骨感,这只是个抛转文章,后续还有很多工作要做,希望对你有一点点的帮助,也给我点个赞,收藏一下,谢谢!