Pydantic 中如何为 Literal 字段处理空字符串并自动回退到默认值

大磊酱_3306

大磊酱_3306

2026-04-12

475人浏览

原创

Pydantic 中如何为 Literal 字段处理空字符串并自动回退到默认值

当 Pydantic 字段使用 Literal 类型(如 "enabled" | "disabled")时,空字符串 "" 会直接触发类型校验失败,而非应用默认值;本文介绍通过 @field_validator(mode="before") 在解析前拦截并替换空值,实现优雅的默认值回退机制。

当 pydantic 字段使用 literal 类型(如 `"enabled" | "disabled"`)时,空字符串 `""` 会直接触发类型校验失败,而非应用默认值;本文介绍通过 `@field_validator(mode="before")` 在解析前拦截并替换空值,实现优雅的默认值回退机制。

在 Pydantic v2+ 中,Literal 类型字段对输入值执行严格字面量匹配——这意味着只有精确等于 "enabled" 或 "disabled" 的字符串才可通过校验;而空字符串 ""、None 或其他任意字符串均会被立即拒绝,并抛出 literal_error,甚至不会进入自定义验证器逻辑(这也是你发现 @validator 完全未被调用的原因)。

要解决该问题,关键在于:在 Pydantic 内置类型校验发生之前,预先处理非法但语义可修复的输入(如空字符串)。这正是 mode="before" 验证器的设计目的。

以下为完整、可运行的解决方案:

from pydantic import BaseModel, Field, field_validator
from typing_extensions import Annotated, Literal

ENABLED_DISABLED = Literal["disabled", "enabled"]


class GlobalSchema(BaseModel):
    location: Annotated[
        ENABLED_DISABLED,
        Field(description="Location: 'enabled' or 'disabled'")
    ] = "disabled"

    @field_validator("location", mode="before")
    def validate_location(cls, value):
        # 若输入为空字符串,主动替换为字段默认值
        if value == "":
            return cls.model_fields["location"].default
        return value  # 其他值交由后续内置校验(Literal 检查)

✅ 效果验证:

# 空字符串 → 自动转为默认值 "disabled"
print(GlobalSchema(location=""))  # location='disabled'

# 合法值 → 正常通过
print(GlobalSchema(location="enabled"))  # location='enabled'

# 非法值 → 抛出清晰错误(保留原始校验逻辑)
try:
    GlobalSchema(location="foo")
except Exception as e:
    print(e)
# 输出包含:Input should be 'disabled' or 'enabled'

⚠️ 注意事项:

  • 必须使用 mode="before"(Pydantic v2 推荐写法),旧版 @validator(..., pre=True) 已弃用;
  • 不要尝试在 mode="after" 或普通验证器中修复——此时校验早已失败,无法抵达;
  • cls.model_fields["location"].default 是获取字段默认值的安全方式(支持 Field(default=...) 和直接赋值两种声明);
  • 若需同时处理 None、空白字符串(如 " ")或 0 等,可在 before 验证器中扩展判断逻辑,但需谨慎避免掩盖真实错误输入。

总结:Pydantic 的校验流程是分阶段的,mode="before" 是干预原始输入的“第一道闸门”。合理利用它,既能保持类型安全,又能赋予字段更健壮的容错能力。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1751

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4464

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1709

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

26217

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3187

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3207

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1183

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2483

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习