sqlalchemy - 无法通过 SQLModel 将 FastAPI List[]、Set() 映射到 Postgres

Question

我正在使用 FastAPI 开发我的个人组合 API，并决定尝试使用 SQLModel。它感觉非常直观，到目前为止我很喜欢它，但我遇到了一个问题，我已经为此苦苦挣扎了好几天，试图了解如何解决这个问题。

我有一个项目模型:

from datetime import datetime
from typing import List, Optional, Set
from sqlmodel import SQLModel, Field


class ProjectBase(SQLModel):
    name: Optional[str]
    summary: Optional[str]
    description: Optional[str]
    category: Set[str] = ()
    award: Optional[str] = None
    url: Optional[str] = None
    published: datetime = datetime.utcnow()
    image: str = "placeholderMainImage"
    images: List[str] = []
    learning: Optional[str]
    tech: Optional[str]
    tools: Optional[str]



class Project(ProjectBase, table=True):
    id: int = Field(default=None, primary_key=True)
    created_at: datetime = Field(default_factory=datetime.utcnow)
    updated_at: datetime = Field(default_factory=datetime.utcnow)

FastAPI 工作正常，我检查了 localhost:8000/docs 并且正确地进行了类型验证:

    {
  "name": "string",
  "summary": "string",
  "description": "string",
  "category": [],
  "award": "string",
  "url": "string",
  "published": "2021-10-04T20:43:26.472364",
  "image": "placeholderMainImage",
  "images": [],
  "learning": "string",
  "tech": "string",
  "tools": "string",
  "id": 0,
  "created_at": "2021-10-04T21:01:30.048Z",
  "updated_at": "2021-10-04T21:01:30.048Z"
}

当我使用上述查询发出 POST 请求时，出现内部服务器错误:

invalid input for query argument $4: (expected str, got set)

不幸的是，SQLModel 在创建表时将任何奇怪的类型转换为 VARCHAR，从而无法使用 List 或 Set 功能:

   CREATE TABLE project (
         name VARCHAR, 
         summary VARCHAR, 
         description VARCHAR, 
         category VARCHAR, 
         award VARCHAR, 
         url VARCHAR, 
         published TIMESTAMP WITHOUT TIME ZONE, 
         image VARCHAR, 
         images VARCHAR, 
         learning VARCHAR, 
         tech VARCHAR, 
         tools VARCHAR, 
         id SERIAL, 
        created_at TIMESTAMP WITHOUT TIME ZONE, 
        updated_at TIMESTAMP WITHOUT TIME ZONE, 
        PRIMARY KEY (id)
 )

我了解到 postgres 有一些数组类型，例如:integer[] 和 text[] 可以处理类别和图像字段的这种情况。尝试手动更改表列类型，结果相同。

尝试将类别和图像发布为 str:

    {
  "detail": [
    {
      "loc": [
        "body",
        "category"
      ],
      "msg": "value is not a valid set",
      "type": "type_error.set"
    },
    {
      "loc": [
        "body",
        "images"
      ],
      "msg": "value is not a valid list",
      "type": "type_error.list"
    }
  ]
}

如果不能使用如此惊人的功能来清理我收到的数据，那将是多么令人难过。我在互联网上查找，但找不到任何相关内容或使用 List 和 Set with SQLModel 的示例

¿我可以做些什么来支持这种情况？

PD:我也在使用 asyncpg

Answer 1

我让它适用于列表，但不适用于 postgres 数据库上的集合。问题在于何时将结果映射回您的 Project 类。这是我的完整代码。

from datetime import datetime
from typing import List, Optional, Set
from sqlalchemy.sql.schema import Column
from sqlmodel import SQLModel, Field, create_engine, Session, select, String, ARRAY 
from fastapi import FastAPI

class ProjectBase(SQLModel):
    name: Optional[str]
    category: Set[str] = Field(default=None, sa_column=Column(ARRAY(String())))
    images: List[str] = Field(default=None, sa_column=Column(ARRAY(String())))


class Project(ProjectBase, table=True):
    id: int = Field(default=None, primary_key=True)

engine = create_engine("postgresql://postgres:mysecretpassword@localhost:5432/testdb")

new_proj = Project(
    name=f"{str(datetime.time(datetime.utcnow()))}", 
    category=("hi", "hello", "cat3"), 
    images=["img1", "img2"] 
)

app = FastAPI()

@app.on_event("startup")
def on_startup():
    SQLModel.metadata.create_all(engine)
    print("BEFORE REFRESH:", new_proj)
    with Session(engine) as session:
        session.add(new_proj)
        session.commit()
        session.refresh(new_proj)
    print("AFTER REFRESH:", new_proj)

@app.get("/", response_model=List[Project])
def home():
    with Session(engine) as session:
        projects = session.exec(select(Project)).all()
        return projects

我稍微简化了您的 Project 类。在启动 uvicorn 运行它时，我得到以下输出(引用 @app.on_event("startup")):

BEFORE REFRESH: name='17:17:38.090595' category={'hoi', 'cat3', 'hello'} images=['img1', 'img2'] id=None
AFTER REFRESH: id=7 category=['hoi', 'cat3', 'hello'] images=['img1', 'img2'] name='17:17:38.090595'

注意category值的区别，对象从数据库刷新前以{(表示集合)开头，对象从数据库刷新后以[开头。

我尝试了各种方法，但都无济于事。我唯一能想到的(但找不到任何相关信息)是 sqlalchemy 的某种自定义映射规则。我对那个包裹的了解还不够，但无法真正理解我在寻找什么。希望这至少有帮助!无论哪种方式，我都学到了很多东西:)