第 2 版 Sentence 类根据《设计模式:可复用面向对象软件的基础》一 书给出的模型,实现典型的迭代器设计模式。注意,这不符合 Python 的 习惯做法,后面重构时会说明原因。不过,通过这一版能明确可迭代的 集合和迭代器对象之间的关系。

下例中定义的 Sentence 类可以迭代,因为它实现了特殊的 __iter__ 方法,构建并返回一个 SentenceIterator 实例。《设计模 式:可复用面向对象软件的基础》一书就是这样描述迭代器设计模式的。

使用迭代器模式实现 Sentence 类

# -*- coding: utf-8 -*-
import re
import reprlib
RE_WORD = re.compile('\w+')
class Sentence:
def __init__(self, text):
self.text = text
self.words = RE_WORD.findall(text)
def __repr__(self):
return 'Sentence(%s)' % reprlib.repr(self.text)
def __iter__(self):
return SentenceIterator(self.words)
class SentenceIterator:
def __init__(self, words):
self.words = words
self.index = 0
def __next__(self):
try:
word = self.words[self.index]
except IndexError:
raise StopIteration()
self.index += 1
return word
def __iter__(self):
return self

注意,对这个示例来说,其实没必要在 SentenceIterator 类中实现 __iter__ 方法,不过这么做是对的,因为迭代器应该实现 __next__ 和 __iter__ 两个方法,而且这么做能让迭代器通过 issubclass(SentenceInterator, abc.Iterator) 测试。如果让 SentenceIterator 类继承 abc.Iterator 类,那么它会继承 abc.Iterator.__iter__ 这个具体方法。

把Sentence变成迭代器:坏主意

构建可迭代的对象和迭代器时经常会出现错误,原因是混淆了二者。要 知道,可迭代的对象有个 __iter__ 方法,每次都实例化一个新的迭代 器;而迭代器要实现 __next__ 方法,返回单个元素,此外还要实现 __iter__ 方法,返回迭代器本身。

因此,迭代器可以迭代,但是可迭代的对象不是迭代器。

除了 __iter__ 方法之外,你可能还想在 Sentence 类中实现 __next__ 方法,让 Sentence 实例既是可迭代的对象,也是自身的迭 代器。可是,这种想法非常糟糕。

为了“支持多种遍历”,必须能从同一个可迭代的实例中获取多个独立的 迭代器,而且各个迭代器要能维护自身的内部状态,因此这一模式正确 的实现方式是,每次调用 iter(my_iterable) 都新建一个独立的迭代 器。这就是为什么这个示例需要定义 SentenceIterator 类。

可迭代的对象一定不能是自身的迭代器。也就是说,可迭代的对象 必须实现 __iter__ 方法,但不能实现 __next__ 方法。

另一方面,迭代器应该一直可以迭代。迭代器的 __iter__ 方法应 该返回自身。

至此,我们演示了如何正确地实现典型的迭代器模式。本节至此告一段 落,下一节展示如何使用更符合 Python 习惯的方式实现 Sentence 类。