如何正确为排序键函数添加类型标注？解决mypy类型不兼容错误

报错根源 #

1. 返回值不符合排序要求
   sorted的key函数必须返回可比较的类型（比如int、str这类能直接用</>比较的类型），但你的srt方法返回Optional[int]——也就是可能返回None。而None和int无法直接比较，mypy会提前拦截这种可能导致运行时崩溃的写法。

2. 参数类型不匹配
   self.__dict__.values()返回的元素类型是Any（类的__dict__可以存储任意属性），但srt声明只接受Optional[Colour]类型的参数。mypy无法确认__dict__里的所有元素都是Colour或None，因此判定参数类型不兼容。

另外，即便运行时__dict__里全是Colour实例，srt里的isinstance检查属于冗余逻辑，但类型签名仍允许传入None，这也会让mypy认为存在返回None的风险。

正确解决方式 #

情况一：__dict__里全是Colour实例 #

如果确定类的所有属性都是Colour类型，那么：

• 修正srt的类型签名，去掉Optional，明确参数是Colour，返回值是int
• 显式过滤或断言元素类型，让mypy识别待排序元素的类型

示例代码：

# 修正srt方法
def srt(self, r: Colour) -> int:
    return r.index

# 调用sorted时先过滤并标注类型
colour_items = [v for v in self.__dict__.values() if isinstance(v, Colour)]
items = sorted(colour_items, key=self.srt)

情况二：__dict__里存在非Colour元素 #

如果类的属性里混有其他类型，且你需要保留这些元素参与排序，可以给非Colour元素返回一个固定的int值（比如用float('inf')让它们排到最后），绝对不能返回None：

示例代码：

def srt(self, r: object) -> int:
    if isinstance(r, Colour):
        return r.index
    return float('inf')  # 非Colour元素统一排到末尾

# 直接调用sorted即可，无需额外处理
items = sorted(self.__dict__.values(), key=self.srt)

额外建议：避免直接操作__dict__ #

直接访问__dict__不是最佳实践，如果你只需要排序特定类型的属性，最好显式收集这些属性，比如写一个方法返回所有Colour类型的属性：

def get_colour_props(self):
    return [v for v in self.__dict__.values() if isinstance(v, Colour)]

# 排序时直接用lambda替代单独的srt方法，更简洁
items = sorted(self.get_colour_props(), key=lambda x: x.index)

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