附加模型

继续前面的例子，拥有多个相关模型将是很常见的。

用户模型尤其如此，因为

• 输入模型 需要能够包含密码。
• 输出模型 则不应该包含密码。
• 数据库模型 可能需要一个哈希后的密码。

危险

切勿存储用户的明文密码。始终存储一个“安全哈希”，您之后可以用来验证。

如果您不知道，“密码哈希”是什么，您将在 安全章节 中学习。

多个模型

以下是这些模型可能具有的密码字段以及它们被使用的地方的大致概念：

Python 3.10+

from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()


class UserIn(BaseModel):
    username: str
    password: str
    email: EmailStr
    full_name: str | None = None


class UserOut(BaseModel):
    username: str
    email: EmailStr
    full_name: str | None = None


class UserInDB(BaseModel):
    username: str
    hashed_password: str
    email: EmailStr
    full_name: str | None = None


def fake_password_hasher(raw_password: str):
    return "supersecret" + raw_password


def fake_save_user(user_in: UserIn):
    hashed_password = fake_password_hasher(user_in.password)
    user_in_db = UserInDB(**user_in.model_dump(), hashed_password=hashed_password)
    print("User saved! ..not really")
    return user_in_db


@app.post("/user/", response_model=UserOut)
async def create_user(user_in: UserIn):
    user_saved = fake_save_user(user_in)
    return user_saved

🤓 其他版本和变体

Python 3.9+

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()


class UserIn(BaseModel):
    username: str
    password: str
    email: EmailStr
    full_name: Union[str, None] = None


class UserOut(BaseModel):
    username: str
    email: EmailStr
    full_name: Union[str, None] = None


class UserInDB(BaseModel):
    username: str
    hashed_password: str
    email: EmailStr
    full_name: Union[str, None] = None


def fake_password_hasher(raw_password: str):
    return "supersecret" + raw_password


def fake_save_user(user_in: UserIn):
    hashed_password = fake_password_hasher(user_in.password)
    user_in_db = UserInDB(**user_in.model_dump(), hashed_password=hashed_password)
    print("User saved! ..not really")
    return user_in_db


@app.post("/user/", response_model=UserOut)
async def create_user(user_in: UserIn):
    user_saved = fake_save_user(user_in)
    return user_saved

关于 **user_in.model_dump()

Pydantic 的 .model_dump()

user_in 是一个 UserIn 类的 Pydantic 模型。

Pydantic 模型有一个 .model_dump() 方法，它返回一个包含模型数据的 dict。

因此，如果我们创建一个 Pydantic 对象 user_in 如下：

user_in = UserIn(username="john", password="secret", email="john.doe@example.com")

然后我们调用：

user_dict = user_in.model_dump()

我们现在在变量 user_dict 中拥有一个包含数据的 dict（它是一个 dict 而不是 Pydantic 模型对象）。

如果我们调用：

print(user_dict)

我们将得到一个 Python dict，其中包含：

{
    'username': 'john',
    'password': 'secret',
    'email': 'john.doe@example.com',
    'full_name': None,
}

解包 dict

如果我们取一个像 user_dict 这样的 dict 并使用 **user_dict 将其传递给一个函数（或类），Python 将会“解包”它。它将 user_dict 的键和值直接作为关键字参数传递。

因此，继续上面的 user_dict，编写：

UserInDB(**user_dict)

将等同于：

UserInDB(
    username="john",
    password="secret",
    email="john.doe@example.com",
    full_name=None,
)

或者更确切地说，直接使用 user_dict，无论它未来可能包含什么内容：

UserInDB(
    username = user_dict["username"],
    password = user_dict["password"],
    email = user_dict["email"],
    full_name = user_dict["full_name"],
)

从另一个模型的内容创建 Pydantic 模型

正如我们在上面的示例中从 user_in.model_dump() 获得 user_dict 一样，这段代码：

user_dict = user_in.model_dump()
UserInDB(**user_dict)

将等同于：

UserInDB(**user_in.model_dump())

…因为 user_in.model_dump() 是一个 dict，然后我们通过在前面加上 ** 将其传递给 UserInDB 来让 Python“解包”它。

因此，我们从另一个 Pydantic 模型的数据中获得了 Pydantic 模型。

解包 dict 和额外的关键字参数

然后添加额外的关键字参数 hashed_password=hashed_password，例如：

UserInDB(**user_in.model_dump(), hashed_password=hashed_password)

…最终会像这样：

UserInDB(
    username = user_dict["username"],
    password = user_dict["password"],
    email = user_dict["email"],
    full_name = user_dict["full_name"],
    hashed_password = hashed_password,
)

警告

支持的附加函数 fake_password_hasher 和 fake_save_user 只是为了演示数据的可能流程，但它们当然不提供任何真正的安全性。

减少重复

减少代码重复是 FastAPI 的核心思想之一。

因为代码重复会增加发生 bug、安全问题、代码不同步问题（您在一个地方更新了，但没有在其他地方更新）等的几率。

这些模型都共享大量数据，并且重复了属性名称和类型。

我们可以做得更好。

我们可以声明一个 UserBase 模型，作为我们其他模型的基类。然后我们可以创建该模型的子类，继承其属性（类型声明、验证等）。

