理解 Python 的 Dataclasses（一） | Linux 中國

使用 dataclass：

@dataclass(order = True)
class Number:
    val: int = 0

是的，就是這樣簡單。

我們不需要定義 __eq__ 和 __lt__ 方法，因為當 order = True 被呼叫時，dataclass 裝飾器會自動將它們新增到我們的類定義中。

那麼，它是如何做到的呢？

當你使用 dataclass 時，它會在類定義中新增函式 __eq__ 和 __lt__ 。我們已經知道這點了。那麼，這些函式是怎樣知道如何檢查相等併進行比較呢？

生成 __eq__ 函式的 dataclass 類會比較兩個屬性構成的元組，一個由自己屬性構成的，另一個由同類的其他實體的屬性構成。在我們的例子中，自動生成的 __eq__ 函式相當於：

def __eq__(self, other):
    return (self.val,) == (other.val,)

讓我們來看一個更詳細的例子：

我們會編寫一個 dataclass 類 Person 來儲存 name 和 age。

@dataclass(order = True)
class Person:
    name: str
    age:int = 0

自動生成的 __eq__ 方法等同於：

def __eq__(self, other):
    return (self.name, self.age) == ( other.name, other.age)

請註意屬性的順序。它們總是按照你在 dataclass 類中定義的順序生成。

同樣，等效的 __le__ 函式類似於：

def __le__(self, other):
    return (self.name, self.age) <= (other.name, other.age)

當你需要對資料物件串列進行排序時，通常會出現像 __le__ 這樣的函式的定義。Python 內建的 sorted[4] 函式依賴於比較兩個物件。

>>> import random
>>> a = [Number(random.randint(1,10)) for _ in range(10)] #generate list of random numbers
>>> a
>>> [Number(val=2), Number(val=7), Number(val=6), Number(val=5), Number(val=10), Number(val=9), Number(val=1), Number(val=10), Number(val=1), Number(val=7)]
>>> sorted_a = sorted(a) #Sort Numbers in ascending order
>>> [Number(val=1), Number(val=1), Number(val=2), Number(val=5), Number(val=6), Number(val=7), Number(val=7), Number(val=9), Number(val=10), Number(val=10)]
>>> reverse_sorted_a = sorted(a, reverse = True) #Sort Numbers in descending order 
>>> reverse_sorted_a
>>> [Number(val=10), Number(val=10), Number(val=9), Number(val=7), Number(val=7), Number(val=6), Number(val=5), Number(val=2), Number(val=1), Number(val=1)]

@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)
class C:
 …

@dataclass(repr = False) # order, unsafe_hash and frozen are False
class Number:
    val: int = 0
>>> a = Number(1)
>>> a
>>> <__main__.Number object at 0x7ff395afe898>
>>> b = Number(2)
>>> c = Number(1)
>>> a == b
>>> False
>>> a < b
>>> Traceback (most recent call last):
 File “<stdin>”, line 1, in <module>
TypeError: ‘ not supported between instances of ‘Number’ and ‘Number’

>>> a = Number(10) #Assuming Number class is immutable
>>> a.val = 10 # Raises Error

@dataclass(frozen = True)
class Number:
    val: int = 0
>>> a = Number(1)
>>> a.val
>>> 1
>>> a.val = 2
>>> Traceback (most recent call last):
 File “<stdin>”, line 1, in <module>
 File “<string>”, line 3, in __setattr__
dataclasses.FrozenInstanceError: cannot assign to field ‘val’

import math
class Float:
    def __init__(self, val = 0):
        self.val = val
        self.process()
    def process(self):
        self.decimal, self.integer = math.modf(self.val)
>>> a = Float( 2.2)
>>> a.decimal
>>> 0.2000
>>> a.integer
>>> 2.0

import math
@dataclass
class FloatNumber:
    val: float = 0.0
    def __post_init__(self):
        self.decimal, self.integer = math.modf(self.val)
>>> a = Number(2.2)
>>> a.val
>>> 2.2
>>> a.integer
>>> 2.0
>>> a.decimal
>>> 0.2

@dataclass
class Person:
    age: int = 0
    name: str
@dataclass
class Student(Person):
    grade: int
>>> s = Student(20, "John Doe", 12)
>>> s.age
>>> 20
>>> s.name
>>> "John Doe"
>>> s.grade
>>> 12

@dataclass
class A:
    a: int
    def __post_init__(self):
        print("A")
@dataclass
class B(A):
    b: int
    def __post_init__(self):
        print("B")
>>> a = B(1,2)
>>> B

@dataclass
class B(A):
    b: int
    def __post_init__(self):
        super().__post_init__() # 呼叫 A 的 post init
        print("B")
>>> a = B(1,2)
>>> A
    B