Python中Dataclasses的作用是什么

今天就跟大家聊聊有關(guān)Python中Dataclasses的作用是什么，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。

Dataclasses 是 Python 的類(lèi)（LCTT 譯注：更準(zhǔn)確的說(shuō)，它是一個(gè)模塊），適用于存儲(chǔ)數(shù)據(jù)對(duì)象。你可能會(huì)問(wèn)什么是數(shù)據(jù)對(duì)象？下面是定義數(shù)據(jù)對(duì)象的一個(gè)不太詳細(xì)的特性列表：

• 它們存儲(chǔ)數(shù)據(jù)并代表某種數(shù)據(jù)類(lèi)型。例如：一個(gè)數(shù)字。對(duì)于熟悉 ORM 的人來(lái)說(shuō)，模型實(shí)例就是一個(gè)數(shù)據(jù)對(duì)象。它代表一種特定的實(shí)體。它包含那些定義或表示實(shí)體的屬性。

• 它們可以與同一類(lèi)型的其他對(duì)象進(jìn)行比較。例如：一個(gè)數(shù)字可以是 greater than（大于）、less than（小于） 或 equal（等于） 另一個(gè)數(shù)字。

當(dāng)然還有更多的特性，但是這個(gè)列表足以幫助你理解問(wèn)題的關(guān)鍵。

為了理解 Dataclasses，我們將實(shí)現(xiàn)一個(gè)包含數(shù)字的簡(jiǎn)單類(lèi)，并允許我們執(zhí)行上面提到的操作。

首先，我們將使用普通類(lèi)，然后我們?cè)偈褂?Dataclasses 來(lái)實(shí)現(xiàn)相同的結(jié)果。

但在我們開(kāi)始之前，先來(lái)談?wù)?Dataclasses 的用法。

Python 3.7 提供了一個(gè)裝飾器 dataclass，用于將類(lèi)轉(zhuǎn)換為 dataclass。

你所要做的就是將類(lèi)包在裝飾器中：

from dataclasses import dataclass @dataclassclass A: ...

現(xiàn)在，讓我們深入了解一下 dataclass 帶給我們的變化和用途。

初始化

通常是這樣：

class Number:     def __init__(self, val):        self.val = val >>> one = Number(1)>>> one.val>>> 1

用 dataclass 是這樣：

@dataclassclass Number:    val:int  >>> one = Number(1)>>> one.val>>> 1

以下是 dataclass 裝飾器帶來(lái)的變化：

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. 無(wú)需定義 __init__，然后將值賦給 self，dataclass 負(fù)責(zé)處理它（LCTT 譯注：此處原文可能有誤，提及一個(gè)不存在的 d）

3. 我們以更加易讀的方式預(yù)先定義了成員屬性，以及類(lèi)型提示。我們現(xiàn)在立即能知道 val 是 int 類(lèi)型。這無(wú)疑比一般定義類(lèi)成員的方式更具可讀性。

Python 之禪: 可讀性很重要

它也可以定義默認(rèn)值：

@dataclassclass Number:    val:int = 0

表示

對(duì)象表示指的是對(duì)象的一個(gè)有意義的字符串表示，它在調(diào)試時(shí)非常有用。

默認(rèn)的 Python 對(duì)象表示不是很直觀：

class Number:    def __init__(self, val = 0):    self.val = val >>> a = Number(1)>>> a>>> <__main__.Number object at 0x7ff395b2ccc0>

這讓我們無(wú)法知悉對(duì)象的作用，并且會(huì)導(dǎo)致糟糕的調(diào)試體驗(yàn)。

一個(gè)有意義的表示可以通過(guò)在類(lèi)中定義一個(gè) __repr__ 方法來(lái)實(shí)現(xiàn)。

def __repr__(self):    return self.val

現(xiàn)在我們得到這個(gè)對(duì)象有意義的表示：

>>> a = Number(1)>>> a>>> 1

dataclass 會(huì)自動(dòng)添加一個(gè) __repr__  函數(shù)，這樣我們就不必手動(dòng)實(shí)現(xiàn)它了。

@dataclassclass Number:    val: int = 0

