如何使用 FastAPI 从 Pydantic model 中排除可选的未设置值？

Question

我有这个 model：

class Text(BaseModel):
    id: str
    text: str = None


class TextsRequest(BaseModel):
    data: list[Text]
    n_processes: Union[int, None]

所以我希望能够接受如下请求：

{"data": ["id": "1", "text": "The text 1"], "n_processes": 8} 

和

{"data": ["id": "1", "text": "The text 1"]}.

现在在第二种情况下我得到

{'data': [{'id': '1', 'text': 'The text 1'}], 'n_processes': None}

使用此代码：

app = FastAPI()

@app.post("/make_post/", response_model_exclude_none=True)
async def create_graph(request: TextsRequest):
    input_data = jsonable_encoder(request)

那么如何在这里排除n_processes呢？

Answer 1

您可以使用dict()的exclude_none参数：

class Text(BaseModel):
    id: str
    text: str = None


class TextsRequest(BaseModel):
    data: list[Text]
    n_processes: Optional[int]



request = TextsRequest(**{"data": [{"id": "1", "text": "The text 1"}]})
print(request.dict(exclude_none=True))

Output：

{'data': [{'id': '1', 'text': 'The text 1'}]}

此外，写Optional[int]而不是Union[int, None]更惯用

Answer 2

Pydantic 提供以下 arguments 用于使用model.dict(...)方法导出模型：

exclude_unset ：是否应从返回的字典中排除在创建 model 时未明确设置的字段； 默认False

exclude_none ：是否应该从返回的字典中排除等于 None 的字段； 默认False

由于您指的是排除可选的未设置参数，因此您可以使用第一种方法（即exclude_unset ）。 当一个参数没有设置为某个值或None时，这很有用。

但是， exclude_none参数忽略了一个属性可能已被有意设置为None的事实，因此将其从返回的字典中排除。

例子：

from pydantic import BaseModel
from typing import List, Union

class Text(BaseModel):
    id: str
    text: str = None

class TextsRequest(BaseModel):
    data: List[Text]    # in Python 3.9+ you can use:  data: list[Text]
    n_processes: Union[int, None] = None

t = TextsRequest(**{'data': [{'id': '1', 'text': 'The text 1'}], 'n_processes': None})
print(t.dict(exclude_none=True))
#> {'data': [{'id': '1', 'text': 'The text 1'}]}
print(t.dict(exclude_unset=True))
#> {'data': [{'id': '1', 'text': 'The text 1'}], 'n_processes': None}

关于可选参数

使用Union[int, None]与使用Optional[int] = None或int | None相同。 int | None （在 Python 3.10+ 中）。 但是，根据FastAPI 文档（请参阅提供的链接中的警告说明和信息）：

笔记

FastAPI 将知道q的值不是必需的，因为默认值= None 。

Union Union[str, None]中的 Union 将允许您的编辑器为您提供更好的支持并检测错误。

信息

请记住，使参数成为可选的最重要部分是 part: = None ，因为它将使用None作为默认值，并且这样使参数不是 required 。

Union[str, None]部分允许您的编辑器提供更好的支持，但这并不是告诉 FastAPI这个参数不是必需的。

因此，无论选项（即Union 、 Optional等）如何决定使用，如果它后面= None部分，FastAPI 将不知道参数的值是不需要的，因此，用户必须为其提供一些价值。 也可以通过自动生成的 API 文档在http://127.0.0.1:8000/docs中检查这一点，其中parameter或request body将显示为Required字段。

例如：

@app.post("/upload")
def upload(t: Union[TextsRequest, None]):
def upload(t: Optional[TextsRequest]):
def upload(t: TextsRequest | None):

以上任何一项都需要用户在他们的请求中为TextsRequest model 传递一些正文。 但是，如果上面的TextsRequest定义由= None成功（例如， t: Union[TextsRequest, None] = None ，或者甚至只是t: TextsRequest = None ），则parameter或body将是optional的（因为= None会告诉FastAPI 表示此参数不是必需的）。