如何在FastAPI响应的Pydantic模型中添加自定义计算字段？

问题描述 #

我定义了如下的FastAPI响应模型：

class BillBase(BaseModel):
    bill_no: int
    amount: int
    about: str

class ShowSalesBill(BillBase):
    id: int
    left_amount: int

    class Config:
        orm_mode = True

其中left_amount字段并不存在于对应的ORM模型（Bills）中，我需要根据某些条件计算这个字段的值。想知道FastAPI中有没有类似Django序列化器里get_field_name函数的方式，能在响应模型里添加这类额外的自定义计算字段？

实现方法 #

当然可以，FastAPI提供了几种灵活的方式来添加这类计算字段，下面是几种常用方案：

方案一：使用@property属性（推荐用于ORM模型关联场景） #

如果你的ORM模型（比如Bills）可以扩展，直接在ORM类中添加计算属性，因为响应模型开启了orm_mode=True，会自动识别这类属性：

# 假设你的ORM模型是这样的
class Bills(Base):
    __tablename__ = "bills"
    id = Column(Integer, primary_key=True)
    bill_no = Column(Integer)
    amount = Column(Integer)
    about = Column(String)
    # 假设还有已支付金额字段
    paid_amount = Column(Integer)

    @property
    def left_amount(self):
        # 这里写你的计算逻辑，比如总金额减已支付金额
        return self.amount - self.paid_amount

这样当你从数据库查询出Bills实例后，直接传入ShowSalesBill.from_orm()，响应模型会自动把left_amount字段包含进去。

方案二：在响应模型中添加@validator（适合无需修改ORM模型的场景） #

如果不想改动ORM模型，可以在响应模型里用validator来计算字段值，注意要设置pre=True让验证器在模型解析前执行：

from pydantic import validator

class ShowSalesBill(BillBase):
    id: int
    left_amount: int

    class Config:
        orm_mode = True

    @validator("left_amount", pre=True, always=True)
    def calculate_left_amount(cls, v, values):
        # values包含已解析的其他字段值，比如amount，这里可以结合你的业务逻辑计算
        # 假设你能拿到已支付金额，比如从其他关联数据或上下文获取
        paid_amount = 100  # 实际业务中替换为真实的已支付金额逻辑
        return values.get("amount", 0) - paid_amount

注意：如果是从ORM实例解析，values里的字段是ORM实例的属性，确保能正确获取到需要的计算参数。

方案三：手动构造响应数据字典 #

在接口处理函数中，查询到数据后手动计算left_amount，构造包含该字段的字典再返回：

@app.get("/bills/{bill_id}", response_model=ShowSalesBill)
def get_bill(bill_id: int, db: Session = Depends(get_db)):
    bill = db.query(Bills).filter(Bills.id == bill_id).first()
    # 计算left_amount
    left_amount = bill.amount - bill.paid_amount
    # 构造包含所有字段的字典
    bill_data = {
        "id": bill.id,
        "bill_no": bill.bill_no,
        "amount": bill.amount,
        "about": bill.about,
        "left_amount": left_amount
    }
    return bill_data

这种方式最直接，适合快速实现简单的计算逻辑。

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