如何创建含可选属性的Python Dataclass？无需设置None值

你遇到的问题是：冻结dataclass里的is_complete字段用Optional[bool]注解后仍为必填项，设默认值None又会导致字段始终存在，但你希望有时完全不包含这个字段。以下是两种可行的解决方法：

方案一：动态删除默认字段 #

给is_complete设默认值None，然后在__post_init__中判断该字段是否为用户显式传入，若不是则用object.__delattr__绕过冻结dataclass的属性限制删除它：

from dataclasses import dataclass, fields
from typing import Optional
import datetime

@dataclass(frozen=True)
class MyHistoricCandle:
    open: float
    high: float
    low: float
    close: float
    volume: int
    time: datetime.datetime
    is_complete: Optional[bool] = None

    def __post_init__(self):
        # 获取字段默认值映射
        field_defaults = {f.name: f.default for f in fields(self)}
        # 若is_complete等于默认值（用户未显式传入），则删除该字段
        if getattr(self, 'is_complete') == field_defaults['is_complete']:
            object.__delattr__(self, 'is_complete')

测试效果：

# 未传入is_complete，实例中无该字段
candle1 = MyHistoricCandle(open=1, high=1, low=1, close=1, volume=1, time=datetime.datetime.now())
print('is_complete' in candle1.__dict__)  # 输出False

# 传入is_complete，实例中保留该字段
candle2 = MyHistoricCandle(open=1, high=1, low=1, close=1, volume=1, time=datetime.datetime.now(), is_complete=True)
print('is_complete' in candle2.__dict__)  # 输出True

方案二：用继承拆分类 #

创建基础类包含所有必填字段，子类添加可选字段，不同场景使用对应类，类型更严谨：

from dataclasses import dataclass
import datetime
from typing import Optional

@dataclass(frozen=True)
class BaseHistoricCandle:
    open: float
    high: float
    low: float
    close: float
    volume: int
    time: datetime.datetime

@dataclass(frozen=True)
class CompleteHistoricCandle(BaseHistoricCandle):
    is_complete: bool

使用方式：

# 不需要is_complete时用基础类
candle_base = BaseHistoricCandle(open=1, high=1, low=1, close=1, volume=1, time=datetime.datetime.now())

# 需要is_complete时用子类
candle_complete = CompleteHistoricCandle(open=1, high=1, low=1, close=1, volume=1, time=datetime.datetime.now(), is_complete=True)

方案对比 #

• 方案一适合需要统一类结构处理两种情况的场景，但要注意：如果用户主动传入None，字段会保留（因为属于显式传值）。
• 方案二更符合类型安全原则，代码结构更清晰，推荐在业务场景允许的情况下优先使用。

内容的提问来源于stack exchange，提问作者555Russich