Python中如何为对象上可能不存在的属性添加类型提示？

当类的某个属性可能未初始化（即不存在）或为指定类型时，可以通过以下几种方式添加类型提示：

1. 使用Optional[int]并补充文档说明 #

Optional[T]在类型系统中通常表示值可以是T或者None，结合场景注释后，能清晰传达属性"可能不存在"的含义，适合大多数简单场景：

from typing import Optional

class X:
    __slots__ = ('attr',)
    attr: Optional[int]
    """属性可能未初始化，访问前需确认是否存在"""

2. 使用Annotated附加元数据 #

通过typing.Annotated给类型添加额外说明，明确标注属性是可选存在的，让类型检查器和其他开发者更清楚语义：

from typing import Annotated

class X:
    __slots__ = ('attr',)
    attr: Annotated[int, "该属性可能未被初始化，访问前需检查是否存在"]

3. 结合类型守卫（Type Guard）辅助检查 #

如果需要在代码中安全访问该属性，可以定义类型守卫函数，配合类型提示让类型检查器识别属性存在的情况：

from typing import Optional, TypeGuard

class X:
    __slots__ = ('attr',)
    attr: Optional[int]

def has_attr(x: X) -> TypeGuard[X & {"attr": int}]:
    return hasattr(x, 'attr')

# 使用示例
x = X()
if has_attr(x):
    # 此处类型检查器会识别x.attr为int类型
    print(x.attr + 1)

无__slots__场景的处理 #

对于不使用__slots__的动态类，上述方案完全适用——类型提示关注的是属性的存在性和类型，和是否用__slots__限制属性列表无关，只需保证属性被允许添加即可。

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