Python3 - 实现迭代器协议

问题

构建一个支持迭代操作的自定义对象，并找到一个能实现迭代协议的简单方法。

解决方案

在一个对象上，实现迭代操作最简单的方式是使用一个生成器函数。 实现一个以深度优先方式，遍历树形节点的生成器。示例：

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)

    def depth_first(self):
        yield self
        for c in self:
            yield from c.depth_first()

# Example
if __name__ == '__main__':
    root = Node(0)
    child1 = Node(1)
    child2 = Node(2)
    root.add_child(child1)
    root.add_child(child2)
    child1.add_child(Node(3))
    child1.add_child(Node(4))
    child2.add_child(Node(5))

    for ch in root.depth_first():
        print(ch)
    # Outputs Node(0), Node(1), Node(3), Node(4), Node(2), Node(5)

示例代码中，depth_first() 方法简单直观。它首先返回自己本身，并迭代每一个子节点，通过yield from 语句，调用子节点的 depth_first()方法，返回对应元素。

讨论

Python的迭代协议要求一个 __iter__() 方法，返回一个特殊的迭代器对象， 这个迭代器对象实现了 __next__() 方法并通过 StopIteration 异常标识迭代的完成。 但是，实现这些通常会比较繁琐。 通常，将迭代器定义为一个生成器后一切迎刃而解。