为dataclass字段使用自定义装饰器时出现Python语法错误

问题场景 #

首次尝试为dataclass字段创建并使用自定义装饰器，运行时触发语法错误。错误信息如下：

File "/mnt/sda/hd2/projects/test/dbus/test.py", line 11
flags: List[str]
^^^^^
SyntaxError: invalid syntax

错误代码 #

utils.py #

from dataclasses import dataclass, field
from typing import List

class ImmutableFieldError(Exception):
    pass

def staticlist(default_value: List[str]) -> field:
    def setter(self, value):
        raise ImmutableFieldError("Cannot modify the static constant")
    
    return field(default_factory=lambda: default_value, init=False, repr=False, hash=False, compare=False, default=None, metadata=None, fset=setter)

test.py #

#!/usr/bin/python
from utils import staticlist
from dataclasses import dataclass
from typing import List

@dataclass 
class Test:
  on : str
  
  @staticlist(['yes','no'])
  flags: List[str]

问题分析 #

1. 语法错误根源：Python的dataclass字段定义不支持@装饰器语法，这种写法仅适用于函数/方法，不能直接套在字段注解上。字段的自定义配置或默认值需通过=赋值实现。
2. 函数实现错误：field()函数不存在fset参数，试图通过该参数设置setter无效；同时default和default_factory不能同时传入，会引发参数冲突。

修复方案 #

步骤1：修改staticlist函数实现 #

通过property实现字段只读逻辑，同时返回符合dataclass要求的字段配置：

from dataclasses import dataclass, field
from typing import List

class ImmutableFieldError(Exception):
    pass

def staticlist(default_value: List[str]):
    def get_field():
        # 用property包装实现只读
        def getter(self):
            return default_value.copy()  # 返回副本避免外部修改原列表
        
        def setter(self, value):
            raise ImmutableFieldError("Cannot modify the static constant")
        
        return property(getter, setter)
    
    # 返回field对象，用default_factory生成property
    return field(default_factory=get_field, init=False, repr=False, hash=False, compare=False)

步骤2：修正test.py中的字段使用方式 #

将装饰器语法改为字段赋值：

#!/usr/bin/python
from utils import staticlist
from dataclasses import dataclass
from typing import List

@dataclass 
class Test:
  on : str
  
  flags: List[str] = staticlist(['yes','no'])

验证效果 #

运行test.py后，尝试修改flags字段会抛出预期的异常：

t = Test(on="test")
print(t.flags)  # 输出: ['yes', 'no']
t.flags = ['foo']  # 抛出ImmutableFieldError: Cannot modify the static constant

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