python数据类(dataclass)的具体使用

2023-03-21 11:03:09 python 数据 dataclass

python3.7引入了dataclass。dataclass装饰器可以声明python类为数据类；数据类适合用来存储数据，一般而言它具有如下特征：

  • 数据类表示某种数据类型，数据对象代表一种特定类的实体，包含了实体的属性。
  • 同类型的对象之间可以进行比较；如，大于、小于或等于。

数据类定义

就其本质而言，数据类并没有什么特别之处，只是@dataclass装饰器自动生成__repr__，init，__eq__等一系列方法。定义数据类：

from dataclasses import dataclass

@dataclass
class A:
  nORMal: str
  defVal: int = 0

装饰器

dataclass完整形式为（True为生成对应方法，False将不生成；若类中已定义对应方法，则忽略此参数）：

@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)：

  • init：默认将生成__init__方法；
  • repr：默认将生成__repr__方法；repr字符串包含类名、每个字段名称和其repr（按其类中定义顺序）；
  • eq：默认将生成__eq__方法；如果传入False，那么__eq__方法将不会被dataclass添加，但会继承object.__eq__（比较id）；
  • order：默认不生成__gt__、__ge__、__lt__、__le__方法；
  • unsafe_hash：如果是False（默认），则根据eq和frozen的设置方式生成__hash__()方法（由内置的hash()使用）。
    • 如果eq和frozen都为真，默认情况会生成一个__hash__()方法；
    • 如果eq为真而frozen为假，则__hash__()将被设置为 None，将其标记为不可散列（确实如此，因为它是可变的）；
    • 如果eq为假，则__hash__()将保持不变，这意味着将使用超类的__hash__()方法（如果超类是object，将回退到基于id的散列）。
  • frozen：若为true，实例初始化后属性将无法修改；

field

通过field方法，可定制属性：
dataclasses.field(*, default=MISSING, default_factory=MISSING, repr=True, hash=None, init=True, compare=True, metadata=None)：

  • default：如果提供，这将是该字段的默认值。
  • default_factory：用于指定具有可变默认值的字段，必须是一个无参可调用对象；与default互斥（不可同时指定）。
  • init：如果为true（默认值），则该字段作为参数包含在生成的__init__()方法中。
  • repr：如果为true（默认值），则该字段包含在生成的__repr__()方法返回的字符串中。
  • compare：如果为true（默认值），则该字段包含在生成的相等性和比较方法中（__eq__() ， __gt__()等等）。
  • hash：可以是布尔值或None：
  • 为None（默认值），则使用compare的值，这通常是预期的行为（不鼓励将此值设置为None以外的任何值）；
  • 为true，则此字段包含在生成的__hash__()方法中；
  • 设置hash=False但compare=True（即从hash中排除某个字段，但仍用于比较）的一个可能原因是，计算字段的hash代价很高；
  • metadata：这可以是映射或None；None被视为一个空的字典。这个值包含在MappingProxyType()中，使其成为只读，并暴露在Field对象上（是作为第三方扩展机制提供的）。

使用default_factory生成默认值：

from dataclasses import dataclass, field
import random

def build_marks() -> list:
    return [random.randint(0, 1000) for i in range(5)]

@dataclass(order=True)
class RandMark:
    marks: list = field(default_factory=build_marks)

r = RandMark() # 使用build_marks生成默认值
print(r)

初始化

通过dataclass装饰器修饰后的类：

  • 无需定义__init__，dataclass会自动处理；
  • 以易读的方式预先定义成员属性（及类型提示）；并可定义默认值；
  • dataclass会自动添加一个__repr__函数；

数据比较

通过@dataclass(order = True)可自动添加比较方法（__eq__和__lt__）：

比较是通过属性（字段）生成的元组，进行比较的；如上比较元组为(normal, defVale)
通过compare=False，可设定不用于比较的字段：

@dataclass(order=True)
class Student:
    name: str = field(compare=False)
    score: float

s = [Student("mike", 90),
    Student("steven", 80),
    Student("orange", 70)
    ]
print(sorted(s)) # 只根据score排序

后处理

通过__post_init__可做后处理（在__init__返回前，自动调用）：

from dataclasses import dataclass

@dataclass
class FloatNumber:
    val: float
    decimal: float = 0
    integer: float = 0

    def __post_init__(self):
        self.decimal, self.integer = math.modf(self.val)

f = FloatNumber(1.2) # decimal与integer自动赋值

dataclasses方法

dataclasses内置属性与方法：

  • fields(class_or_instance)：返回字段Field对象的元组；
  • asdict(instance, *, dict_factory=dict)：将数据类转换为字典，（name:value）对；
  • astuple(instance, *, tuple_factory=tuple)：将数据类转换为元组；
  • replace(instance, **changes)：创建与instance相同类型的新对象，changes为要修改的值；

相关文章