腳本之家服務器常用軟件

快捷導航

深入理解Python?@dataclass的內(nèi)部原理

更新時間：2025年01月06日 09:53:16 作者：wang_yb

文章介紹了Python中dataclass的實現(xiàn)原理,通過自定義裝飾器實現(xiàn)了__init__和__repr__方法,并解釋了__annotations__屬性和exec函數(shù)在其中的作用,感興趣的朋友跟隨小編一起看看吧

1. dataclass簡介

dataclass為我們提供了一種簡潔而高效的方式來定義類，特別是那些主要用于存儲數(shù)據(jù)的類。

它能自動為我們生成一些常用的方法，如__init__、__repr__等，大大減少了樣板代碼的編寫。

例如，我在量化中經(jīng)常用的一個K線數(shù)據(jù)，用dataclass來定義的話，如下所示：

from dataclasses import dataclass
from datetime import datetime
@dataclass
class KLine:
    name: str = "BTC"
    open_price: float = 0.0
    close_price: float = 0.0
    high_price: float = 0.0
    low_price: float = 0.0
    begin_time: datetime = datetime.now()
if __name__ == "__main__":
    kl = KLine()
    print(kl)

這樣，我們無需手動編寫__init__方法來初始化對象，就可以輕松創(chuàng)建KLine類的實例，

并且直接打印對象也可以得到清晰，易于閱讀的輸出。

$  python.exe .\kline.py
KLine(name='BTC', open_price=0.0, close_price=0.0, 
high_price=0.0, low_price=0.0, 
begin_time=datetime.datetime(2025, 1, 2, 17, 45, 53, 44463))

但這背后究竟發(fā)生了什么呢？

2. 核心概念

dataclass從Python3.7版本開始，已經(jīng)加入到標準庫中了。

代碼就在Python安裝目錄中的Lib/dataclasses.py文件中。

實現(xiàn)這個裝飾器功能的核心有兩個：__annotations__屬性和exec函數(shù)。

2.1. annotations屬性

__annotations__是 Python 中一個隱藏的寶藏，它以字典的形式存儲著變量、屬性以及函數(shù)參數(shù)或返回值的類型提示。

對于dataclass來說，它就像是一張地圖，裝飾器通過它來找到用戶定義的字段。

比如，在上面的KLine類中，__annotations__會返回字段的相關信息。

這使得dataclass裝飾器能夠清楚地知道類中包含哪些字段以及它們的類型，為后續(xù)的操作提供了關鍵信息。

if __name__ == "__main__":
    print(KLine.__annotations__)
# 運行結果：
{'name': <class 'str'>, 'open_price': <class 'float'>, 
'close_price': <class 'float'>, 'high_price': <class 'float'>, 
'low_price': <class 'float'>, 'begin_time': <class 'datetime.datetime'>}

2.2. exec 函數(shù)

exec函數(shù)堪稱dataclass實現(xiàn)的魔法棒，它能夠將字符串形式的代碼轉換為 Python 對象。

在dataclass的世界里，它被用來創(chuàng)建各種必要的方法。

我們可以通過構建函數(shù)定義的字符串，然后使用exec將其轉化為真正的函數(shù)，并添加到類中。

這就是dataclass裝飾器能夠自動生成__init__、__repr__等方法的秘密所在。

下面的代碼通過exec，將一個字符串代碼轉換成一個真正可使用的函數(shù)。

# 定義一個存儲代碼的字符串
code_string = """
def greet(name):
    print(f"Hello, {name}!")
"""
# 使用 exec 函數(shù)執(zhí)行代碼字符串
exec(code_string)
# 調(diào)用通過 exec 生成的函數(shù)
greet("Alice")

3. 自定義dataclass裝飾器

掌握了上面的核心概念，我們就可以開始嘗試實現(xiàn)自己的dataclass裝飾器。

當然，這里只是簡單實現(xiàn)個雛形，目的是為了了解Python標準庫中dataclass的原理。

下面主要實現(xiàn)兩個功能__init__和__repr__。

通過這兩個功能來理解dataclass的實現(xiàn)原理。

3.1. 定義架構

我們首先定義一個dataclass裝飾器，它的結構如下：

def dataclass(cls=None, init=True, repr=True):
    def wrap(cls):
        # 這里將對類進行修改
        return cls
    if cls is None:
        return wrap
    return wrap(cls)

接下來，我們在這個裝飾器中實現(xiàn)__init__和__repr__。

3.2. 初始化：init

當init參數(shù)為True時，我們?yōu)轭愄砑?code>__init__方法。

