Python functools.total_ordering 怎样补齐自定义类的比较方法

我在给任务对象增加排序能力时，最先踩到的坑不是不会写 __lt__，而是比较规则写了一半：相等看一个字段，排序又看另一个字段，最后列表里出现了很难解释的顺序。Python 的 functools.total_ordering 适合解决“比较契约已经想清楚，但不想重复手写其余运算符”的场景。

让对象稳定参与排序的关键，是先确定一个可复用的比较键，再实现 __eq__ 和一个排序方法（通常是 __lt__），最后由 total_ordering 补齐其余排序运算。对不支持的类型返回 NotImplemented，高频热点则要评估装饰器带来的额外调用层次。

官方文档：https://docs.python.org/3/library/functools.html#functools.total_ordering

先把对象的比较契约固定下来

total_ordering 不是自动猜业务规则的工具。它要求类至少定义 __lt__、__le__、__gt__、__ge__ 中的一个；实际工程里通常再明确写出 __eq__。比较键应该同时服务相等和排序，否则“两个对象相等但排序键不同”的问题会很快出现。

下面用优先级和名称组成稳定的元组键。代码只展示比较方法的静态契约，不依赖外部数据：

from functools import total_ordering

@total_ordering
class Task:
    def __init__(self, priority, name):
        self.priority = priority
        self.name = name

    def _key(self):
        # 相等和排序都使用同一组字段，避免比较规则分裂。
        return (self.priority, self.name)

    def __eq__(self, other):
        # 不认识的类型交给对方或 Python 的比较协议处理。
        if not isinstance(other, Task):
            return NotImplemented
        return self._key() == other._key()

    def __lt__(self, other):
        # 只实现一个基础排序方向，其余方法由装饰器补齐。
        if not isinstance(other, Task):
            return NotImplemented
        return self._key() 

这里真正重要的是“同一个 _key() 服务两个方法”。如果业务后来把名称改成不参与相等，却又让它参与排序，就应当先重新定义对象身份，而不是继续堆比较运算符。

total_ordering 补的是方法，不是业务语义

装饰器会根据你提供的基础比较方法补齐其余丰富比较方法，但不会覆盖类或父类已经声明的方法。换句话说，它减少的是样板代码，不会替你解决继承层级中的冲突，也不会判断哪个字段更重要。

使用时可以直接交给 sorted，也可以做成小型比较表：

tasks = [Task(2, "write"), Task(1, "plan"), Task(2, "review")]

# sorted 只依赖对象公开的“小于”关系，不需要额外 key 函数。
ordered = sorted(tasks)

# 相同比较键的对象应当相等，便于集合、去重和测试保持一致。
same = Task(1, "plan") == ordered[0]

我的经验是：当类的比较规则还在变化时，total_ordering 能让改动集中在 _key 和一个基础方法里；规则已经稳定、比较发生在极热路径时，再考虑显式手写全部方法，让调用关系更直接。

NotImplemented 和继承边界不能省

对完全不支持的类型，比较方法应返回 NotImplemented，而不是武断地返回 False。前者表示“这个操作数类型不是我负责的”，Python 仍有机会尝试反向比较或给出合适的 TypeError；后者会把类型不匹配伪装成普通的不相等。

class ExternalTask:
    def __init__(self, priority):
        self.priority = priority

    def __lt__(self, other):
        # 不把陌生对象强行转换成 Task，避免隐藏类型错误。
        if not isinstance(other, Task):
            return NotImplemented
        return self.priority 

还要留意继承：如果父类已经提供了比较方法，total_ordering 不会贸然重写它们；子类是否继续沿用父类的比较语义，需要由类设计者明确决定。

什么时候值得用，什么时候直接手写

最后建议至少覆盖三类检查：同类对象的相等和排序、子类对象的继承行为、陌生类型的异常边界。这样测到的不是“某个运算符能不能跑”，而是整个对象契约是否一致。

常见延伸问题

• 只写 __lt__ 不写 __eq__ 可以吗？ 装饰器可以补齐排序方向，但业务对象是否相等仍应显式定义，否则身份比较和排序键可能不一致。
• 为什么不支持类型不能直接返回 False？ False 会掩盖类型不匹配；NotImplemented 才能把决定权交回比较协议。
• 什么时候不建议使用 total_ordering？ 继承比较规则很复杂或比较处于性能热点时，直接写全套方法通常更容易审查和测量。