理解Python的Dataclasses（一）(Python Dataclasses入门详解（一）)

原创

ithorizon 6个月前 (10-20) 阅读数 25 #后端开发

Python Dataclasses入门详解（一）

一、Dataclasses简介

Dataclasses是Python 3.7中引入的一个新特性，旨在简化类定义中常见的模式，尤其是那些用于存储数据的类。Dataclasses通过自动生成特殊方法，如初始化（__init__）、描述（__repr__）、比较等方法，来缩减编写冗余代码的工作量。

二、Dataclasses的优势

Dataclasses具有以下优势：

缩减代码量：自动生成特殊方法，缩减手动编写重复代码。

节约代码可读性：通过字段名直接访问数据，增长代码的可读性。

易于维护：修改字段时，相关方法会自动更新。

类型注解：赞成类型注解，便于静态类型检查。

三、基本用法

Dataclasses的使用非常单纯，只需导入dataclasses模块，并使用装饰器@dataclass即可。


from dataclasses import dataclass
@dataclass
class Person:
    name: str
    age: int
    height: float = 1.75  # 默认值

在上面的例子中，我们定义了一个名为Person的类，包含三个字段：姓名（name）、年龄（age）和身高（height）。其中，身高字段有一个默认值1.75。

四、自动生成的方法

Dataclasses会自动为类生成以下特殊方法：

__init__：构造函数，用于初始化对象。

__repr__：对象的字符串描述，通常用于调试。

__eq__：判断两个对象是否相等。

__ne__：判断两个对象是否不相等。

__lt__：判断一个对象是否小于另一个对象。

__le__：判断一个对象是否小于等于另一个对象。

__gt__：判断一个对象是否大于另一个对象。

__ge__：判断一个对象是否大于等于另一个对象。

五、自定义方法

在Dataclasses中，我们也可以自定义方法。以下是一个例子：


@dataclass
class Person:
    name: str
    age: int
    height: float = 1.75
    def say_hello(self):
        return f"Hello, my name is {self.name} and I am {self.age} years old."

在上面的例子中，我们为Person类添加了一个自定义方法say_hello，用于打印问候语。

六、继承Dataclasses

Dataclasses也赞成继承。以下是一个例子：


@dataclass
class Person:
    name: str
    age: int
@dataclass
class Employee(Person):
    employee_id: int

在这个例子中，我们定义了一个名为Employee的类，它继承自Person类，并添加了一个新的字段：员工编号（employee_id）。

七、Dataclasses的高级特性

Dataclasses还提供了一些高级特性，如下：

1. field()函数

field函数允许我们自定义字段的默认值和类型注解。


from dataclasses import field
@dataclass
class Person:
    name: str
    age: int = field(default=30)
    height: float = field(default=1.75, metadata={'units': 'meters'})

在上面的例子中，我们使用field函数为age字段设置了默认值30，并为height字段添加了元数据。

2. InitVar

InitVar类型用于在初始化时传递给构造函数的额外参数。


from dataclasses import InitVar
@dataclass
class Person:
    name: str
    age: int
    birth_year: InitVar[int]
    def __post_init__(self, birth_year):
        self.age = 2021 - birth_year

在上面的例子中，我们添加了一个名为birth_year的InitVar类型的字段，并在__post_init__方法中计算年龄。

3. asdict()和astuple()函数

asdict和astuple函数可以将Dataclasses对象转换成字典和元组。


from dataclasses import asdict, astuple
person = Person(name="Alice", age=30)
print(asdict(person))  # 输出：{'name': 'Alice', 'age': 30}
print(astuple(person))  # 输出：(Alice, 30)