Python3 - 代理迭代

问题

构建一个自定义容器对象，里面包含有列表、元组或其他可迭代对象，并执行迭代操作。

解决方案

定义一个 __iter__() 方法，将迭代操作代理到容器内部的对象上。比如：

class Node(object):
    def __init__(self, value):
        self._value = value
        self._children = []

    def __repr__(self):
        return 'Node({!r})'.format(self._value)

    def add_child(self, node):
        self._children.append(node)

    def __iter__(self):
        return iter(self._children)


# Example
if __name__ == '__main__':
    root = Node(0)
    child1 = Node(1)
    child2 = Node(2)
    root.add_child(child1)
    root.add_child(child2)
    for ch in root:
        print(ch)

Node(1)
Node(2)

在示例代码中，__iter__() 方法只是简单的将迭代请求，传递给内部的 _children 属性。

讨论

Python的迭代器协议需要 __iter__() 方法返回一个实现了 __next__() 方法的迭代器对象。 如果只是迭代遍历容器的内容，无须关注底层的实现逻辑，传递迭代请求既可。

示例中简化了 iter() 函数代码，iter(s) 只是简单地调用 s.__iter__() 方法，来返回对应的迭代器对象， 与 len(s) 会调用 s.__len__() 原理是一样的。