Tortoise-ORM 结合 Pydantic 的高级模型配置教程
项目地址: https://gitcode.com/gh_mirrors/to/tortoise-orm 前言
在 Python 的 ORM 开发中，Tortoise-ORM 提供了强大的异步数据库操作能力，而 Pydantic 则是数据验证和序列化的利器。本教程将深入探讨如何通过 PydanticMeta 类配置模型创建器，以及如何使用可调用函数来注解额外数据。
核心概念解析
1. PydanticMeta 类
PydanticMeta 是 Tortoise-ORM 中一个特殊的内部类，用于配置 Pydantic 模型生成器的行为。通过这个类，我们可以：
- 排除不需要的字段 (
exclude) - 包含计算字段 (
computed) - 配置其他 Pydantic 相关的选项
2. 计算字段
计算字段是指那些不直接存储在数据库中，而是通过模型方法计算得出的字段。在 Tortoise-ORM 中，这些方法需要：
- 明确指定返回类型注解
- 在
PydanticMeta.computed中声明 - 处理可能的关系数据预取异常
代码实现详解
模型定义
我们定义了两个主要模型：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)
events: fields.ReverseRelation["Event"]
class PydanticMeta:
exclude = ("created_at",)
computed = ("name_length", "events_num")
计算字段实现
name_length 方法计算名称长度，events_num 计算关联事件数量：
def name_length(self) -> int:
return len(self.name)
def events_num(self) -> int:
try:
return len(self.events)
except NoValuesFetched:
return -1
注意 events_num 方法中处理了 NoValuesFetched 异常，这是因为 Pydantic 序列化器无法调用异步方法，而 Tortoise 的帮助器会预取关系数据。
Pydantic 模型生成
使用 pydantic_model_creator 创建 Pydantic 模型：
Tournament_Pydantic = pydantic_model_creator(Tournament)
数据库操作示例
创建对象并序列化的完整流程：
async def run():
# 初始化数据库
await Tortoise.init(db_url="sqlite://:memory:", modules={"models": ["__main__"]})
await Tortoise.generate_schemas()
# 创建测试数据
tournament = await Tournament.create(name="New Tournament")
await Event.create(name="Event 1", tournament=tournament)
await Event.create(name="Event 2", tournament=tournament)
# 序列化 Tournament 对象
tourpy = await Tournament_Pydantic.from_tortoise_orm(tournament)
print(tourpy.model_dump_json(indent=4))
最佳实践
-
类型注解的重要性：所有计算字段方法必须明确指定返回类型，否则 Pydantic 无法生成有效的 schema。
-
关系数据处理：对于涉及关系的计算字段，要考虑数据预取的情况，适当处理
NoValuesFetched异常。 -
性能考虑：计算字段会增加序列化时的计算开销，对于复杂计算应考虑缓存结果。
-
Schema 设计：合理使用
exclude排除敏感或不必要的字段，保持 API 简洁。
常见问题解答
Q: 为什么我的计算字段没有出现在序列化结果中？
A: 请确保：
- 方法有明确的返回类型注解
- 方法名已添加到
PydanticMeta.computed中 - 方法没有抛出未处理的异常
Q: 如何处理复杂的异步计算字段？
A: Pydantic 序列化器无法直接处理异步方法，建议：
- 在调用序列化前预计算并缓存结果
- 使用 Tortoise 的预取机制提前加载关系数据
总结
通过本教程，我们学习了如何利用 Tortoise-ORM 的 PydanticMeta 类来精细控制 Pydantic 模型的生成，以及如何安全地实现和暴露计算字段。这种模式特别适合需要将数据库模型转换为 API 响应格式的场景，既能保持数据一致性，又能提供丰富的计算属性。
掌握这些技巧后，开发者可以构建出更加灵活、强大的数据序列化方案，满足各种复杂的业务需求。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