所有数据转换、验证、文档等将照常工作。

这样，我们可以只声明模型之间的差异（带有明文 password，带有 hashed_password，以及没有密码）。

Python 3.10+

from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()


class UserBase(BaseModel):
    username: str
    email: EmailStr
    full_name: str | None = None


class UserIn(UserBase):
    password: str


class UserOut(UserBase):
    pass


class UserInDB(UserBase):
    hashed_password: str


def fake_password_hasher(raw_password: str):
    return "supersecret" + raw_password


def fake_save_user(user_in: UserIn):
    hashed_password = fake_password_hasher(user_in.password)
    user_in_db = UserInDB(**user_in.model_dump(), hashed_password=hashed_password)
    print("User saved! ..not really")
    return user_in_db


@app.post("/user/", response_model=UserOut)
async def create_user(user_in: UserIn):
    user_saved = fake_save_user(user_in)
    return user_saved

🤓 其他版本和变体

Python 3.9+

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()


class UserBase(BaseModel):
    username: str
    email: EmailStr
    full_name: Union[str, None] = None


class UserIn(UserBase):
    password: str


class UserOut(UserBase):
    pass


class UserInDB(UserBase):
    hashed_password: str


def fake_password_hasher(raw_password: str):
    return "supersecret" + raw_password


def fake_save_user(user_in: UserIn):
    hashed_password = fake_password_hasher(user_in.password)
    user_in_db = UserInDB(**user_in.model_dump(), hashed_password=hashed_password)
    print("User saved! ..not really")
    return user_in_db


@app.post("/user/", response_model=UserOut)
async def create_user(user_in: UserIn):
    user_saved = fake_save_user(user_in)
    return user_saved

Union 或 anyOf

您可以声明一个响应是两个或多个类型的 Union，这意味着响应可以是其中任何一个。

它将在 OpenAPI 中定义为 anyOf。

为此，请使用标准的 Python 类型提示 typing.Union。

注意

在定义 Union 时，先包含最具体的类型，然后是次具体的类型。在下面的示例中，更具体的 PlaneItem 出现在 Union[PlaneItem, CarItem] 的 CarItem 之前。

Python 3.10+

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class BaseItem(BaseModel):
    description: str
    type: str


class CarItem(BaseItem):
    type: str = "car"


class PlaneItem(BaseItem):
    type: str = "plane"
    size: int


items = {
    "item1": {"description": "All my friends drive a low rider", "type": "car"},
    "item2": {
        "description": "Music is my aeroplane, it's my aeroplane",
        "type": "plane",
        "size": 5,
    },
}


@app.get("/items/{item_id}", response_model=Union[PlaneItem, CarItem])
async def read_item(item_id: str):
    return items[item_id]

🤓 其他版本和变体

Python 3.9+

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class BaseItem(BaseModel):
    description: str
    type: str


class CarItem(BaseItem):
    type: str = "car"


class PlaneItem(BaseItem):
    type: str = "plane"
    size: int


items = {
    "item1": {"description": "All my friends drive a low rider", "type": "car"},
    "item2": {
        "description": "Music is my aeroplane, it's my aeroplane",
        "type": "plane",
        "size": 5,
    },
}


@app.get("/items/{item_id}", response_model=Union[PlaneItem, CarItem])
async def read_item(item_id: str):
    return items[item_id]

Python 3.10 中的 Union

在此示例中，我们将 Union[PlaneItem, CarItem] 作为 response_model 参数的值传递。

因为我们将其作为参数的值传递，而不是将其放入类型注解中，所以即使在 Python 3.10 中，我们也必须使用 Union。

如果它在类型注解中，我们可以使用竖线，如：

some_variable: PlaneItem | CarItem

但是如果我们将其放入赋值 response_model=PlaneItem | CarItem，我们将收到一个错误，因为 Python 会尝试在 PlaneItem 和 CarItem 之间执行无效操作，而不是将其解释为类型注解。

模型列表

同样，您可以声明对象列表的响应。

为此，请使用标准的 Python typing.List（或 Python 3.9 及更高版本中的 list）。

Python 3.9+

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: str


items = [
    {"name": "Foo", "description": "There comes my hero"},
    {"name": "Red", "description": "It's my aeroplane"},
]


@app.get("/items/", response_model=list[Item])
async def read_items():
    return items

响应为任意 dict

您还可以使用普通的任意 dict 来声明响应，只声明键和值的类型，而不使用 Pydantic 模型。

这很有用，如果您事先不知道有效字段/属性名称（对于 Pydantic 模型而言是必需的）。

在这种情况下，您可以使用 typing.Dict（或 Python 3.9 及更高版本中的 dict）。

Python 3.9+

from fastapi import FastAPI

app = FastAPI()


@app.get("/keyword-weights/", response_model=dict[str, float])
async def read_keyword_weights():
    return {"foo": 2.3, "bar": 3.4}

总结

为每种情况使用多个 Pydantic 模型并自由继承。

如果某个实体必须能够拥有不同的“状态”，则不必为每个实体都拥有单个数据模型。例如，用户“实体”的状态包含 password、password_hash 和没有密码。