Tortoise-ORM中PyDantic模型无法显示关联实体的问题排查

核心原因 #

1. 默认不包含关联字段：pydantic_model_creator生成的模型默认只序列化当前实体的数据库字段，不会自动包含外键关联的实体字段。
2. 预加载方法误用：prefetch_related适用于多对多或反向外键关联场景，正向外键关联应该用select_related来预加载关联数据。
3. include参数配置错误：直接给pydantic_model_creator传include时，需要明确指定关联字段对应的Pydantic模型映射，否则不会生效。

具体解决步骤 #

1. 修正查询的预加载方式 #

把prefetch_related("user")替换为select_related("user")，适配正向外键的预加载逻辑：

await MessageRp.from_queryset(Message.filter(user=user_id).select_related("user").order_by("-date"))

2. 生成MessageRp时显式包含关联字段 #

方法一：通过include参数指定关联字段对应的Pydantic模型

MessageRp = pydantic_model_creator(
    Message, 
    name="MessageRp",
    include={"user": UserRp}
)

方法二：使用depth参数自动序列化一级关联实体（适合简单关联场景）

MessageRp = pydantic_model_creator(
    Message, 
    name="MessageRp",
    depth=1  # 数值表示要序列化的关联层级
)

3. 验证序列化结果 #

配置完成后，返回的MessageRp实例会包含完整的user字段数据，示例结构如下：

{
  "id": 1,
  "date": "2024-05-20T10:30:00",
  "text": "测试消息",
  "user": {
    "id": 101,
    "username": "nicolas"
  }
}

内容的提问来源于stack exchange，提问作者Nicolas