python | orator,一个非常 nice 的 Python 库!

本文来源公众号“python”,仅用于学术分享,侵权删,干货满满。

原文链接:https://mp.weixin.qq.com/s/FHCEdpoGWng6yPlRv22pNA

orator是一个功能强大且优雅的Python ORM(对象关系映射)库,其设计灵感来源于PHP Laravel框架中备受赞誉的Eloquent ORM。作为一个Active Record实现,orator提供了简洁直观的API来处理数据库操作,让开发者能够用Python对象的方式来操作数据库记录,而无需编写繁琐的SQL语句。

安装

1、基础安装

使用pip命令可以快速安装orator库:

pip install orator

2、安装数据库驱动

根据使用的数据库类型,需要安装相应的驱动:

MySQL数据库:

pip install pymysql

PostgreSQL数据库:

pip install psycopg2

SQLite数据库:SQLite驱动已内置在Python标准库中,无需额外安装。

3、验证安装

import orator
print(orator.__version__)

成功输出版本号即表示安装完成。

核心特性:

  • Active Record模式:将数据库表映射为Python类,记录映射为对象实例

  • 流畅的查询构建器:提供链式调用的查询API,代码简洁易读

  • 多数据库支持:支持MySQL、PostgreSQL、SQLite等主流数据库

  • 模型关系管理:支持一对一、一对多、多对多等复杂关系定义

  • 数据库迁移工具:提供版本化的数据库结构管理功能

  • 查询作用域:可定义可重用的查询逻辑,提高代码复用性

  • 软删除功能:支持逻辑删除,保留数据历史记录

基本功能

1、数据库连接配置

通过DatabaseManager类可以管理多个数据库连接,支持读写分离等高级配置。

下面的示例展示了如何配置SQLite数据库连接,这是最简单的配置方式,适合快速开发和测试:

from orator import DatabaseManager, Model

# 配置数据库连接
config = {
    'sqlite': {
        'driver': 'sqlite',
        'database': 'database.db'
    }
}

# 创建数据库管理器
db = DatabaseManager(config)
Model.set_connection_resolver(db)

2、定义模型和基本查询

模型是orator的核心概念,每个模型类对应数据库中的一张表,orator提供了类似于Django ORM的查询API,支持链式调用、条件筛选、排序等常用操作。

下面的示例演示了如何定义一个用户模型,并执行基本的CRUD(创建、读取、更新、删除)操作:

from orator import Model

class User(Model):
    __table__ = 'users'
    __fillable__ = ['name', 'email', 'age']

# 查询所有用户
users = User.all()

# 条件查询
adult_users = User.where('age', '>=', 18).get()

# 查询单条记录
user = User.find(1)

# 链式查询
active_users = User.where('status', 'active')\
                   .order_by('created_at', 'desc')\
                   .limit(10)\
                   .get()

3、创建和更新记录

orator提供了多种方式来创建和更新记录,既可以使用模型实例的方式,也可以使用批量赋值,通过__fillable属性可以控制哪些字段允许批量赋值,这是一个重要的安全特性。

下面展示了创建新记录和更新现有记录的常用方法,包括直接保存和使用create方法。

from orator import Model

class User(Model):
    __table__ = 'users'
    __fillable__ = ['name', 'email', 'age']

# 方式1:创建并保存
user = User()
user.name = '张三'
user.email = 'zhangsan@example.com'
user.age = 25
user.save()

# 方式2:批量赋值创建
user = User.create({
    'name': '李四',
    'email': 'lisi@example.com',
    'age': 30
})

# 更新记录
user = User.find(1)
user.age = 26
user.save()

# 批量更新
User.where('age', '<', 18).update({'status': 'minor'})

高级功能

1、模型关系定义

orator提供了优雅的方式来定义这些关系,包括一对一、一对多、多对多等,通过关系定义,可以方便地进行关联查询和数据预加载,避免N+1查询问题。

下面的示例展示了一对多关系的定义,用户可以拥有多篇文章,通过关系方法可以轻松访问关联数据。

from orator import Model

class User(Model):
    __table__ = 'users'
    
    @property
    def posts(self):
        return self.has_many('Post', 'user_id')

class Post(Model):
    __table__ = 'posts'
    
    @property
    def author(self):
        return self.belongs_to('User', 'user_id')

# 使用关系
user = User.find(1)
user_posts = user.posts  # 获取用户的所有文章

post = Post.find(1)
author = post.author  # 获取文章的作者

# 预加载关系(避免N+1问题)
users = User.with_('posts').get()

2、查询作用域

通过在模型中定义作用域方法,可以将常用的查询条件封装起来,提高代码的可维护性和复用性,作用域方法以"scope_"为前缀,调用时省略前缀。

from orator import Model, scope

class User(Model):
    __table__ = 'users'
    
    @scope
    def active(self, query):
        return query.where('status', 'active')
    
    @scope
    def adults(self, query):
        return query.where('age', '>=', 18)
    
    @scope
    def recent(self, query, days=7):
        from datetime import datetime, timedelta
        date = datetime.now() - timedelta(days=days)
        return query.where('created_at', '>=', date)

# 使用作用域
active_users = User.active().get()
adult_active_users = User.active().adults().get()
recent_users = User.recent(30).get()

3、软删除功能

软删除是一个非常实用的特性,它不会真正从数据库中删除记录,而是标记为已删除状态。orator通过SoftDeletes mixin提供了完整的软删除支持,包括恢复已删除记录、强制删除等功能。

from orator import Model, SoftDeletes

class User(Model, SoftDeletes):
    __table__ = 'users'
    __dates__ = ['deleted_at']

# 软删除
user = User.find(1)
user.delete()  # 只是标记为删除,不会真正删除

# 查询包含已删除的记录
all_users = User.with_trashed().get()

# 只查询已删除的记录
deleted_users = User.only_trashed().get()

# 恢复已删除的记录
user = User.with_trashed().find(1)
user.restore()

# 强制删除(真正删除)
user.force_delete()

总结

orator是一个设计优雅、功能全面的Python ORM库,它将Laravel Eloquent的优秀设计理念带到了Python生态系统中。通过本文的介绍,学习了orator的安装配置、模型定义、基础查询以及关系管理、查询作用域、软删除等高级特性。orator的Active Record模式和流畅的API设计,让数据库操作变得简单直观,大大提高了开发效率,丰富的功能特性使其不仅适用于小型项目的快速开发,也能胜任中大型应用的复杂数据管理需求。

THE END !

文章结束,感谢阅读。您的点赞,收藏,评论是我继续更新的动力。大家有推荐的公众号可以评论区留言,共同学习,一起进步。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值