Python 特殊方法 __length_hint__() 对象长度估计值

object.__length_hint__(self) 方法是 Python 3.4 引入的一个特殊方法，用于向解释器提供一个估计值，表示对象的长度或大小。它是为了支持 len() 函数优化而引入的。

原理

当你调用 len() 函数时，Python 解释器会尝试调用对象的 __len__() 方法来获取对象的长度。但有些对象的长度无法高效地计算，或者计算代价太高。在这种情况下，可以实现 __length_hint__() 方法，提供一个估计值，从而避免不必要的性能开销。

__length_hint__() 方法的行为与 __len__() 方法略有不同。__len__() 方法应该返回准确的对象长度，而 __length_hint__() 方法则可以返回一个估计值。它的返回值应该是一个整数，表示对象的长度或大小的估计值。

调用此方法以实现 operator.length_hint()。 应该返回对象长度的估计值（可能大于或小于实际长度）。 此长度应为一个 >= 0 的整数。 返回值也可以为 NotImplemented ，这会被视作与 __length_hint__() 方法完全不存在时一样处理。 此方法纯粹是为了优化性能，并不要求正确无误。

示例

一个自定义的集合类，其中的元素是独一无二的，而且可能很多。由于这个集合类可能会包含大量的元素，获取准确的长度可能会很耗时。因此，我们可以使用 __length_hint__() 方法提供一个估计值，以提高性能。

class UniqueSet:
    def __init__(self, data):
        self.data = list(set(data))  # 去除重复元素
        self.length = len(self.data)  # 记录实际长度

    def __len__(self):
        # 返回集合的准确长度
        return self.length

    def __length_hint__(self):
        # 提供集合长度的估计值
        return min(self.length, 1000)  # 假设最多可能有 1000 个元素

    def __contains__(self, item):
        # 检查元素是否在集合中
        return item in self.data

# 创建一个 UniqueSet 对象
unique_set = UniqueSet([1, 2, 3, 3, 4, 5, 5, 5, 6])

# 使用 len() 函数获取准确长度
print(len(unique_set))  # 输出 6

# 获取长度的估计值
print(unique_set.__length_hint__())  # 输出 6

# 使用 operator.length_hint() 调用
import operator

operator.length_hint(unique_set)
# 6

在这个例子中，UniqueSet 类实现了一个自定义的集合类，其中的元素是独一无二的。在 __length_hint__() 方法中，我们提供了一个长度的估计值，这里假设集合最多可能有 1000 个元素。这样，当需要获取集合的长度时，可以使用 len() 函数获取准确的长度，或者使用 __length_hint__() 方法获取长度的估计值。

应用举例

假设你正在开发一个自定义的数据流迭代器，这个迭代器从某个数据源中获取数据。这个数据源可能是一个网络连接、一个文件、或者是一个数据库查询结果。由于数据源的特性，无法确定迭代器所包含的数据的精确长度，因此你可以使用 __length_hint__() 方法来提供一个长度的估计值。

参考

• https://docs.python.org/zh-cn/3/reference/datamodel.html#object.__length_hint__

更新时间：March 4, 2024, 8:18 p.m. 标签：python 特殊方法 长度