FastAPI не выбирает вложенную схему, несмотря на то, что данные находятся в базе данных / модели.

Question

Я получаю сообщение об ошибке при попытке вернуть данные, хранящиеся во взаимосвязи между двумя моделями. Более подробная информация ниже:

models.py (соответствующие модели Company а также Address)

from datetime import datetime

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relationship
from sqlalchemy import Column, Integer, String, Date, Sequence, ForeignKey, DateTime

try:
    from .functions import to_camelcase
except:
    from functions import to_camelcase


Base = declarative_base()


class ToDictMixin(object):
    def to_dict(self, camelcase=True):
        if camelcase:
            return {to_camelcase(column.key): getattr(self, attr) for attr, column in self.__mapper__.c.items()}
        else:
            return {column.key: getattr(self, attr) for attr, column in self.__mapper__.c.items()}


class TimestampMixin(object):
    record_created = Column('record_created', DateTime, default=datetime.now())


class Company(Base, ToDictMixin, TimestampMixin):
    __tablename__ = 'companies'

    number = Column(Integer, primary_key=True)
    name = Column(String)
    incorporated = Column(Date)

    address = relationship("Address", back_populates="occupier")

    def __repr__(self):
        return f"<Company(number='{self.number}', name='{self.name}', incorporated='{self.incorporated.isoformat}')>"


class Address(Base, ToDictMixin, TimestampMixin):
    __tablename__ = 'addresses'

    id = Column(Integer, primary_key=True)
    address_line1 = Column(String)
    address_line2 = Column(String)
    address_line3 = Column(String)
    po_box = Column(String)
    post_town = Column(String)
    county = Column(String)
    postcode = Column(String)
    country = Column(String)
    occupier_id = Column(Integer, ForeignKey("companies.number"))

    occupier = relationship("Company", back_populates="address")

schemas.py

import datetime

from pydantic import BaseModel, BaseConfig
from typing import List

from functions import to_camelcase


class APIBase(BaseModel):
    class Config(BaseConfig):
        orm_mode = True
        alias_generator = to_camelcase
        allow_population_by_field_name = True


class AddressBase(APIBase):
    address_line1 : str
    postcode: str


class AddressCreate(AddressBase):
    pass


class Address(AddressBase):
    address_line2 : str
    address_line3 : str
    po_box : str
    post_town : str
    county : str
    postcode : str
    country : str


class CompanyBase(APIBase):
    number: int
    name: str


class CompanyCreate(CompanyBase):
    incorporated : datetime.date


class Company(CompanyBase):
    incorporated : datetime.date
    address: Address

Соответствующий звонок main.py:

@app.get("/companies", response_model=List[schemas.Company])
def get_companies(
    year: int = None, month: int = None, day: int = None, number: int = None, 
    name: str = None, db: Session = Depends(get_db)):

    name = name.upper() if name else None

    arguments = locals()
    arguments.pop("db")

    if not any(arguments.values()):
        return None

    myquery = db.query(models.Company)
    datedict = {}

    for key, value in arguments.items():
        if key == "number" and datedict:
            myquery = crud.get_company_by_date(db, **datedict)

        if not value:
            continue

        if key == 'year' or key == 'month' or key == 'day':
            datedict[key] = value
        else:
            myquery = crud.filter_query(myquery, **{key:value})

    return myquery.all()

Насколько я могу судить по документации, у меня все настроено нормально. Когда я удаляюaddress: Address из схемы компании этот вызов вернет правильную компанию / компании без адресных данных.

Я проверил, связаны ли соответствующие адресные данные с моделью компании, путем тестирования

>>> x = SESSION.query(Company).filter_by(number=12544331).one_or_none()
>>> x.address[0].address_line1
'4 VICTORIA COURT'

Итак, я знаю, что данные находятся в таблице адресов, связь установлена ​​правильно, а модель и схема работают, прежде чем пытаться включить данные адреса в результат. Однако когда я пытаюсь получить доступhttp://127.0.0.1:8000/companies?number=12544331 Я получаю внутреннюю ошибку сервера и следующее сообщение об ошибке:

INFO:     127.0.0.1:50928 - "GET /companies?number=12544331 HTTP/1.1" 500 Internal Server Error
ERROR:    Exception in ASGI application
Traceback (most recent call last):
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\uvicorn\protocols\http\h11_impl.py", line 384, in run_asgi
    result = await app(self.scope, self.receive, self.send)
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\uvicorn\middleware\proxy_headers.py", line 45, in __call__
    return await self.app(scope, receive, send)
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\fastapi\applications.py", line 149, in __call__
    await super().__call__(scope, receive, send)
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\starlette\applications.py", line 102, in __call__
    await self.middleware_stack(scope, receive, send)
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\starlette\middleware\errors.py", line 181, in __call__
    raise exc from None
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\starlette\middleware\errors.py", line 159, in __call__
    await self.app(scope, receive, _send)
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\starlette\exceptions.py", line 82, in __call__
    raise exc from None
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\starlette\exceptions.py", line 71, in __call__
    await self.app(scope, receive, sender)
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\starlette\routing.py", line 550, in __call__
    await route.handle(scope, receive, send)
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\starlette\routing.py", line 227, in handle
    await self.app(scope, receive, send)
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\starlette\routing.py", line 41, in app
    response = await func(request)
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\fastapi\routing.py", line 204, in app
    response_data = await serialize_response(
  File "c:\users\admin\google~1\python\new_co~1\env\lib\site-packages\fastapi\routing.py", line 126, in serialize_response
    raise ValidationError(errors, field.type_)
pydantic.error_wrappers.ValidationError: 8 validation errors for Company
response -> 0 -> address -> addressLine1
  field required (type=value_error.missing)
response -> 0 -> address -> postcode
  field required (type=value_error.missing)
response -> 0 -> address -> addressLine2
  field required (type=value_error.missing)
response -> 0 -> address -> addressLine3
  field required (type=value_error.missing)
response -> 0 -> address -> poBox
  field required (type=value_error.missing)
response -> 0 -> address -> postTown
  field required (type=value_error.missing)
response -> 0 -> address -> county
  field required (type=value_error.missing)
response -> 0 -> address -> country
  field required (type=value_error.missing)

Кажется, думает, что адресных данных там нет. Я думал, это как-то связано сorm_mode в schemas.py поскольку есть ленивая загрузка, но у меня есть orm_mode установлен в Trueчтобы этого избежать (см. https://fastapi.tiangolo.com/tutorial/sql-databases/).

Пожалуйста, что мне не хватает?

Answer 1

Оказывается, это произошло из-за моего определения отношений в models.py. Документы SQLAlchemy объяснили это здесь: https://docs.sqlalchemy.org/en/13/orm/basic_relationships.html

Скорректированный код:

class Company(Base, ToDictMixin, TimestampMixin):
    __tablename__ = 'companies'

    number = Column(Integer, primary_key=True)
    name = Column(String)
    incorporated = Column(Date)

    address = relationship("Address", uselist=False, back_populates="occupier")

    def __repr__(self):
        return f"<Company(number='{self.number}', name='{self.name}', incorporated='{self.incorporated.isoformat}')>"

Обратите внимание на использование uselist=False