通過_init_fn函數(shù)來實現(xiàn)，它會根據(jù)類的字段生成__init__方法的函數(shù)定義字符串，然后使用_create_fn函數(shù)將其轉換為真正的方法并添加到類中。

def _create_fn(cls, name, fn):
    ns = {}
    exec(fn, None, ns)
    method = ns[name]
    setattr(cls, name, method)
def _init_fn(cls, fields):
    args = ", ".join(fields)
    lines = [f"self.{field} = {field}" for field in fields]
    body = "\n".join(f"  {line}" for line in lines)
    txt = f"def __init__(self, {args}):\n{body}"
    _create_fn(cls, "__init__", txt)

3.3. 美化輸出：repr

__repr__方法讓我們能夠以一種清晰易讀的方式打印出類的實例。

為了實現(xiàn)這個功能，我們創(chuàng)建_repr_fn函數(shù)，它生成__repr__方法的定義字符串。

這個方法會獲取實例的__dict__屬性中的所有變量，并使用 f-string 進行格式化輸出。

def _repr_fn(cls, fields):
    txt = (
        "def __repr__(self):\n"
        "    fields = [f'{key}={val!r}' for key, val in self.__dict__.items()]\n"
        "    return f'{self.__class__.__name__}({\"\\n \".join(fields)})'"
    )
    _create_fn(cls, "__repr__", txt)

3.4. 合在一起

最終的代碼如下，代碼中使用的是自己的dataclass裝飾器，而不是標準庫中的dataclass。

from datetime import datetime
def dataclass(cls=None, init=True, repr=True):
    def wrap(cls):
        fields = cls.__annotations__.keys()
        if init:
            _init_fn(cls, fields)
        if repr:
            _repr_fn(cls, fields)
        return cls
    if cls is None:  # 如果裝飾器帶參數(shù)
        return wrap
    return wrap(cls)
def _create_fn(cls, name, fn):
    ns = {}
    exec(fn, None, ns)
    method = ns[name]
    setattr(cls, name, method)
def _init_fn(cls, fields):
    args = ", ".join(fields)
    lines = [f"self.{field} = {field}" for field in fields]
    body = "\n".join(f"  {line}" for line in lines)
    txt = f"def __init__(self, {args}):\n{body}"
    _create_fn(cls, "__init__", txt)
def _repr_fn(cls, fields):
    txt = (
        "def __repr__(self):\n"
        "    fields = [f'{key}={val!r}' for key, val in self.__dict__.items()]\n"
        "    return f'{self.__class__.__name__}({\"\\n \".join(fields)})'"
    )
    _create_fn(cls, "__repr__", txt)
@dataclass
class KLine:
    name: str = "BTC"
    open_price: float = 0.0
    close_price: float = 0.0
    high_price: float = 0.0
    low_price: float = 0.0
    begin_time: datetime = datetime.now()
if __name__ == "__main__":
    kl = KLine(
        name="ETH",
        open_price=1000.5,
        close_price=3200.5,
        high_price=3400,
        low_price=200,
        begin_time=datetime.now(),
    )
    print(kl)

運行的效果如下：

可以看出，我們自己實現(xiàn)的dataclass裝飾器也可以實現(xiàn)類的初始化和美化輸出，這里輸出時每個屬性占一行。

4. 總結

通過自定義dataclass裝飾器的構建過程，我們深入了解了 Python 中dataclass的內(nèi)部原理。

利用__annotations__獲取字段信息，借助exec創(chuàng)建各種方法，從而實現(xiàn)簡潔高效的dataclass定義。

不過，實際的 Python標準庫中的dataclass還有更多的功能和優(yōu)化，了解了其原理之后，可以參考它的源碼再進一步學習。

到此這篇關于探索Python @dataclass的內(nèi)部原理的文章就介紹到這了,更多相關Python @dataclass原理內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

深入理解Python?@dataclass的內(nèi)部原理

目錄

1. dataclass簡介

2. 核心概念

2.1. annotations屬性

2.2. exec 函數(shù)

3. 自定義dataclass裝飾器

3.1. 定義架構

3.2. 初始化：init

3.3. 美化輸出：repr

3.4. 合在一起

4. 總結

相關文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

深入理解Python?@dataclass的內(nèi)部原理

目錄

1. dataclass簡介

2. 核心概念

2.1. __annotations__屬性

2.2. exec 函數(shù)

3. 自定義dataclass裝飾器

3.1. 定義架構

3.2. 初始化：init

3.3. 美化輸出：repr

3.4. 合在一起

4. 總結

相關文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

2.1. annotations屬性