如何在 Pydantic 中创建无需关键字参数的自定义类型

云静同学_4475

云静同学_4475

2026-07-26

971人浏览

原创

如何在 Pydantic 中创建无需关键字参数的自定义类型

本文介绍如何使用 Pydantic 数据类(@dataclass)实现简洁、可验证的字符串枚举式类型,支持位置参数初始化(如 DataType("type1")),避免冗余的 value= 键名,同时保持类型安全与运行时校验。

本文介绍如何使用 pydantic 数据类(`@dataclass`)实现简洁、可验证的字符串枚举式类型,支持位置参数初始化(如 `datatype("type1")`),避免冗余的 `value=` 键名,同时保持类型安全与运行时校验。

在构建类型安全的数据处理系统时,我们常需约束字符串取值范围(如 "type1"、"type2" 等),但直接使用 Literal 存在维护痛点:新增类型需全局更新所有类型注解,违反 DRY 原则。虽然 Enum 是标准解法,但若你明确倾向非枚举方案(例如需保留纯字符串语义、避免 .name/.value 访问开销,或兼容已有字符串协议),Pydantic 提供了更灵活的替代路径。

推荐方案:Pydantic 数据类(@dataclass)
Pydantic 的 @dataclass 装饰器在保留数据类语义的同时,自动注入运行时验证逻辑,并天然支持位置参数初始化——这正是你所需的关键特性:

from typing import Literal
from pydantic.dataclasses import dataclass

@dataclass
class DataType:
    value: Literal["type1", "type2", "type3", "type4"]

# ✅ 位置参数调用,简洁直观
dt = DataType("type2")
print(dt.value)  # "type2"

# ❌ 非法值触发 ValidationError(含清晰错误信息)
try:
    invalid = DataType("oopsy")
except Exception as e:
    print(f"Validation failed: {e}")

该方式相比继承 BaseModel 的类有三大优势:

超级小说家
超级小说家

超级小说家是专为网文作家和短剧编剧打造的AI创作助手。

下载
  • 无关键字强制要求:构造时直接传入值,无需 value=;
  • 零配置验证:Literal 类型约束自动生效,无需额外 @field_validator;
  • 类型提示友好:IDE 和类型检查器(如 mypy)能正确推导 DataType 实例的 .value 属性类型为 Literal[...]。

⚠️ 注意事项:

  • 确保安装 Pydantic v2.x(pip install pydantic),v1 不支持此用法;
  • 若需动态管理合法值(如从配置加载),可结合 typing.get_args 与 Literal[*VALID_DATA_TYPES] 构建,但需注意 Literal 的参数必须是编译期常量;
  • 此方案仍生成实例对象(而非原始字符串),如需“透明包装”,可为 DataType 添加 __str__ 和 __eq__ 方法增强可用性。

综上,@dataclass 是平衡类型严谨性、API 简洁性与工程可维护性的理想选择——它既规避了 Enum 的语义侵入,又解决了 BaseModel 的调用冗余,真正让类型即契约、构造即验证。

相关文章

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

4504

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

26477

23

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

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

2023.08.04

3207

5

python eval
python eval

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

2023.08.04

3227

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

2503

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程