如何获取Python dataclass字段的索引？求高效且支持自动补全的方案

假设我们有一个简单的dataclass实例：

import dataclasses as dc

@dc.dataclass
class DCItem:
    name: str
    unit_price: float

item = DCItem('test', 11)

现在需要确定实例属性item.unit_price的位置（索引）。曾尝试用dc.asdict实现获取方法：

@dc.dataclass
class DCItem:
    name: str
    unit_price: float

    def get_index(self, name):
        return list(dc.asdict(self)).index(name)

item.get_index('unit_price')  # 返回1

但该方案存在两个明显缺陷：

• 性能不佳：每次调用都要生成字典并转换为列表，属性越多性能损耗越大
• 失去自动补全：传入属性名字符串无法触发IDE的自动补全，容易出现拼写错误

结合dataclass、IntEnum和enum.auto()的解决方案 #

我们可以利用IntEnum的自动赋值特性，让枚举成员的顺序与dataclass字段顺序一一对应，从而实现高效且支持自动补全的索引获取：

import dataclasses as dc
from enum import IntEnum, auto

# 定义与dataclass字段顺序一致的枚举类
class DCItemField(IntEnum):
    NAME = auto()
    UNIT_PRICE = auto()

@dc.dataclass
class DCItem:
    name: str
    unit_price: float

# 直接通过枚举成员获取对应属性的索引
print(DCItemField.UNIT_PRICE.value)  # 输出1

# 也可以给dataclass添加类方法，封装索引操作
@dc.dataclass
class DCItem:
    name: str
    unit_price: float

    @classmethod
    def get_field_index(cls, field: DCItemField) -> int:
        return field.value

    @classmethod
    def get_field_name(cls, index: int) -> str:
        # 将枚举成员名转换为属性名格式
        return DCItemField(index).name.lower()

# 使用示例
print(DCItem.get_field_index(DCItemField.UNIT_PRICE))  # 输出1
print(DCItem.get_field_name(1))  # 输出"unit_price"

方案优势 #

• 性能高效：枚举成员的索引值是预定义的常量，无需动态生成字典，调用时直接取值，性能无损耗
• 保留自动补全：IDE能识别枚举成员，输入时会自动提示，彻底避免字符串硬编码的拼写错误
• 维护便捷：只要保持枚举成员顺序与dataclass字段顺序一致，后续字段增减或调整顺序时，只需同步修改枚举即可

注意事项 #

枚举成员的顺序必须严格与dataclass的字段顺序保持一致，否则会导致索引对应错误。

内容的提问来源于stack exchange，提问作者MiaPlan.de