如何编写高效的 Python 数据类

📢 转载信息

原文链接：https://www.kdnuggets.com/how-to-write-efficient-python-data-classes

原文作者：Bala Priya C

作者提供

# 简介

编写高效的Python数据类可以减少样板代码，同时保持代码的整洁。本文将教你如何做到这一点。

标准的Python对象将属性存储在实例字典中。除非手动实现哈希，否则它们是不可哈希的，并且默认情况下会比较所有属性。这种默认行为是合理的，但对于创建大量实例或需要对象作为缓存键的应用程序来说，优化不足。

数据类通过配置而非自定义代码来解决这些限制。你可以使用参数来改变实例的行为和占用的内存量。字段级别的设置还允许你将属性排除在比较之外、为可变值定义安全的默认值，或控制初始化的工作方式。

本文重点介绍那些在不增加复杂性的前提下提高效率和可维护性的关键数据类功能。

你可以在 GitHub 上找到代码。

# 1. 使用 Frozen 数据类实现哈希化和安全性

将数据类设为不可变（immutable）可以提供哈希能力。正如下面所示，这允许你将实例用作字典的键或将它们存储在集合中：

from dataclasses import dataclass @dataclass(frozen=True) class CacheKey: user_id: int resource_type: str timestamp: int cache = {} key = CacheKey(user_id=42, resource_type="profile", timestamp=1698345600) cache[key] = {"data": "expensive_computation_result"}

frozen=True参数使所有字段在初始化后都不可变，并自动实现了__hash__()。如果没有这个参数，当你尝试将实例用作字典键时，会遇到TypeError。

这种模式对于构建缓存层、去重逻辑或任何需要可哈希类型的_数据结构_至关重要。不可变性还防止了一整类错误，即状态被意外修改。

# 2. 使用 Slots 提高内存效率

当你实例化数千个对象时，内存开销会迅速累积。这是一个例子：

from dataclasses import dataclass @dataclass(slots=True) class Measurement: sensor_id: int temperature: float humidity: float

slots=True参数会消除Python通常为每个实例创建的__dict__。不是将属性存储在字典中，而是使用更紧凑的固定大小数组来存储槽。

对于这样一个简单的数据类，你可以为每个实例节省几个字节，并获得更快的属性访问速度。权衡是，你不能动态添加新属性。

# 3. 使用 Field 参数自定义相等性

你通常不需要每个字段都参与相等性检查。在处理元数据或时间戳时尤其如此，如下例所示：

from dataclasses import dataclass, field from datetime import datetime @dataclass class User: user_id: int email: str last_login: datetime = field(compare=False) login_count: int = field(compare=False, default=0) user1 = User(1, "alice@example.com", datetime.now(), 5) user2 = User(1, "alice@example.com", datetime.now(), 10) print(user1 == user2) 

输出：

True

compare=False参数会将该字段排除在自动生成的__eq__()方法之外。

在这里，如果两个用户拥有相同的ID和电子邮件，则认为它们相等，而不管它们登录的时间或次数。这可以防止在比较代表相同逻辑实体但具有不同跟踪元数据时出现不必要的差异。

# 4. 使用 Default Factory 进行工厂函数

在函数签名中使用可变默认值是Python的一个陷阱。数据类提供了一个干净的解决方案：

from dataclasses import dataclass, field @dataclass class ShoppingCart: user_id: int items: list[str] = field(default_factory=list) metadata: dict = field(default_factory=dict) cart1 = ShoppingCart(user_id=1) cart2 = ShoppingCart(user_id=2) cart1.items.append("laptop") print(cart2.items)

default_factory参数接受一个可调用对象，为每个实例生成一个新的默认值。如果没有它，使用items: list = []将会使所有实例共享同一个列表——这是经典的_可变默认值陷阱_！

此模式适用于列表、字典、集合或任何可变类型。你也可以传入自定义工厂函数来进行更复杂的初始化逻辑。

# 5. 初始化后处理

