什么是迭代器,Python迭代器及其用法

前面章节中,已经对列表(list)、元组(tuple)、字典(dict)、集合(set)这些序列式容器做了详细的介绍。值得一提的是,这些序列式容器有一个共同的特性,它们都支持使用 for 循环遍历存储的元素,都是可迭代的,因此它们又有一个别称,即迭代器。

从字面来理解,迭代器指的就是支持迭代的容器,更确切的说,是支持迭代的容器类对象,这里的容器可以是列表、元组等这些 Python 提供的基础容器,也可以是自定义的容器类对象,只要该容器支持迭代即可。

Python实现自定义序列》一节中,已经学会了如何自定义一个序列类,但该序列类对象并不支持迭代,因此还不能称之为迭代器。如果要自定义实现一个迭代器,则类中必须实现如下 2 个方法:
  1. __next__(self):返回容器的下一个元素。
  2. __iter__(self):该方法返回一个迭代器(iterator)。

例如,下面程序自定义了一个简易的列表容器迭代器,支持迭代:
class listDemo:
    def __init__(self):
        self.__date=[]
        self.__step = 0
    def __next__(self):
        if self.__step <= 0:
            raise StopIteration
        self.__step -= 1
        #返回下一个元素
        return self.__date[self.__step]
    def __iter__(self):
        #实例对象本身就是迭代器对象,因此直接返回 self 即可
        return self
    #添加元素
    def __setitem__(self,key,value):
        self.__date.insert(key,value)
        self.__step += 1
mylist = listDemo()
mylist[0]=1
mylist[1]=2
for i in mylist:
    print (i)
程序执行结果为:

2
1


除此之外,Python 内置的 iter() 函数也会返回一个迭代器,该函数的语法格式如下:

iter(obj[, sentinel])

其中,obj 必须是一个可迭代的容器对象,而 sentinel 作为可选参数,如果使用此参数,要求 obj 必须是一个可调用对象,具体功能后面会讲。

可调用对象,指的是该类的实例对象可以像函数那样,直接以“对象名()”的形式被使用。通过在类中添加 __call__() 方法,就可以将该类的实例对象编程可调用对象。有关 __call__() 方法,可阅读《Python __call__()》做详细了解。

我们常用的是仅有 1 个参数的 iter() 函数,通过传入一个可迭代的容器对象,我们可以获得一个迭代器,通过调用该迭代器中的 __next__() 方法即可实现迭代。例如;
# 将列表转换为迭代器
myIter = iter([1, 2, 3])
# 依次获取迭代器的下一个元素
print(myIter.__next__())
print(myIter.__next__())
print(myIter.__next__())
print(myIter.__next__())
运行结果为:

1
2
3
Traceback (most recent call last):
  File "C:\Users\mengma\Desktop\demo.py", line 7, in <module>
    print(myIter.__next__())
StopIteration

另外,也可以使用 next() 内置函数来迭代,即 next(myIter),和 __next__() 方法是完全一样的。

从程序的执行结果可以看出,当迭代完存储的所有元素之后,如果继续迭代,则 __next__() 方法会抛出 StopIteration 异常。

这里介绍 iter() 函数第 2 个参数的作用,如果使用该参数,则要求第一个 obj 参数必须传入可调用对象(可以不支持迭代),这样当使用返回的迭代器调用 __next__() 方法时,它会通过执行 obj() 调用 __call__() 方法,如果该方法的返回值和第 2 个参数值相同,则输出 StopInteration 异常;反之,则输出 __call__() 方法的返回值。

例如,修改 listDemo 类如下所示:
class listDemo:
    def __init__(self):
        self.__date=[]
        self.__step = 0

    def __setitem__(self,key,value):
        self.__date.insert(key,value)
        self.__step += 1
    #是该类实例对象成为可调用对象
    def __call__(self):
        self.__step-=1
        return self.__date[self.__step]

mylist = listDemo()
mylist[0]=1
mylist[1]=2
#将 mylist 变为迭代器
a = iter(mylist,1)
print(a.__next__())
print(a.__next__())
程序执行结果为:

2
Traceback (most recent call last):
  File "D:\python3.6\1.py", line 20, in <module>
    print(a.__next__())
StopIteration

输出结果中,之所以最终抛出 StopIteration 异常,是因为这里原本要输出的元素 1 和 iter() 函数的第 2 个参数相同。
迭代器本身是一个底层的特性和概念,在程序中并不常用,但它为生成器这一更有趣的特性提供了基础。有关生成器的相关知识,会在后续章节中介绍。