9.8. 迭代器

到目前为止,您可能已经注意到大多数容器对象都可以使用 for 语句:

  1. for element in [1, 2, 3]:
  2. print(element)
  3. for element in (1, 2, 3):
  4. print(element)
  5. for key in {'one':1, 'two':2}:
  6. print(key)
  7. for char in "123":
  8. print(char)
  9. for line in open("myfile.txt"):
  10. print(line, end='')

这种访问风格清晰、简洁又方便。 迭代器的使用非常普遍并使得 Python 成为一个统一的整体。 在幕后,for 语句会调用容器对象中的 iter()。 该函数返回一个定义了 next() 方法的迭代器对象,该方法将逐一访问容器中的元素。 当元素用尽时,next() 将引发 StopIteration 异常来通知终止 for 循环。 你可以使用 next() 内置函数来调用 next() 方法;这个例子显示了它的运作方式:

  1. >>> s = 'abc'
  2. >>> it = iter(s)
  3. >>> it
  4. <iterator object at 0x00A1DB50>
  5. >>> next(it)
  6. 'a'
  7. >>> next(it)
  8. 'b'
  9. >>> next(it)
  10. 'c'
  11. >>> next(it)
  12. Traceback (most recent call last):
  13. File "<stdin>", line 1, in <module>
  14. next(it)
  15. StopIteration

看过迭代器协议的幕后机制,给你的类添加迭代器行为就很容易了。 定义一个 iter() 方法来返回一个带有 next() 方法的对象。 如果类已定义了 next(),则 iter() 可以简单地返回 self:

  1. class Reverse:
  2. """Iterator for looping over a sequence backwards."""
  3. def __init__(self, data):
  4. self.data = data
  5. self.index = len(data)
  6.  
  7. def __iter__(self):
  8. return self
  9.  
  10. def __next__(self):
  11. if self.index == 0:
  12. raise StopIteration
  13. self.index = self.index - 1
  14. return self.data[self.index]
  1. >>> rev = Reverse('spam')
  2. >>> iter(rev)
  3. <__main__.Reverse object at 0x00A1DB50>
  4. >>> for char in rev:
  5. ... print(char)
  6. ...
  7. m
  8. a
  9. p
  10. s