Python dataclass 基本使用指南

2024-06-13
北京
本文字数：1443 字
阅读完需：约 5 分钟

什么是 dataclass？

dataclass是 Python 标准库中的一个装饰器，用于简化数据类的定义。数据类通常是一些用于存储多个属性的类，传统定义方式需要编写大量的初始化代码和其他方法。dataclass通过自动生成这些代码，极大地减少了开发者的工作量。

基本使用

定义一个简单的数据类非常容易。下面是一个例子，展示了如何使用dataclass定义一个用于存储点坐标的类。

from dataclasses import dataclass
@dataclassclass Point:    x: int    y: int
point = Point(10, 20)print(point)  # 输出: Point(x=10, y=20)

复制代码

在这个例子中，我们使用@dataclass装饰器来定义一个名为Point的类。这个类有两个属性：x和y，它们都是整数。dataclass自动为我们生成了初始化方法和__repr__方法，使得实例化和打印变得非常简单。

默认值

我们可以为数据类的属性指定默认值。如果一个属性有默认值，它必须在所有没有默认值的属性之后。

from dataclasses import dataclass
@dataclassclass Point:    x: int = 0    y: int = 0
point = Point()print(point)  # 输出: Point(x=0, y=0)

复制代码

在这个例子中，Point类的属性x和y都有默认值0，因此可以在实例化时省略这些参数。

可变默认值

对于可变类型（如列表或字典）的默认值，应该使用field函数和default_factory参数，以避免共享可变默认值带来的问题。

from dataclasses import dataclass, fieldfrom typing import List
@dataclassclass Inventory:    items: List[str] = field(default_factory=list)
inventory = Inventory()inventory.items.append("item1")print(inventory)  # 输出: Inventory(items=['item1'])
another_inventory = Inventory()print(another_inventory)  # 输出: Inventory(items=[])

复制代码

在这个例子中，每个 Inventory 实例都会有一个独立的 items 列表。

自动生成的方法

dataclass不仅会自动生成__init__和__repr__方法，还会生成__eq__方法，使得实例之间可以通过比较其属性值来判断是否相等。

from dataclasses import dataclass
@dataclassclass Point:    x: int    y: int
point1 = Point(10, 20)point2 = Point(10, 20)print(point1 == point2)  # 输出: True

复制代码

自定义方法

尽管dataclass自动生成了许多方法，我们仍然可以定义自己的方法。

from dataclasses import dataclass
@dataclassclass Point:    x: int    y: int
    def distance_to_origin(self) -> float:        return (self.x ** 2 + self.y ** 2) ** 0.5
point = Point(3, 4)print(point.distance_to_origin())  # 输出: 5.0

复制代码

冻结数据类

如果希望数据类的实例是不可变的，可以使用frozen=True参数，这样会禁止对实例属性的修改。

from dataclasses import dataclass
@dataclass(frozen=True)class Point:    x: int    y: int
point = Point(10, 20)# point.x = 5  # 会引发错误: dataclasses.FrozenInstanceError: cannot assign to field 'x'

复制代码

dataclass是 Python 中一个非常实用的特性，能够显著简化数据类的定义和使用。通过本文的介绍，你应该已经掌握了dataclass的基本使用方法以及一些高级特性。在实际开发中，合理使用dataclass可以提高代码的可读性和维护性，减少样板代码的编写。

发布于: 刚刚阅读数: 5

测吧(北京)科技有限公司

关注

社区：ceshiren.com 微信：ceshiren2023 2022-08-29 加入

微信公众号：霍格沃兹测试开发提供性能测试、自动化测试、测试开发等资料、实事更新一线互联网大厂测试岗位内推需求，共享测试行业动态及资讯，更可零距离接触众多业内大佬

发布

暂无评论

创作场景

Python dataclass 基本使用指南

更多软件测试学习资料戳

什么是 dataclass？

基本使用

默认值

可变默认值

自动生成的方法

自定义方法

冻结数据类

测吧(北京)科技有限公司

评论