>>> a = Number(1)>>> a>>> Number(val = 1)

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

通常，數(shù)據(jù)對(duì)象之間需要相互比較。

兩個(gè)對(duì)象 a 和 b 之間的比較通常包括以下操作：

• a < b

• a > b

• a == b

• a >= b

• a <= b

在 Python 中，能夠在可以執(zhí)行上述操作的類(lèi)中定義方法。為了簡(jiǎn)單起見(jiàn)，不讓這篇文章過(guò)于冗長(zhǎng)，我將只展示 == 和 < 的實(shí)現(xiàn)。

通常這樣寫(xiě)：

class Number:    def __init__( self, val = 0):       self.val = val     def __eq__(self, other):        return self.val == other.val     def __lt__(self, other):        return self.val < other.val

使用 dataclass：

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

是的，就是這樣簡(jiǎn)單。

我們不需要定義 __eq__ 和 __lt__ 方法，因?yàn)楫?dāng) order = True 被調(diào)用時(shí)，dataclass 裝飾器會(huì)自動(dòng)將它們添加到我們的類(lèi)定義中。

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

當(dāng)你使用 dataclass 時(shí)，它會(huì)在類(lèi)定義中添加函數(shù) __eq__ 和 __lt__ 。我們已經(jīng)知道這點(diǎn)了。那么，這些函數(shù)是怎樣知道如何檢查相等并進(jìn)行比較呢？

生成 __eq__ 函數(shù)的 dataclass 類(lèi)會(huì)比較兩個(gè)屬性構(gòu)成的元組，一個(gè)由自己屬性構(gòu)成的，另一個(gè)由同類(lèi)的其他實(shí)例的屬性構(gòu)成。在我們的例子中，自動(dòng)生成的 __eq__ 函數(shù)相當(dāng)于：

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

讓我們來(lái)看一個(gè)更詳細(xì)的例子：

我們會(huì)編寫(xiě)一個(gè) dataclass 類(lèi) Person 來(lái)保存 name 和 age。

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

自動(dòng)生成的 __eq__ 方法等同于：

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

請(qǐng)注意屬性的順序。它們總是按照你在 dataclass 類(lèi)中定義的順序生成。

同樣，等效的 __le__ 函數(shù)類(lèi)似于：

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

當(dāng)你需要對(duì)數(shù)據(jù)對(duì)象列表進(jìn)行排序時(shí)，通常會(huì)出現(xiàn)像 __le__ 這樣的函數(shù)的定義。Python 內(nèi)置的 sorted 函數(shù)依賴(lài)于比較兩個(gè)對(duì)象。

>>> 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 作為一個(gè)可調(diào)用的裝飾器

定義所有的 dunder（LCTT 譯注：這是指雙下劃線方法，即魔法方法）方法并不總是值得的。你的用例可能只包括存儲(chǔ)值和檢查相等性。因此，你只需定義 __init__ 和 __eq__ 方法。如果我們可以告訴裝飾器不生成其他方法，那么它會(huì)減少一些開(kāi)銷(xiāo)，并且我們將在數(shù)據(jù)對(duì)象上有正確的操作。

幸運(yùn)的是，這可以通過(guò)將 dataclass 裝飾器作為可調(diào)用對(duì)象來(lái)實(shí)現(xiàn)。

從官方文檔來(lái)看，裝飾器可以用作具有如下參數(shù)的可調(diào)用對(duì)象：

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

1. 鴻蒙官方戰(zhàn)略合作共建——HarmonyOS技術(shù)社區(qū)

2. init：默認(rèn)將生成 __init__ 方法。如果傳入 False，那么該類(lèi)將不會(huì)有 __init__ 方法。

3. repr：__repr__ 方法默認(rèn)生成。如果傳入 False，那么該類(lèi)將不會(huì)有 __repr__ 方法。

4. eq：默認(rèn)將生成 __eq__ 方法。如果傳入 False，那么 __eq__ 方法將不會(huì)被 dataclass 添加，但默認(rèn)為 object.__eq__。

