Python2.7类属性默认值为None的类型标注最佳实践

针对你遇到的类属性初始为None、构造函数中赋值为列表的场景，以下是无需修改类结构的类型提示添加方式：

方案1：明确标注类属性与实例属性的类型 #

通过注释分别标注类属性的可选类型，以及构造函数中实例属性的具体类型，让类型检查器正确识别实例化后的属性类型：

from typing import Optional, List, Any

class Myclass(object):
    _myList = None  # type: Optional[List[Any]]
    _myList2 = None  # type: Optional[List[Any]]
    _myList3 = None  # type: Optional[List[Any]]
    
    def __init__(self, inList=None):
        # type: (Optional[List[Any]]) -> None
        self._myList = inList or []  # type: List[Any]
        self._myList2 = []  # type: List[Any]
    
    def show(self):
        print(self._myList)  # Pyright会推断为List[Any]
        print(self._myList2)
        print(self._myList3)  # 保持Optional[List[Any]]类型

说明 #

• 类属性标注为Optional[List[Any]]，明确初始值允许为None，解决T1/T2行的类型不匹配报错。
• 构造函数中给实例属性标注List[Any]，告诉类型检查器：实例化后这些属性不再是None，确保show方法能正确推断类型。
• Any可替换为具体元素类型（如List[int]），提升类型检查精度。

方案2：使用断言进行类型窄化 #

如果不想在构造函数中添加实例属性的类型注释，可在属性使用处通过assert告诉类型检查器属性不为None：

from typing import Optional, List, Any

class Myclass(object):
    _myList = None  # type: Optional[List[Any]]
    _myList2 = None  # type: Optional[List[Any]]
    _myList3 = None  # type: Optional[List[Any]]
    
    def __init__(self, inList=None):
        # type: (Optional[List[Any]]) -> None
        self._myList = inList or []
        self._myList2 = []
    
    def show(self):
        # type: () -> None
        assert self._myList is not None, "_myList已在__init__中初始化"
        assert self._myList2 is not None, "_myList2已在__init__中初始化"
        print(self._myList)  # 类型推断为List[Any]
        print(self._myList2)
        print(self._myList3)

说明 #

• 断言不会影响运行逻辑（Python2.7支持assert），但能让类型检查器将属性类型从Optional[List[Any]]窄化为List[Any]。
• 断言消息可自定义，用于文档说明属性的初始化保证。

关键注意事项 #

1. 泛型类型必须指定元素类型：Python2.7的typing.List是泛型，不能直接写List，必须指定元素类型（如List[int]或List[Any]），否则类型检查器会视为List[Unknown]，触发类型不匹配错误。
2. 严格使用Python2.7兼容语法：所有类型提示必须用注释风格（# type: ...），不能使用Python3.6+的变量注解（如_myList: Optional[List] = None）。
3. 区分类属性与实例属性：类属性初始为None，类型为Optional；实例化后的属性在构造函数中被赋值为列表，类型为List，通过注释标注可让类型检查器正确区分两者。

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