MyPy：如何声明类的动态生成类变量均为字符串类型

你可以通过在Properties类中添加类型存根形式的魔法方法声明实现需求，不需要改动原有动态赋值的运行逻辑，原生MyPy即可识别。

最优实现：声明__getattr__/__setattr__类型签名 #

MyPy对动态属性的类型校验规则是：如果访问类实例上未显式定义的属性，会回退查询__getattr__方法的返回值类型；如果给未显式定义的属性赋值，会校验__setattr__的参数类型。你只需要给这两个方法加类型标注，不需要写实际运行逻辑，函数体用省略号...占位即可。

修正后的完整代码如下：

class Properties:
    # 类型检查用存根：所有动态属性读取返回字符串
    def __getattr__(self, name: str) -> str: ...
    # 类型检查用存根：所有动态属性赋值只能接收字符串
    def __setattr__(self, name: str, value: str) -> None: ...


class MyClass:
    def __init__(self):
        self.properties = Properties()
        properties_json = self.get_properties_json() 
        # 注意原代码此处漏了.items()，直接遍历dict只会拿到键，会触发解包错误
        for key, value in properties_json.items():
            setattr(self.properties, key, value)

    def get_properties_json(self) -> dict[str, str]:
        ...

效果说明 #

• 读取self.properties下的任意动态属性时，MyPy会自动判定其类型为str，可以直接调用所有字符串方法，不会报属性不存在/类型未知的错误
• 如果尝试给self.properties的属性赋非字符串值，MyPy会直接报类型错误，从校验层保证所有存储的值都是字符串
• 运行时行为和你原来的空类完全一致，没有额外性能开销，不需要引入额外依赖

可选方案：如果属性键集合固定 #

如果你后续明确知道properties_json返回的键是固定集合，也可以用@dataclass或者TypedDict定义结构，类型校验会更精准，但不适合键完全动态的场景。

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