Extra Models

继续前面的示例，通常会有多个相关的模型。

对于用户模型尤其如此，因为：

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

Danger

切勿存储用户的明文密码。始终存储可验证的"安全哈希"。

如果你不了解，可以在安全章节中学习什么是"密码哈希"。

多个模型

以下是这些模型及其密码字段和使用场景的大致思路：

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.dict(), 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

🤓 Other versions and variants

Python 3.8+

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.dict(), 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

Info

在 Pydantic v1 中，该方法名为 .dict()，在 Pydantic v2 中已被弃用（但仍支持），并重命名为 .model_dump()。

此处的示例使用 .dict() 以保持与 Pydantic v1 的兼容性，但如果你可以使用 Pydantic v2，则应使用 .model_dump()。

关于 **user_in.dict()

Pydantic 的 .dict()

user_in 是一个 Pydantic 模型类 UserIn 的实例。

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

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

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

然后调用：

user_dict = user_in.dict()

现在我们有一个包含数据的 dict 存储在变量 user_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.dict() 获取了 user_dict，这段代码：

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

将等同于：

UserInDB(**user_in.dict())

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

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

解包 dict 和额外关键字参数

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

UserInDB(**user_in.dict(), 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,
)

Warning

辅助函数 fake_password_hasher 和 fake_save_user 仅用于演示数据流的可能方式，但它们当然不提供任何实际的安全性。

减少重复

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

因为代码重复会增加错误、安全问题、代码不同步问题（当你在一处更新但未在其他处更新）等的可能性。

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

我们可以做得更好。

我们可以声明一个 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.dict(), 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

🤓 Other versions and variants

Python 3.8+

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.dict(), 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：

Note

定义 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]

🤓 Other versions and variants

Python 3.8+

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

🤓 Other versions and variants

Python 3.8+

from typing import List

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}

🤓 Other versions and variants

Python 3.8+

from typing import Dict

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 和无密码状态的情况。