如何为动态添加的实例变量提供Python类型检查支持？

在大量使用Django-ORM这类第三方代码时，常需要给类添加初始未声明的变量。这类代码在Python中可正常运行，但静态类型检查会失败。现有实现用Union作为返回类型存在缺陷，无法让类型检查器识别返回值是原类型T的扩展，需要通用解决方案。

原代码示例 #

import typing

class A:
    a = 1
    b = 2

class IExt(typing.Protocol):
    c: int

T = typing.TypeVar('T')

def enrich(obj: T) -> IExt | T: 
    typing.cast(IExt, obj).c = 5
    return obj
    
a = A()

print(a.a)  # OK - 显式使用类时正常
print(enrich(a).c)  # 类型检查报错，但自动补全可用
print(enrich(a).b)  # 类型检查报错，但自动补全可用
print(enrich(a).x)  # 预期失败，正常报错

报错信息 #

main.py:21: error: Item "A" of "Union[IExt, A]" has no attribute "c"  [union-attr]
main.py:22: error: Item "IExt" of "Union[IExt, A]" has no attribute "b"  [union-attr]

解决方案 #

方法1：使用交集类型（Python 3.10+） #

将enrich函数的返回类型改为T & IExt，让类型检查器知道返回对象同时具备原类型T和扩展协议IExt的所有属性：

import typing

class A:
    a = 1
    b = 2

class IExt(typing.Protocol):
    c: int

T = typing.TypeVar('T')

def enrich(obj: T) -> T & IExt: 
    typing.cast(IExt, obj).c = 5
    return obj
    
a = A()

print(a.a)  # OK
print(enrich(a).c)  # OK - 类型检查通过
print(enrich(a).b)  # OK - 类型检查通过
print(enrich(a).x)  # 预期失败，正常报错

方法2：兼容旧版本Python（使用typing.Intersection） #

如果项目基于Python 3.9及以下版本，可使用typing.Intersection替代语法层面的&：

import typing
from typing import Intersection

class A:
    a = 1
    b = 2

class IExt(typing.Protocol):
    c: int

T = typing.TypeVar('T')

def enrich(obj: T) -> Intersection[T, IExt]: 
    typing.cast(IExt, obj).c = 5
    return obj

原理说明 #

• 交集类型会告诉类型检查器：返回对象同时满足T类型和IExt协议的约束，既拥有原类的所有属性，也具备扩展的属性。
• 相比Union（表示对象是两者之一），Intersection（交集）更贴合实际逻辑——我们确实是给原对象添加了新属性，而非返回两个类型中的某一个。

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