如何让继承collections.UserList的Python类保留类型提示功能？

要让Python静态分析工具识别MyList的元素类型，同时保留自定义方法提示，需要给类添加泛型类型注解，具体步骤如下：

1. 导入必要的类型工具 #

引入泛型相关的类型变量和基类：

from collections import UserList
from typing import TypeVar, Generic, Iterable

2. 定义泛型版本的MyList类 #

通过TypeVar定义类型变量，让MyList继承Generic[T]和UserList[T]，明确类的元素类型参数：

# 定义类型变量T，代表列表的元素类型
T = TypeVar('T')

class MyList(Generic[T], UserList[T]):
    # 给构造函数添加Iterable[T]的类型注解，匹配UserList的初始化逻辑
    def __init__(self, initlist: Iterable[T] | None = None) -> None:
        super().__init__(initlist)
    
    # 自定义方法示例，类型提示会正常生效
    def multiply_all(self, factor: T) -> None:
        for i in range(len(self)):
            self[i] *= factor

3. 使用泛型类 #

实例化时可以显式指定元素类型，也可以让静态分析工具自动推断：

# 显式指定元素为int类型
int_list: MyList[int] = MyList([1, 2, 3, 4])
# 循环时IDE会识别an_int是int类型
for an_int in int_list:
    print(an_int + 1)

# 自动推断元素为str类型
str_list = MyList(["a", "b", "c"])
# 自定义方法multiply_all会提示参数需要str类型
str_list.multiply_all("x")

原理说明 #

• Generic[T]让MyList成为泛型类，允许指定元素类型参数；
• UserList[T]明确了底层列表的元素类型为T，静态分析工具可以通过这个泛型参数追踪元素类型；
• 这种方式既完整复用了UserList的所有原生行为，又能保留自定义方法的代码提示，同时解决了循环遍历元素时的类型识别问题。

内容的提问来源于stack exchange，提问作者Tomáš Zato