如何解决通过setattr动态创建的类属性类型未知问题？

问题背景 #

通过setattr根据Enum过滤的字典动态给类实例设置属性后，类型检查工具（如mypy）无法识别t.name这类属性的类型，提示Type of "name" is unknown。由于Enum包含大量元素，不想逐个手动声明@property，需要简化实现的方案。

可行方案 #

方案1：TypedDict + 类变量类型注解 #

先定义对应Enum字段的TypedDict结构，再在类中预先声明所有属性的类型，保留动态初始化逻辑：

from enum import Enum
from typing import Any, TypedDict, Optional

class fields(Enum):
    ID = "id"
    NAME = "name"
    CHANNELS = "channels"
    DESCRIPTION = "description"
    DURATION = "duration"

# 定义数据结构，total=False表示允许部分字段缺失
class TrackData(TypedDict, total=False):
    id: int
    name: str
    channels: int
    description: Optional[str]
    duration: Optional[int]

class Test:
    # 预先声明所有属性的类型，让类型检查工具识别
    id: int
    name: str
    channels: int
    description: Optional[str]
    duration: Optional[int]

    def __init__(self, track_data: TrackData) -> None:
        valid_attributes = [member.value for member in fields]
        for field, value in track_data.items():
            if field not in valid_attributes:
                raise Exception(f"{field} is not a valid field")
            setattr(self, field, value)

t = Test({'id': 524545, 'name': 'TV', 'channels': 2})
print(t.name)  # mypy可识别类型为str

如果Enum字段极多，可写个小脚本自动生成类变量的类型注解，避免手动重复劳动。

方案2：dataclass配合__post_init__ #

利用dataclass自动生成属性和类型注解，在__init__中完成字段校验后，交给dataclass的初始化逻辑处理：

from enum import Enum
from dataclasses import dataclass
from typing import Any, Optional

class fields(Enum):
    ID = "id"
    NAME = "name"
    CHANNELS = "channels"
    DESCRIPTION = "description"
    DURATION = "duration"

@dataclass
class Test:
    id: int
    name: str
    channels: int
    description: Optional[str] = None
    duration: Optional[int] = None

    def __init__(self, track_data: dict[Any, Any]) -> None:
        valid_attributes = [member.value for member in fields]
        # 过滤出有效字段
        filtered_data = {k: v for k, v in track_data.items() if k in valid_attributes}
        # 调用dataclass的默认初始化逻辑
        super().__init__(**filtered_data)

t = Test({'id': 524545, 'name': 'TV', 'channels': 2})
print(t.name)  # mypy识别为str

dataclass帮你自动处理属性声明和类型绑定，无需手动写setattr，同时保留字段校验的逻辑。

方案3：getattr + dir 动态适配 #

如果不想预先声明所有属性，可通过__getattr__统一处理属性访问，用__dir__让类型检查工具感知属性存在：

from enum import Enum
from typing import Any, Optional, Union

class fields(Enum):
    ID = "id"
    NAME = "name"
    CHANNELS = "channels"
    DESCRIPTION = "description"
    DURATION = "duration"

class Test:
    def __init__(self, track_data: dict[Any, Any]) -> None:
        valid_attributes = [member.value for member in fields]
        self._data = {}
        for field, value in track_data.items():
            if field not in valid_attributes:
                raise Exception(f"{field} is not a valid field")
            self._data[field] = value

    def __getattr__(self, name: str) -> Union[int, str, None]:
        if name in self._data:
            return self._data[name]
        raise AttributeError(f"'Test' object has no attribute '{name}'")

    def __dir__(self) -> list[str]:
        # 让编辑器和类型检查工具感知到动态属性
        return super().__dir__() + list(self._data.keys())

t = Test({'id': 524545, 'name': 'TV', 'channels': 2})
print(t.name)  # mypy可识别属性存在，类型为联合类型

缺点是属性类型只能是宽泛的联合类型，若需要精确类型，优先选择方案1或2。

批量生成类型注解脚本 #

针对Enum字段过多的场景，可运行以下脚本自动生成TypedDict和类属性注解代码：

from enum import Enum

class fields(Enum):
    ID = "id"
    NAME = "name"
    CHANNELS = "channels"
    DESCRIPTION = "description"
    DURATION = "duration"

# 生成TypedDict代码
print("class TrackData(TypedDict, total=False):")
for member in fields:
    # 可根据实际业务调整类型映射
    if member.value in ["id", "channels"]:
        print(f"    {member.value}: int")
    elif member.value == "name":
        print(f"    {member.value}: str")
    else:
        print(f"    {member.value}: Optional[str]")

# 生成Test类的属性注解
print("\nclass Test:")
for member in fields:
    if member.value in ["id", "channels"]:
        print(f"    {member.value}: int")
    elif member.value == "name":
        print(f"    {member.value}: str")
    else:
        print(f"    {member.value}: Optional[str]")

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