如何使用Python tortoise-orm 快速构建异步数据库模型?

浅枫大大_3201

浅枫大大_3201

2026-08-31

734人浏览

原创

tortoiseorm不能直接用basemodel继承,因其未提供该基类,必须显式继承tortoise.models.model并用fields模块声明字段;初始化需在事件循环启动前调用init_db(),外键和多对多关系须严格匹配apps配置路径,序列化需用.values()等方法避免json错误。

如何使用python tortoise-orm 快速构建异步数据库模型?

为什么 TortoiseORM 不能直接用 BaseModel 继承?

很多人一上来就写 class User(BaseModel),结果报错 NameError: name 'BaseModel' is not defined。Tortoise 不像 SQLAlchemy 或 Pydantic 那样提供通用基类,它要求模型必须显式继承 tortoise.models.Model,且需配合 fields 模块声明字段。

  • 正确写法是:先 from tortoise import models, fields,再 class User(models.Model)
  • id 字段默认由 fields.IntField(pk=True) 或更推荐的 fields.UUIDField(pk=True) 显式定义(避免整型 ID 泄露业务量)
  • 不支持 __annotations__ 自动推导(如 name: str),所有字段必须用 fields.CharField(max_length=255) 等显式声明

init_db() 必须在事件循环启动前调用,否则 await 报错

常见错误是把 await Tortoise.init(...) 放在 async def main() 里,再用 asyncio.run(main()) —— 这会导致连接池未初始化就尝试执行 .all(),抛出 RuntimeError: No current event loop in threadTortoise is not initialized

Shadows Python Sensei
Shadows Python Sensei

Python 最佳实践助手——代码规范、设计模式、性能优化、测试与类型注解。适用于编写或审查 Python 代码。

下载
  • 正确顺序:先 await Tortoise.init(),再 await Tortoise.generate_schemas()(开发期可选),最后才跑业务逻辑
  • 若用 FastAPI,应在 startup 事件中调用 init,而非路由函数内
  • 配置里 connectionsdefault 键名必须与模型 Meta 中的 app 值一致(默认是 "models",不是 "default"

ForeignKey 和 ManyToManyField 怎么写才不出错?

外键字段名和关联模型路径容易混淆。比如想让 Post 关联 User,写成 author = fields.ForeignKeyField('models.User', related_name='posts') —— 这里的 'models.User' 是模块路径,不是类名,且必须和 Tortoise.init(..., apps={'models': [...]} ) 中的 app 名匹配。

  • related_name 是反向查询字段名,比如 user.posts.all(),不能重复;同一模型多个外键需设不同 related_name
  • 多对多必须用中间表模型(Tortoise 不支持隐式中间表),且两端都要定义 ManyToManyField,例如 tags = fields.ManyToManyField('models.Tag', related_name='posts')
  • 删除时级联行为靠 on_delete 控制:fields.CASCADEfields.SET_NULL(后者要求字段 null=True

异步查询返回的是模型实例,不是 dict,别直接 JSON.dumps

await User.all() 返回的是 List[User],每个 User 是带异步方法的实例,直接传给 json.dumps 会报 TypeError: Object of type User is not JSON serializable

  • 安全序列化用 .values()(返回 list of dict)或 .values_list('id', 'name')
  • 需要完整字段 + 关联数据时,用 .prefetch_related('posts') 配合 .values(),但注意 prefetch_related 不支持嵌套三层以上
  • 若坚持用模型实例,可重写 pydantic_model_creator(User) 生成 Pydantic 模型,但需额外安装 pydantic 并注意字段类型映射差异(如 UUIDFieldstr
Tortoise 的异步模型看似简单,但字段声明方式、初始化时机、关系定义路径、序列化出口这四点,任一出错都会卡住整个流程。尤其注意 apps 配置键名和模型内 Meta.app 的一致性——这是最常被忽略、又最难 debug 的地方。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1551

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

3624

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1549

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

20657

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2567

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2627

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1063

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

576

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2023

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程