Как обрабатывать агрегированные результаты запросов с помощью SQLAlchemy, pydantic и FastAPI

#python #sqlalchemy #mysql-python #fastapi #pydantic

Вопрос:

Я хотел бы создать API, который возвращает агрегированные значения для каждого отдела в качестве ответа. Я новичок в FastAPI и pydantic и был бы признателен за любую поддержку. Похоже, та часть, где результаты запроса отображаются в pydantic, работает не очень хорошо.

получить метод в main.py

 @app.get("/api/{client_id}", response_model=List[schemas.Overview])
def read_overview(client_id: str, db: Session = Depends(get_db)):
    db_overview = crud.get_overview(db, client_id=client_id)
    if db_overview is None:
        raise HTTPException(status_code=404, detail="Overview not found")
    return db_overview
 

crud.py
Получите данные, соответствующие трем кодам отдела, 1000001, 1000002 и 2000001, агрегированные по идентификатору клиента и коду отдела.

 from sqlalchemy.orm import Session
from sqlalchemy import func
from . import models, schemas
import datetime

def get_overview(db: Session, client_id: str):
    text = '1000001,1000002,2000001'
    depts = text.split(',')
    tbl = models.Overview
       overview = db.query(tbl.client_id, tbl.deptCode, tbl.deptName, func.sum(tbl.count), func.sum(tbl.item1), func.sum(tbl.item2), func.sum(tbl.item3), func.sum(tbl.item4), func.sum(tbl.item5), func.sum(tbl.item6)).
        filter(tbl.client_id==client_id). 
        filter(tbl.deptCode.in_(depts)). 
        group_by(tbl.client_id, tbl.deptCode, tbl.deptName).all()
    # print(“overview”, overview)
    return overview
 

Если я проверю результат, полученный ЗАПРОСОМ с помощью функции print (), я увижу, что три строки были получены, как и ожидалось.

Результат — обзор на терминале с помощью функции печати()

 [('C012345', '1000001', 'A地域', Decimal('25'), Decimal('7'), Decimal('0'), Decimal('2'), Decimal('0'), Decimal('0'), Decimal('0')), ('C012345', '1000002', 'Z地域', Decimal('55'), Decimal('15'), Decimal('2'), Decimal('12'), Decimal('0'), Decimal('0'), Decimal('0')), ('C012345', '2000001', 'あ小学校', Decimal('15'), Decimal('5'), Decimal('0'), Decimal('2'), Decimal('0'), Decimal('0'), Decimal('0'))]
 

Однако я получаю сообщение об ошибке «значение не является допустимым целым числом» и «требуется поле», что приводит к следующей ошибке.
Ошибка

   File "/Users/junya/mr2edu_server/venv/lib/python3.9/site-packages/fastapi/routing.py", line 137, in serialize_response
    raise ValidationError(errors, field.type_)
pydantic.error_wrappers.ValidationError: 21 validation errors for Overview
response -> 0 -> count
  value is not a valid integer (type=type_error.integer)
response -> 0 -> item1
  field required (type=value_error.missing)
response -> 0 -> item2
  field required (type=value_error.missing)
response -> 0 -> item3
  field required (type=value_error.missing)
response -> 0 -> item4
  field required (type=value_error.missing)
response -> 0 -> item5
  field required (type=value_error.missing)
response -> 0 -> item6
  field required (type=value_error.missing)

…. continued ...
 

Я также показываю schemas.py и models.py.

schemas.py

 from pydantic import BaseModel
import datetime

class Overview(BaseModel):
    client_id: str
    deptCode: str
    deptName: str
    count: int
    item1: int
    item2: int
    item3: int
    item4: int
    item5: int
    item6: int

    class Config:
        orm_mode = True
 

models.py

 from sqlalchemy import Column, Date, Integer, String
from sqlalchemy.orm import relationship

from .database import Base

class Overview(Base):
    __tablename__ = "overview"
    id = Column(String, primary_key=True, index=True)
    client_id = Column(String)
    date = Column(Date)
    deptCode = Column(String)
    deptName = Column(String)
    level = Column(Integer)
    count = Column(Integer)
    item1 = Column(Integer)
    item2 = Column(Integer)
    item3 = Column(Integer)
    item4 = Column(Integer)
    item5 = Column(Integer)
    item6 = Column(Integer)
 

Ответ №1:

Добавьте label() к каждому вызову aggregate func соответствующее имя поля, которому вы хотите назначить результат:

 db.query(
    tbl.client_id,
    tbl.deptCode,
    tbl.deptName,
    func.sum(tbl.count).label("count"), 
    func.sum(tbl.item1).label("item1"),
)

 

Благодаря этим меткам, каждый результат sqlalchemy.engine.row.Row , который внутренне преобразуется в словарь с fastapi.encoders.jsonable_encoder помощью FastAPI, будет содержать нужные значения.

Комментарии:

1. Спасибо! Как и ожидалось, добавление label () сработало должным образом. Спасибо и за объяснение логики!