FastAPI 中实现字符串到布尔值的类型转换

本文将详细介绍如何在 FastAPI 应用中，优雅地实现字符串到布尔值的类型转换。在实际开发中，我们经常需要接收来自外部服务的请求，这些请求可能携带字符串类型的参数，而我们的应用需要将其转换为布尔类型进行处理。例如，一个查询参数可能传递 "true" 或 "false" 来表示一个开关状态。

通常情况下，直接将字符串赋值给布尔类型的 Pydantic 模型字段会引发错误。为了解决这个问题，我们可以利用 Pydantic 的自定义验证器功能，创建一个能够将特定字符串转换为布尔值的验证器。

自定义字符串到布尔值的转换函数

首先，我们需要定义一个函数，该函数接收一个字符串作为输入，并返回一个布尔值。这个函数负责将各种表示真假的字符串转换为 True 或 False。

from typing import Annotated
from pydantic import BaseModel
from pydantic.functional_validators import PlainValidator

def str_to_bool(v: str) -> bool:
    """
    将字符串转换为布尔值。
    支持的字符串包括：'y', 'yes', 'on', '1', 'enabled', 'true' (转换为 True)
    以及 'n', 'no', 'off', '0', 'disabled', 'false' (转换为 False)。
    """
    v = v.strip().lower()
    if v in ["y", "yes", "on", "1", "enabled", "true"]:
        return True
    if v in ["n", "no", "off", "0", "disabled", "false"]:
        return False
    raise ValueError(f"无法将字符串 '{v}' 转换为布尔值。")


ExtendedBool = Annotated[bool, PlainValidator(str_to_bool)]

在这个函数中，我们首先将输入的字符串去除首尾空格并转换为小写，然后检查它是否属于表示真或假的字符串列表。如果匹配到任何一个，就返回相应的布尔值。如果字符串不在任何一个列表中，则抛出一个 ValueError 异常，表明无法进行转换。

在 Pydantic 模型中使用自定义验证器

接下来，我们需要在 Pydantic 模型中使用这个自定义验证器。我们可以使用 Annotated 类型提示将验证器应用到模型字段上。

from typing import Optional

class Misc(BaseModel):
    # - whether to pop-up checkbox ("true" or "false")
    popup: ExtendedBool = False
    # - whether an advertisement is pending to be displayed ("yes" or "no")
    advertPending: ExtendedBool = False

现在，当 FastAPI 接收到包含 popup 或 advertPending 参数的请求时，Pydantic 将会自动使用 str_to_bool 函数将这些参数的值转换为布尔类型。

腾讯智影-AI数字人

基于AI数字人能力，实现7*24小时AI数字人直播带货，低成本实现直播业务快速增增，全天智能在线直播

73

查看详情

FastAPI 示例

下面是一个简单的 FastAPI 示例，展示了如何使用这个 Pydantic 模型：

from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/items/")
async def read_items(misc: Misc = Query(default_factory=Misc)):
    return misc

在这个示例中，我们定义了一个 /items/ 路由，它接收一个 Misc 类型的查询参数。FastAPI 会自动将查询参数的值传递给 Misc 模型的构造函数，并使用我们定义的 str_to_bool 函数进行类型转换。

注意事项

• 确保 str_to_bool 函数能够处理所有可能出现的字符串值。如果接收到无法转换的字符串，函数会抛出 ValueError 异常。
• 可以根据实际需求修改 str_to_bool 函数，添加或删除支持的字符串。
• 使用 Annotated 类型提示可以方便地将自定义验证器应用到 Pydantic 模型字段上。
• default_factory=Misc 确保即使没有传递任何查询参数，也会创建一个默认的 Misc 对象。

总结

通过自定义 Pydantic 验证器，我们可以轻松地将字符串类型的查询参数转换为布尔类型，从而确保数据类型的正确性和程序的健壮性。这种方法不仅灵活，而且易于维护，是处理类型转换问题的理想选择。

以上就是FastAPI 中实现字符串到布尔值的类型转换的详细内容，更多请关注php中文网其它相关文章！