Tortoise-ORM 结合 Pydantic 实现模型关系与序列化教程

Tortoise-ORM 结合 Pydantic 实现模型关系与序列化教程

tortoise-orm tortoise/tortoise-orm: 是一个基于 Python 的对象关系映射 (ORM) 库，它支持 SQLite、 MySQL、 PostgreSQL 等多种数据库。适合用于 Python 应用程序的数据库操作和 ORM，特别是对于需要轻量级、高性能的 ORM 库的场景。特点是轻量级、高性能、支持多种数据库、易于使用。 项目地址: https://gitcode.com/gh_mirrors/to/tortoise-orm

前言

在现代Python Web开发中，ORM（对象关系映射）和数据验证/序列化是两个非常重要的环节。Tortoise-ORM作为一个异步ORM框架，与Pydantic这个数据验证库的结合使用，可以极大地提升开发效率和代码质量。本教程将深入探讨如何使用Tortoise-ORM和Pydantic处理模型关系以及序列化操作。

核心概念

模型关系

在数据库设计中，表与表之间的关系是基础。Tortoise-ORM支持以下几种关系类型：

1. 外键关系（ForeignKeyField）
2. 一对一关系（OneToOneField）
3. 多对多关系（ManyToManyField）
4. 反向关系（related_name）

Pydantic集成

Tortoise-ORM通过tortoise.contrib.pydantic模块提供了与Pydantic的无缝集成，可以：

1. 自动从Tortoise模型生成Pydantic模型
2. 处理模型序列化和反序列化
3. 生成JSON Schema

代码解析

模型定义

首先定义了两个模型：Tournament（比赛）和Event（赛事）：

class Tournament(Model):
    id = fields.IntField(primary_key=True)
    name = fields.CharField(max_length=100)
    created_at = fields.DatetimeField(auto_now_add=True)

class Event(Model):
    id = fields.IntField(primary_key=True)
    name = fields.CharField(max_length=100)
    created_at = fields.DatetimeField(auto_now_add=True)
    tournament = fields.ForeignKeyField(
        "models.Tournament", 
        related_name="events",
        description="The Tournament this happens in"
    )

这里Event通过外键关联到Tournament，并设置了related_name="events"，这意味着我们可以通过tournament.events访问一个比赛的所有赛事。

Pydantic模型生成

Tortoise-ORM提供了pydantic_model_creator函数来从Tortoise模型生成Pydantic模型：

Tournament_Pydantic_Early = pydantic_model_creator(Tournament)

这里生成了一个早期的Pydantic模型，此时还没有初始化模型关系。

模型初始化

Tortoise.init_models(["__main__"], "models")

这一步初始化了模型结构，但不会初始化任何数据库结构。初始化后，我们可以生成包含完整关系的Pydantic模型。

完整Pydantic模型

Tournament_Pydantic = pydantic_model_creator(Tournament)

现在生成的Pydantic模型包含了完整的模型关系信息。

实际操作

在run()函数中，我们演示了完整的操作流程：

1. 初始化数据库连接
2. 生成数据库模式
3. 创建模型实例
4. 序列化模型实例

# 创建对象
tournament = await Tournament.create(name="New Tournament")
event = await Event.create(name="The Event", tournament=tournament)

# 序列化
tourpy = await Tournament_Pydantic.from_tortoise_orm(tournament)
print(tourpy.model_dump_json(indent=4))

关键点解析

1. 模型初始化顺序：必须先初始化Tortoise模型，才能生成包含关系的Pydantic模型
2. 序列化选项：默认情况下，Pydantic模型不会跟随关系进行序列化
3. 自动字段处理：auto_now_add等字段会自动处理
4. JSON Schema生成：可以方便地生成模型的JSON Schema

最佳实践

1. 模型分离：将模型定义与Pydantic模型生成分开管理
2. 关系处理：考虑是否需要在序列化中包含关系数据
3. 性能考虑：大量关系数据的序列化可能影响性能，需要适当控制
4. 文档注释：良好的文档注释有助于生成更清晰的Schema

总结

通过本教程，我们学习了如何在Tortoise-ORM中使用Pydantic来处理模型关系和序列化。这种组合提供了强大的数据建模和验证能力，同时保持了代码的简洁性和可维护性。掌握这些技术可以显著提升开发效率和应用程序质量。

在实际项目中，你可以根据需要扩展这些基础用法，例如自定义序列化逻辑、添加复杂验证规则或实现更高级的关系处理策略。

tortoise-orm tortoise/tortoise-orm: 是一个基于 Python 的对象关系映射 (ORM) 库，它支持 SQLite、 MySQL、 PostgreSQL 等多种数据库。适合用于 Python 应用程序的数据库操作和 ORM，特别是对于需要轻量级、高性能的 ORM 库的场景。特点是轻量级、高性能、支持多种数据库、易于使用。 项目地址: https://gitcode.com/gh_mirrors/to/tortoise-orm