如何利用Python的dataclasses模块在3.7+中快速定义数据类?

星墨酱_9622

星墨酱_9622

2026-07-26

379人浏览

原创

@dataclass 自动生成__init__、__repr__、__eq__,但要求字段必须有类型注解,禁用可变默认值,frozen=true启用只读和__slots__,asdict/astuple不递归处理嵌套dataclass。

如何利用python的dataclasses模块在3.7+中快速定义数据类?

直接用 @dataclass 装饰器,不用写 __init__、__repr__、__eq__ —— 这些都会自动生成,但得注意字段顺序、可变默认值和冻结行为这些坑。

字段必须有类型注解,否则不会被识别为 dataclass 字段

Python 3.7+ 的 @dataclass 依赖类型提示来推断字段。没有类型注解的变量(哪怕写了 field())会被忽略,不参与初始化或序列化。

常见错误:写成这样,name 和 age 不会进 __init__:

from dataclasses import dataclass
<p>@dataclass
class Person:
name  # ❌ 没类型,不算字段
age   # ❌ 同上
city: str = "Beijing"
</p>

正确写法:

  • 所有字段必须带类型注解,如 name: str、scores: list[float]
  • 可选字段要用 Optional[] 并配默认值:nickname: Optional[str] = None
  • 想跳过某些变量(比如运行时缓存),加 init=False:cache: dict = field(init=False, default_factory=dict)

别用可变对象(list/dict)当默认值,用 default_factory

直接写 items: list = [] 会触发经典“可变默认参数”陷阱:所有实例共享同一个 list。

错误示例:

@dataclass
class BadCart:
    items: list = []  # ❌ 危险!
<p>c1 = BadCart()
c2 = BadCart()
c1.items.append("apple")
print(c2.items)  # 输出 ['apple'] —— 不是预期结果
</p>

正确做法:

Forge — Python Developer
Forge — Python Developer

Python开发助手 — 自动化脚本、API封装、命令行工具、数据管道、网页爬虫。经过测试的代码,包含错误处理和文档。当你需要...

下载
  • 用 field(default_factory=list) 或 field(default_factory=lambda: [1, 2])
  • 内置类型优先用简写:items: list = field(default_factory=list)
  • 自定义类也一样:config: dict = field(default_factory=dict)

需要不可变实例?设 frozen=True,但注意性能和继承限制

frozen=True 会让实例变成只读(类似 namedtuple),赋值会抛 dataclasses.FrozenInstanceError。

但要注意:

  • 字段仍可被 object.__setattr__ 绕过(调试时有用,但不是设计意图)
  • 启用 frozen=True 后,__slots__ 自动开启,内存更省,但类不能有 __dict__
  • 父类设了 frozen=True,子类也必须设,否则报错;反过来则允许
  • 如果字段本身是可变对象(如 list),frozen 只锁引用,不锁内容 —— 你仍能调 .append()

asdict() 和 astuple() 不递归处理嵌套 dataclass,要小心序列化

这两个函数默认只展开一层,嵌套的 @dataclass 实例不会自动转成 dict/tuple,而是保持原对象。

例如:

@dataclass
class Address:
    street: str
<p>@dataclass
class User:
name: str
addr: Address</p><p>u = User("Alice", Address("Main St"))
print(asdict(u))  # {'name': 'Alice', 'addr': Address(street='Main St')} ❌
</p>

解决方式:

  • 手动递归:传 dict_factory 参数,或自己写遍历逻辑
  • 用第三方库如 dataclasses-json 或 pydantic(后者更重,但开箱支持嵌套)
  • 简单场景下,给嵌套类也加 asdict 方法并组合调用

真正用起来,@dataclass 省事是真省,但类型注解、默认值、冻结、嵌套这四块最容易漏看文档就掉坑里。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4564

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

26937

23

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

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

2023.08.04

3267

5

python eval
python eval

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

2023.08.04

3267

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2543

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习