5. order：默認(rèn)將生成 __gt__、__ge__、__lt__、__le__ 方法。如果傳入 False，則省略它們。

我們?cè)诮酉聛?lái)會(huì)討論 frozen。由于 unsafe_hash 參數(shù)復(fù)雜的用例，它值得單獨(dú)發(fā)布一篇文章。

現(xiàn)在回到我們的用例，以下是我們需要的：

1. __init__
2. __eq__

默認(rèn)會(huì)生成這些函數(shù)，因此我們需要的是不生成其他函數(shù)。那么我們?cè)撛趺醋瞿兀亢芎?jiǎn)單，只需將相關(guān)參數(shù)作為 false 傳入給生成器即可。

@dataclass(repr = False) # order, unsafe_hash and frozen are Falseclass 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: &lsquo;<&rsquo; not supported between instances of &lsquo;Number&rsquo; and &lsquo;Number&rsquo;

Frozen（不可變） 實(shí)例

Frozen 實(shí)例是在初始化對(duì)象后無(wú)法修改其屬性的對(duì)象。

無(wú)法創(chuàng)建真正不可變的 Python 對(duì)象

在 Python 中創(chuàng)建對(duì)象的不可變屬性是一項(xiàng)艱巨的任務(wù)，我將不會(huì)在本篇文章中深入探討。

以下是我們期望不可變對(duì)象能夠做到的：

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

有了 dataclass，就可以通過(guò)使用 dataclass 裝飾器作為可調(diào)用對(duì)象配合參數(shù) frozen=True 來(lái)定義一個(gè) frozen 對(duì)象。

當(dāng)實(shí)例化一個(gè) frozen 對(duì)象時(shí)，任何企圖修改對(duì)象屬性的行為都會(huì)引發(fā) FrozenInstanceError。

@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 &lsquo;val&rsquo;

因此，一個(gè) frozen 實(shí)例是一種很好方式來(lái)存儲(chǔ)：

• 常數(shù)

• 設(shè)置

這些通常不會(huì)在應(yīng)用程序的生命周期內(nèi)發(fā)生變化，任何企圖修改它們的行為都應(yīng)該被禁止。

后期初始化處理

有了 dataclass，需要定義一個(gè) __init__ 方法來(lái)將變量賦給 self 這種初始化操作已經(jīng)得到了處理。但是我們失去了在變量被賦值之后立即需要的函數(shù)調(diào)用或處理的靈活性。

讓我們來(lái)討論一個(gè)用例，在這個(gè)用例中，我們定義一個(gè) Float 類(lèi)來(lái)包含浮點(diǎn)數(shù)，然后在初始化之后立即計(jì)算整數(shù)和小數(shù)部分。

通常是這樣：

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

幸運(yùn)的是，使用 post_init  方法已經(jīng)能夠處理后期初始化操作。

生成的 __init__  方法在返回之前調(diào)用 __post_init__ 返回。因此，可以在函數(shù)中進(jìn)行任何處理。

import math @dataclassclass 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

繼承

Dataclasses 支持繼承，就像普通的 Python 類(lèi)一樣。

因此，父類(lèi)中定義的屬性將在子類(lèi)中可用。

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

請(qǐng)注意，Student 的參數(shù)是在類(lèi)中定義的字段的順序。

繼承過(guò)程中 __post_init__ 的行為是怎樣的？

由于 __post_init__ 只是另一個(gè)函數(shù)，因此必須以傳統(tǒng)方式調(diào)用它：

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

在上面的例子中，只有 B 的 __post_init__ 被調(diào)用，那么我們?nèi)绾握{(diào)用 A 的 __post_init__ 呢？

因?yàn)樗歉割?lèi)的函數(shù)，所以可以用 super 來(lái)調(diào)用它。

@dataclassclass B(A):    b: int     def __post_init__(self):        super().__post_init__() # 調(diào)用 A 的 post init        print("B") >>> a = B(1,2) >>> A    B

看完上述內(nèi)容，你們對(duì)Python中Dataclasses的作用是什么有進(jìn)一步的了解嗎？如果還想了解更多知識(shí)或者相關(guān)內(nèi)容，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝大家的支持。