@dataclass的作用

前言

最近在阅读代码时学习到了一种新的用法,在定义类的时候会在上方加入类似@dataclass@classmethod的用法,因此记录梳理下这种用法的含义。

一、 @dataclass

@dataclass的主要作用是可以简化数据类的定义,相比传统定义,可以自动生成__init__, __repr__, __eq__等方法。

举个例子来说,我们定义一个"学生"类,需要存储姓名、年龄、成绩列表,并能方便打印和比较。传统方法如下:

复制代码
class Student:
    def __init__(self, name, age, scores=None):
        self.name = name
        self.age = age
        # 防止所有实例共享同一个列表(经典陷阱)
        if scores is None:
            self.scores = []
        else:
            self.scores = scores[:]

    def __repr__(self):
        return f"Student(name='{self.name}', age={self.age}, scores={self.scores})"

    def __eq__(self, other):
        if not isinstance(other, Student):
            return NotImplemented
        return (self.name == other.name and
                self.age == other.age and
                self.scores == other.scores)

    def average_score(self):
        if not self.scores:
            return 0.0
        return sum(self.scores) / len(self.scores)


# 使用
s1 = Student("小明", 18, [85, 92, 78])
s2 = Student("小明", 18, [85, 92, 78])

print(s1)                    # Student(name='小明', age=18, scores=[85, 92, 78])
print(s1 == s2)              # True
print(s1.average_score())    # 85.0

但是,如果使用@dataclass就可以将代码进行简化

复制代码
from dataclasses import dataclass, field
from typing import List

@dataclass
class Student:
    name: str
    age: int
    scores: List[int] = field(default_factory=list)  # 安全默认值

    def average_score(self):
        if not self.scores:
            return 0.0
        return sum(self.scores) / len(self.scores)


# 使用完全一样
s1 = Student("小明", 18, [85, 92, 78])
s2 = Student("小明", 18, [85, 92, 78])

print(s1)                    # Student(name='小明', age=18, scores=[85, 92, 78])
print(s1 == s2)              # True(自动实现)
print(s1.average_score())    # 85.0

总结:使用@dataclass之后,在定义class时,再也不用写初始化函数__init__,相等比较函数__eq__了。

二、@classmethod

@classmethod 是内置的装饰器(decorator),位于 types 模块中,但通常直接用作类方法装饰器。它用于将一个普通函数转换为类方法(class method)。类方法是绑定到类本身(而非实例)的特殊方法,可以通过类名或实例调用,主要用于操作类级别的状态或创建替代构造器。

基本用法

复制代码
class MyClass:
    @classmethod
    def my_method(cls, arg1, arg2):
        # cls 是类本身
        pass
  • @classmethod 必须写在函数定义上方。
  • 函数的第一个参数必须是 cls(约定俗成,代表 class),它自动接收调用时的类(可能是子类)。
  • 调用方式:
    通过类:MyClass.my_method(...)
    通过实例:instance = MyClass(); instance.my_method(...)(但内部还是用类调用)。

举例子来说

复制代码
class Person:
    @classmethod
    def from_string(cls, string):
        name, age = string.split(',')
        return cls(name.strip(), int(age.strip()))

    def __init__(self, name, age):
        self.name = name
        self.age = age


# 使用方式(非常自然、直观)
p = Person.from_string("Alice, 30")   # ← 直接通过类名调用,像"工厂"一样创建对象
print(p.name, p.age)                  # Alice 30

如果不想使用@classmethod,代码就会变成

复制代码
class Person:
    def from_string(self, string):           # 注意:第一个参数变成了 self
        name, age = string.split(',')
        return Person(name.strip(), int(age.strip()))

    def __init__(self, name, age):
        self.name = name
        self.age = age
p=Person("Alice", 30)

总结,使用@classmethod并不会减少代码量,它能做的就是可以很方便的迅速初始化实例类,特别是通过class内部定义的函数对类进行初始化。例如在上面例子中通过from_string对类进行初始化实例。

相关推荐
weixin_446260855 小时前
HACO:面向动态部署环境的对冲式智能计算可靠多智能体调度框架
后端·python·flask
我的xiaodoujiao5 小时前
API 接口自动化测试详细图文教程学习系列32--Allure测试报告2
python·学习·测试工具·pytest
人邮异步社区5 小时前
怎么把C语言学到精通?
c语言·开发语言
qetfw5 小时前
MXU:Tauri 2 + React 的 MaaFramework 跨平台 GUI 源码
前端·python·react.js·前端框架·开源项目·效率工具
心平气和量大福大6 小时前
C#-WPF-控件-TextBox 数据绑定
开发语言·c#·wpf
ttwuai6 小时前
Cursor 生成 CRUD 后,Go 后台接口别只测 200:JWT、RBAC 和 tenant_id 怎么验
开发语言·后端·golang
用户8356290780516 小时前
Python 实现 Excel 页面布局与打印设置自动化
后端·python
এ慕ོ冬℘゜6 小时前
前端基础:什么是时间戳?JS获取时间戳三种方法与实战用途
开发语言·前端·javascript
执明wa6 小时前
LayoutInflater详解: XML是如何变成View的?
android·xml·开发语言·android studio
一次旅行7 小时前
Python+大模型端到端自动化日报系统
开发语言·python·自动化