Python 如何让一个类支持解包赋值(像 tuple 那样)

__iter__ 是最直接有效的方案,因为解包依赖迭代协议而非序列协议,只需返回迭代器即可支持解包,语义明确且可控,避免 __getitem__ 带来的序列语义误导。

为什么 __iter__ 是最直接有效的方案

Python 的解包赋值(如 a, b = obj)底层依赖的是迭代协议,不是序列协议。也就是说,只要对象实现了 iter,返回一个迭代器,就能被解包;它不需要支持 lengetitem,也不要求是 Sequence

  • 解包时解释器会调用 iter(obj),再逐个 next() 取值,直到 StopIteration
  • 如果你只实现 getitem(从 0 开始整数索引),它也能“意外”工作,但这是旧式回退行为,不推荐依赖
  • iter 更明确、更可控,且能配合生成器逻辑(比如懒计算)
class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y
def __iter__(self):
    yield self.x
    yield self.y

p = Point(3, 4) x, y = p # ✅ 成功:x=3, y=4

解包数量不匹配时怎么控制报错信息

默认情况下,如果解包数量和迭代产出项数不一致,会触发 ValueError: too many values to unpacknot enough values to unpack —— 这些是 Python 自带的,你无法直接拦截或改写。

但你可以提前校验,在 iter 中做防御性检查:

  • 如果类语义上“必须解包为 N 项”,就在 iter 开头加 assertraise ValueError
  • 注意:这只能防止“多解包”,不能防止“少解包”,因为迭代器本身可能中途抛出 StopIteration
class RGB:
    def __init__(self, r, g, b):
        self.r, self.g, self.b = r, g, b
def __iter__(self):
    # 强制要求恰好 3 项解包(虽不能完全阻止少解包,但可提示意图)
    yield self.r
    yield self.g
    yield self.b

❌ 这行不会报错,但后续使用可能出问题

r, g = RGB(255, 128, 0) # 实际上只取前两个,第三个被丢弃

__getitem__ 方案对比:什么情况该选它

getitem 确实也能让对象被解包(只要支持从 0 开始的连续整数索引),但它隐含了「序列」语义,容易误导使用者以为该对象支持切片、len()in 等操作。

  • getitem:适合你本就想把它当轻量序列用(比如自定义列表包装器)
  • iter:适合你只想暴露一个固定结构的“视图”,比如坐标、配置项、数据库行等,不希望用户误以为能 obj[10]obj[:2]
class BadTupleLike:
    def __init__(self, a, b):
        self.a, self.b = a, b
    def __getitem__(self, i):
        return (self.a, self.b)[i]  # 支持索引,但不支持 len() —— 不一致!

class GoodTupleLike: def init(self, a, b): self.a, self.b = a, b def iter(self): yield self.a yield self.b # 意图清晰:仅用于解包或 for 循环

常见陷阱:返回非迭代器对象或状态泄漏

iter 必须返回一个迭代器对象(即实现了 next 的对象),不能直接返回 list/tuple(虽然它们本身可迭代,但 iter([1,2]) 返回的是迭代器,所以返回 [1,2] 会报 TypeError: iter() returned non-iterator)。

  • 错误写法:return [self.x, self.y]
  • 正确写法:return iter([self.x, self.y]),或更推荐用生成器(yield
  • 如果内部状态可变(比如缓存了已迭代过的项),要注意多次解包是否应复位 —— 通常建议每次 iter 都返回新迭代器,避免

    意外共享状态
class MutablePoint:
    def __init__(self, x, y):
        self.x = x
        self.y = y
def __iter__(self):
    # ❌ 危险:若 self._cache 被修改,两次解包结果可能不同
    # ✅ 推荐:每次都 yield 新值,不依赖可变中间状态
    yield self.x
    yield self.y

解包看着简单,但一旦类有状态、可变属性或需要精确控制项数,iter 的实现细节就很容易成为 bug 温床。尤其注意 yield 和 return iter(...) 的语义差异,以及别让迭代逻辑偷偷依赖外部可变数据。