pydantic 模型中的对象属性列表

Question

我使用 Fast API 创建 Web 服务。

有以下 sqlAlchemy 模型：

class User(Base):
    __tablename__ = 'user'
    account_name = Column(String, primary_key=True, index=True, unique=True)
    email = Column(String, unique=True, index=True, nullable=False)
    roles = relationship("UserRole", back_populates="users", lazy=False, uselist=True)


class UserRole(Base):
    __tablename__ = 'user_role'
    __table_args__ = (UniqueConstraint('role_name', 'user_name', name='user_role_uc'),)
    role_name = Column(String, ForeignKey('role.name'), primary_key=True)
    user_name = Column(String, ForeignKey('user.account_name'), primary_key=True)
    users = relationship("User", back_populates="roles")

Pydantic 架构如下：

class UserRole(BaseModel):
    role_name: str

    class Config:
        orm_mode = True


class UserBase(BaseModel):
    account_name: str
    email: EmailStr
    roles: List[UserRole] = []

    class Config:
        orm_mode = True

我现在拥有的是：

{
  "account_name": "Test.Test",
  "email": "Test.Test@test.com",
  "roles": [
    {
      "role_name": "all:admin"
    },
    {
      "role_name": "all:read"
    }
  ]
}

我想要实现的是在以下结构中从 api 获取用户：

{
  "account_name": "Test.Test",
  "email": "Test.Test@test.com",
  "roles": [
    "all:admin",
    "all:read"
  ]
}

这可能吗？我应该如何更改架构才能获得此信息？

Answer 1

由于 UserRole 是一个 class，它被表示为一个对象（使用字典）。如果您想将其表示为字符串列表，则必须转换数据（并更改 Pydantic 模型的字段声明）。有几种方法可以解决这个问题，但 pydantic 模型 documentation 是一个很好的起点。请注意，ORM 模型用作数据表示层，而 pydantic 模型是验证（可能还有序列化）层，因此有很多地方可以 'hook in'.

Answer 2

如果你还好处理如何“从 api 获取用户”问题陈述通过修改 fastapi 路径定义，见下文。

你能改变快速api路径定义使用的响应模型吗为了处理所需的输出格式？

示例 pydantic 响应模型定义：

class UserResponse(BaseModel):
    account_name: str
    email: EmailStr
    roles: List[str]

sqlalchemy 查询 + 序列化函数示例：

def get_user_response(user_id) -> UserResponse:
    user = User.query.get(user_id)
    user_roles = UserRole.query.filter(user=user_id).all()
    role_names = [r.role_name for r in user_roles]
    response = UserResponse(
        account_name=user.account_name,
        email=user.email,
        roles=role_names
    }
    return response

示例快速api路径定义：

@app.get("/users/{user_id}", response_model=UserResponse)
async def read_item(user_id):
    return get_user_response(user_id)

注意事项：

我正在为用户查询使用 user_id，但这可以替换为您最终用作该 table.
UserResponse 响应模型与 UserBase 非常相似（您可能 subclass UserBase 而不是模型以避免重新定义 account_name 和 email，权衡必须覆盖 class' Config).
可能有一种方法可以覆盖 UserBase 的序列化格式从数据库查询模型时自动序列化的 sqlalchemy 模型对象并允许您消除或减少上面示例定义中 get_user_response() 函数中的代码。

pydantic 模型中的对象属性列表

List of object attributes in pydantic model

python

sqlalchemy

pydantic

fastapi