dataclass是從Python3.7版本開(kāi)始，作為標(biāo)準(zhǔn)庫(kù)中的模塊被引入。
隨著Python版本的不斷更新，dataclass也逐步發(fā)展和完善，為Python開(kāi)發(fā)者提供了更加便捷的數(shù)據(jù)類創(chuàng)建和管理方式。

dataclass的主要功能在于幫助我們簡(jiǎn)化數(shù)據(jù)類的定義過(guò)程。
本文總結(jié)了幾個(gè)我平時(shí)使用較多dataclass技巧。

1. 傳統(tǒng)的類定義方式

首先，從平時(shí)量化分析的場(chǎng)景中簡(jiǎn)化一個(gè)關(guān)于 幣交易 的類用來(lái)演示。
簡(jiǎn)化之后，這里只保留5個(gè)字段，分別是交易ID，交易對(duì)，價(jià)格，是否成功和參與交易的地址列表。

class CoinTrans:
    def __init__(
        self,
        id: str,
        symbol: str,
        price: float,
        is_success: bool,
        addrs: list,
    ) -> None:
        self.id = id
        self.symbol = symbol
        self.price = price
        self.addrs = addrs
        self.is_success = is_success

Python傳統(tǒng)定義類的方式，如上通過(guò)__init__函數(shù)來(lái)初始化對(duì)象的各個(gè)屬性。

通過(guò)這個(gè)類構(gòu)造對(duì)象并打印：

if __name__ == "__main__":
    coin_trans = CoinTrans("id01", "BTC/USDT", "71000", True, ["0x1111", "0x2222"])
    print(coin_trans)

運(yùn)行結(jié)果：

<__main__.CoinTrans object at 0x0000022A891FADD0>

這里只是打印出對(duì)象的地址，并沒(méi)有按照我們期望的那樣打印對(duì)象各個(gè)屬性的值。

傳統(tǒng)的類中，我們?nèi)绻Ｍ蛴〕隹勺x的結(jié)果，需要自己去實(shí)現(xiàn)__str__函數(shù)。

# 在上面的 CoinTrans 類中添加下面的方法
def __str__(self) -> str:
    return f"交易信息：{self.id}, {self.symbol}, {self.price}, {self.addrs}, {self.is_success}"

再次運(yùn)行，結(jié)果如下：

交易信息：id01, BTC/USDT, 71000, ['0x1111', '0x2222'], True

2. dataclass裝飾器定義類

下面看看使用dataclass裝飾器來(lái)定義上面同樣的類有多簡(jiǎn)單。

from dataclasses import dataclass
@dataclass
class CoinTrans:
    id: str
    symbol: str
    price: float
    is_success: bool
    addrs: list

再次運(yùn)行：

if __name__ == "__main__":
    coin_trans = CoinTrans("id01", "BTC/USDT", "71000", True, ["0x1111", "0x2222"])
    print(coin_trans)

得到如下結(jié)果：

CoinTrans(id='id01', symbol='BTC/USDT', price='71000', is_success=True, addrs=['0x1111', '0x2222'])

不需要__init__，也不需要__str__，只要通過(guò) @dataclass裝飾之后，就可以打印出對(duì)象的具體內(nèi)容。

2.1. 默認(rèn)值

dataclass裝飾器的方式來(lái)定義類，設(shè)置默認(rèn)值很簡(jiǎn)單，直接在定義屬性時(shí)就可以設(shè)置。

@dataclass
class CoinTrans:
    id: str = "id01"
    symbol: str = "BTC/USDT"
    price: float = "71000.8"
    is_success: bool = True
    addrs: list[str] = ["0x1111", "0x2222"]
if __name__ == "__main__":
    coin_trans = CoinTrans()
    print(coin_trans)

運(yùn)行之后發(fā)現(xiàn)，在addrs屬性那行會(huì)報(bào)錯(cuò)：

ValueError: mutable default <class 'list'> for field addrs is not allowed: use default_factory

大概的意思就是，list作為一種可變的類型（引用類型，會(huì)有被其他對(duì)象意外修改的風(fēng)險(xiǎn)），不能直接作為默認(rèn)值，需要用工廠方法來(lái)產(chǎn)生默認(rèn)值。
其他字符串，數(shù)值，布爾類型的數(shù)據(jù)則沒(méi)有這個(gè)問(wèn)題。

我們只要定義個(gè)函數(shù)來(lái)產(chǎn)生此默認(rèn)值即可。

def gen_list():
    return ["0x1111", "0x2222"]
@dataclass
class CoinTrans:
    id: str = "id01"
    symbol: str = "BTC/USDT"
    price: float = "71000.8"
    is_success: bool = True
    addrs: list[str] = field(default_factory=gen_list)
