FastAPI Pydantic与SQLAlchemy嵌套模型校验错误排查

现有配置 #

ORM模型（models.py） #

class MachineGroups(Base):
    __tablename__ = 'MachineGroups'

    MachineGroupsId = Column(NVARCHAR(25), primary_key=True)
    Description = Column(NVARCHAR(255))

    machines = relationship("Machines")


class Machines(Base):
    __tablename__ = 'Machines'

    MachinesId = Column(NVARCHAR(50), primary_key=True)
    Description = Column(NVARCHAR(255))
    MachineGroupsId = Column(NVARCHAR(25), ForeignKey("MachineGroups.MachineGroupsId", ondelete="SET NULL"), nullable=True)

Pydantic序列化模式（schemas.py） #

class MachineGroups(BaseModel):
    MachineGroupsId: str
    Description: str

    class Config:
        orm_mode = True


class Machines(BaseModel):
    MachinesId: str
    Description: str
    MachineGroupsId: Optional[MachineGroups] = None

    class Config:
        orm_mode = True

触发报错 #

pydantic.error_wrappers.ValidationError: 1 validation error for Machines
response -> 0 -> MachineGroupsId-> MachineGroupsId
  field required (type=value_error.missing)

错误根源 #

一共两处配置错误：

1. SQLAlchemy关联关系定义不全：仅在MachineGroups模型中定义了反向关联的machines字段，没有在Machines模型中定义指向MachineGroups的正向关联关系，ORM无法直接加载机器对应的分组对象。
2. Pydantic字段类型匹配错误：数据库中MachineGroupsId字段存储的是字符串类型的外键ID，但在schema中把这个字段的类型声明为Optional[MachineGroups]，Pydantic会尝试把取到的字符串ID值转换为MachineGroups实例，转换过程中找不到必填的MachineGroupsId属性，直接抛出校验错误。

修复步骤 #

• 修正ORM模型定义，补全双向关联关系，注意关联关系字段不要和外键字段重名：

class MachineGroups(Base):
    __tablename__ = 'MachineGroups'

    MachineGroupsId = Column(NVARCHAR(25), primary_key=True)
    Description = Column(NVARCHAR(255))

    # 反向关联：分组下的所有机器，和Machines模型的group字段对应
    machines = relationship("Machines", back_populates="group")


class Machines(Base):
    __tablename__ = 'Machines'

    MachinesId = Column(NVARCHAR(50), primary_key=True)
    Description = Column(NVARCHAR(255))
    # 数据库实际存储的外键ID，值为字符串类型
    MachineGroupsId = Column(NVARCHAR(25), ForeignKey("MachineGroups.MachineGroupsId", ondelete="SET NULL"), nullable=True)
    # 新增正向关联：机器所属的分组，对应MachineGroups模型的machines字段
    group = relationship("MachineGroups", back_populates="machines")

• 修正Pydantic schema定义，区分外键ID字段和嵌套关联对象字段：

from typing import Optional

class MachineGroups(BaseModel):
    MachineGroupsId: str
    Description: str

    class Config:
        orm_mode = True


class Machines(BaseModel):
    MachinesId: str
    Description: str
    # 对应数据库外键字段，类型为可选字符串
    MachineGroupsId: Optional[str] = None
    # 对应ORM的relationship字段，返回嵌套的分组详情
    group: Optional[MachineGroups] = None

    class Config:
        orm_mode = True

• 查询时如果需要返回嵌套的分组信息，使用预加载避免N+1问题：

from sqlalchemy.orm import joinedload

# 查询机器数据时同步预加载关联的分组信息
machines = db.query(Machines).options(joinedload(Machines.group)).all()

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