快捷導(dǎo)航

python 數(shù)據(jù)類(dataclass)的具體使用

更新時間：2023年03月21日 09:51:23 作者：alwaysrun

本文主要介紹了python 數(shù)據(jù)類(dataclass)的具體使用，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

數(shù)據(jù)類定義

就其本質(zhì)而言，數(shù)據(jù)類并沒有什么特別之處，只是@dataclass裝飾器自動生成__repr__，init，__eq__等一系列方法。定義數(shù)據(jù)類：

from dataclasses import dataclass

@dataclass
class A:
? normal: str
? defVal: int = 0

裝飾器

dataclass完整形式為（True為生成對應(yīng)方法，F(xiàn)alse將不生成；若類中已定義對應(yīng)方法，則忽略此參數(shù)）：

@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（默認），則根據(jù)eq和frozen的設(shè)置方式生成__hash__()方法（由內(nèi)置的hash()使用）。
- 如果eq和frozen都為真，默認情況會生成一個__hash__()方法；
- 如果eq為真而frozen為假，則__hash__()將被設(shè)置為 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：用于指定具有可變默認值的字段，必須是一個無參可調(diào)用對象；與default互斥（不可同時指定）。
init：如果為true（默認值），則該字段作為參數(shù)包含在生成的__init__()方法中。
repr：如果為true（默認值），則該字段包含在生成的__repr__()方法返回的字符串中。
compare：如果為true（默認值），則該字段包含在生成的相等性和比較方法中（__eq__() ， __gt__()等等）。
hash：可以是布爾值或None：
為None（默認值），則使用compare的值，這通常是預(yù)期的行為（不鼓勵將此值設(shè)置為None以外的任何值）；
為true，則此字段包含在生成的__hash__()方法中；
設(shè)置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會自動處理；
以易讀的方式預(yù)先定義成員屬性（及類型提示）；并可定義默認值；
dataclass會自動添加一個__repr__函數(shù)；

數(shù)據(jù)比較

通過@dataclass(order = True)可自動添加比較方法（__eq__和__lt__）：

比較是通過屬性（字段）生成的元組，進行比較的；如上比較元組為(normal, defVale)
通過compare=False，可設(shè)定不用于比較的字段：

@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)) # 只根據(jù)score排序

后處理

通過__post_init__可做后處理（在__init__返回前，自動調(diào)用）：

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自動賦值