有时你需要在自动生成的__init__运行后派生字段或验证数据。这是使用post_init钩子实现的方法：

from dataclasses import dataclass, field @dataclass class Rectangle: width: float height: float area: float = field(init=False) def __post_init__(self): self.area = self.width * self.height if self.width <= 0 or self.height <= 0: raise ValueError("Dimensions must be positive") rect = Rectangle(5.0, 3.0) print(rect.area)

__post_init__方法在生成的__init__完成后立即运行。area上的init=False参数阻止它成为__init__参数。

此模式非常适合计算字段、验证逻辑或标准化输入数据。你也可以用它来转换字段或建立依赖于多个字段的不变性。

# 6. 使用 Order 参数进行排序

有时，你需要数据类的实例是可排序的。这是一个例子：

from dataclasses import dataclass @dataclass(order=True) class Task: priority: int name: str tasks = [ Task(priority=3, name="Low priority task"), Task(priority=1, name="Critical bug fix"), Task(priority=2, name="Feature request") ] sorted_tasks = sorted(tasks) for task in sorted_tasks: print(f"{task.priority}: {task.name}")

输出：

1: Critical bug fix 2: Feature request 3: Low priority task

order=True参数会根据字段顺序生成比较方法（__lt__, __le__, __gt__, __ge__）。字段从左到右进行比较，因此在此示例中，优先级优先于名称。

此功能允许你自然地对集合进行排序，而无需编写自定义比较逻辑或键函数。

# 7. 字段顺序和 InitVar

当初始化逻辑需要某些值但不希望它们成为实例属性时，可以使用InitVar，如下所示：

from dataclasses import dataclass, field, InitVar @dataclass class DatabaseConnection: host: str port: int ssl: InitVar[bool] = True connection_string: str = field(init=False) def __post_init__(self, ssl: bool): protocol = "https" if ssl else "http" self.connection_string = f"{protocol}://{self.host}:{self.port}" conn = DatabaseConnection("localhost", 5432, ssl=True) print(conn.connection_string) print(hasattr(conn, 'ssl')) 

输出：

https://localhost:5432 False

InitVar类型提示标记了一个参数，该参数传递给__init__和__post_init__，但不会成为一个字段。这使得实例保持干净，同时仍然允许复杂的初始化逻辑。ssl标志影响我们如何构建连接字符串，但之后不需要持久化。

# 何时不使用数据类

数据类并非总是正确的工具。当出现以下情况时不应使用数据类：

• 你需要带有跨多个级别的自定义__init__逻辑的复杂继承层次结构
• 你正在构建具有显著行为和方法的类（对于领域对象应使用常规类）
• 你需要像Pydantic或attrs等库提供的验证、序列化或解析功能
• 你正在处理具有复杂状态管理或生命周期要求的类

数据类最适合用作轻量级数据容器，而不是功能齐全的领域对象。

# 结论

编写高效的数据类关键在于理解其选项如何相互作用，而不是死记硬背所有参数。知道何时以及为何使用每项功能比记住每个参数更重要。

如文章所述，使用不可变性、slots、字段自定义和post-init钩子等功能，可以让你编写出精简、可预测且安全无误的Python对象。这些模式有助于防止错误并减少内存开销，而不会增加复杂性。

通过这些方法，数据类可以让你编写出干净、高效且可维护的代码。祝你编码愉快！

Bala Priya C 是来自印度的一名开发人员和技术作家。她喜欢在数学、编程、数据科学和内容创作的交叉点上工作。她的兴趣和专业领域包括DevOps、数据科学和自然语言处理。她喜欢阅读、写作、编程和咖啡！目前，她正致力于通过撰写教程、操作指南、观点文章等内容来学习并与开发者社区分享她的知识。Bala还创建引人入胜的资源概览和编码教程。

🚀 想要体验更好更全面的AI调用？

欢迎使用青云聚合API，约为官网价格的十分之一，支持300+全球最新模型，以及全球各种生图生视频模型，无需翻墙高速稳定，文档丰富，小白也可以简单操作。