• Python 3.7中的新特性dataclass的用法
  • 发布于 2个月前
  • 409 热度
    1 评论
介绍

Python 3.7 中有一个新特性, 你可以使用一个装饰器 @dataclass 来简化创建数据类的过程,新创建的数据类将自带有 __init__() 和__repr__()。

数据类是一种用来存储数据的类,这种类往往不需要自定义的方法。通常,我们也管它叫数据结构。例如,一个存储点的三维坐标值的类,往往就只需要三个字段 (x, y, z)。

然而,如果我们用以前的方式实现一个数据类,那我们不可避免地需要自己编写一个__init__方法,一个字符串表示的内置方法,和一个比较函数等等。这些方法的逻辑显而易见,如果语言能够自动地处理,那就再好不过了。

事实上,其他一些语言,如 Kotlin,已经提供了构建数据类的便捷方式,Java也可以通过Lombok库来使用 @Data 标记构建数据类。

例子

这里是使用dataclass的一个例子

默认情况下,装饰器会自动生成初始化函数、比较函数和字符串表示函数。 

换言之,上面代码等同于下面的旧式代码:

注意这个例子也可以使用 namedtuple完成,但是实现的代码可读性就差了很多,虽然确实比上面例子更短了:

DATACLASS参数

@dataclass 装饰器可以接受几个参数来控制自动生成的方法的行为:

init: 如果 True, 生成 __init__ 方法。
repr: 如果 True, 生成 __repr__ 方法。
eq: 如果 True, 生成 __eq__ 方法,比较逻辑就是把数据当作一个元组来比较。
order: 如果 True, 生成 __lt__, __le__, __gt__, 和__ge__ 方法。
unsafe_hash: 如果 False, 依据 eq 和frozen的值生成 __hash__ 方法。 如果 True,生成 __hash__方法。
frozen: 如果 True, 生成的对象就是不可变的 (只读).
字段配置

在 dataclasses 模块中, 有一个 field 函数,它可以用来做字段级别的配置:

通过它你可以控制一个字段的默认值, 该字段是否应该显示在 __repr__ 中,是否应该被比较函数忽略,是否应该计算在 __hash__ 中, 等等。

初始化后处理

生成的 __init__() 代码会调用一个叫 __post_init__()的函数。 如果你需要依据基础数据生成一些衍生数据,那么这个函数会很有用。 注意如果 __init__ 方法没有生成, 那么 __post_init__ 也不会执行。

其他DATACLASS方法

dataclasses 模块还提供了很多其他的有用的函数:

fields: 返回 Field 对象的元组。 一个 Field 对象包含一个字段的配置。
asdict: 将数据类实例转换为对应字段的字典。
astuple: 将数据类实例转换为对应字段的元组。
make_dataclass: 动态创建一个数据类。
replace: 拷贝数据类实例,并修改部分字段。
is_dataclass: 判断一个对象是否是指定数据类的对象。
用户评论