if __name__ == "__main__":
    coin_trans = CoinTrans()
    print(coin_trans)

再次運(yùn)行，可以正常執(zhí)行：

CoinTrans(id='id01', symbol='BTC/USDT', price='71000.8', is_success=True, addrs=['0x1111', '0x2222']

2.2. 隱藏敏感信息

我們打印對(duì)象信息的時(shí)候，有時(shí)執(zhí)行打印其中幾個(gè)屬性的信息，涉及敏感信息的屬性不希望打印出來(lái)。
比如，上面的對(duì)象，如果不想打印出is_success和addrs的信息，可以設(shè)置repr=False。

@dataclass
class CoinTrans:
    id: str = "id01"
    symbol: str = "BTC/USDT"
    price: float = "71000.8"
    is_success: bool = field(default=True, repr=False)
    addrs: list[str] = field(default_factory=gen_list, repr=False)

再次運(yùn)行后顯示：

CoinTrans(id='id01', symbol='BTC/USDT', price='71000.8')

2.3. 只讀對(duì)象

數(shù)據(jù)分析時(shí)，大部分下情況下，原始數(shù)據(jù)讀取之后是不能修改的。
這種情況下，我們可以用dataclass的frozen屬性來(lái)設(shè)置數(shù)據(jù)類只讀，防止不小心篡改了數(shù)據(jù)。

未設(shè)置frozen屬性之前，可以隨意修改對(duì)象的屬性，比如：

if __name__ == "__main__":
    coin_trans = CoinTrans()
    print(f"修改前: {coin_trans}")
    coin_trans.symbol = "ETH/USDT"
    print(f"修改后: {coin_trans}")

運(yùn)行結(jié)果：

修改前: CoinTrans(id='id01', symbol='BTC/USDT', price='71000.8')
修改后: CoinTrans(id='id01', symbol='ETH/USDT', price='71000.8')

設(shè)置frozen屬性之后，看看修改屬性值會(huì)怎么樣：

@dataclass(frozen=True)
class CoinTrans:
    id: str = "id01"
    #... 省略 ...

再次運(yùn)行，會(huì)發(fā)現(xiàn)修改屬性會(huì)觸發(fā)異常。

修改前: CoinTrans(id='id01', symbol='BTC/USDT', price='71000.8')
Traceback (most recent call last):
  File "D:\projects\python\samples\data_classes\main.py", line 66, in <module>
    coin_trans.symbol = "ETH/USDT"
    ^^^^^^^^^^^^^^^^^
  File "<string>", line 4, in __setattr__
dataclasses.FrozenInstanceError: cannot assign to field 'symbol'

2.4. 轉(zhuǎn)化為元組和字典

最后，dataclasses模塊還提供了兩個(gè)函數(shù)可以很方便的將數(shù)據(jù)類轉(zhuǎn)換為元組和字典。
這在和其他分析程序交互時(shí)非常有用，因?yàn)楹推渌绦蚪换r(shí)，參數(shù)一般都用元組或者字典這種簡(jiǎn)單通用的結(jié)構(gòu)，
而不會(huì)直接用自己定義的數(shù)據(jù)類。

from dataclasses import dataclass, field, astuple, asdict
if __name__ == "__main__":
    coin_trans = CoinTrans()
    print(astuple(coin_trans))
    print(asdict(coin_trans))

運(yùn)行結(jié)果：

('id01', 'BTC/USDT', '71000.8', True, ['0x1111', '0x2222'])
{'id': 'id01', 'symbol': 'BTC/USDT', 'price': '71000.8', 'is_success': True, 'addrs': ['0x1111', '0x2222']}

3. 總結(jié)

在Python中，數(shù)據(jù)類主要用于存儲(chǔ)數(shù)據(jù)，并通常包含屬性和方法來(lái)操作這些數(shù)據(jù)。
然而，在定義數(shù)據(jù)類時(shí)，我們通常需要編寫(xiě)一些重復(fù)性的代碼，如構(gòu)造函數(shù)、屬性訪問(wèn)器和字符串表示等。
dataclass裝飾器的出現(xiàn)，使得這些通用方法的生成變得自動(dòng)化，從而極大地簡(jiǎn)化了數(shù)據(jù)類的定義過(guò)程。

總的來(lái)說(shuō)，dataclass通過(guò)簡(jiǎn)化數(shù)據(jù)類的創(chuàng)建和管理過(guò)程，提高了開(kāi)發(fā)效率，是我們?cè)跀?shù)據(jù)分析時(shí)的一個(gè)非常有用的工具。

到此這篇關(guān)于掌握python的dataclass，讓你的代碼更簡(jiǎn)潔優(yōu)雅的文章就介紹到這了,更多相關(guān)python dataclass內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論