iter()

转载须注明出处：@Orca_J35

iter()

iter(object[, sentinel])

该函数会返回一个 iterator 对象，但 object 会因为 sentinel 的传入与否，而获得截然不同的解释。

在没有传入 sentinel 的情况下，object 必须是一个支持迭代协议( __iter__() 方法)的集合(collection)对象；或者是一个支持序列协议的对象 (the __getitem__() method with integer arguments starting at 0)。如果这两种协议均不被 object 支持，iter() 便会抛出 TypeError。

Tips：这里提到的集合对象只是一种抽象概念，并非特指 Collection 类型，仅实现 __iter__() 方法即可支持 iter 函数；同样的，仅实现 __getitem__() 方法也能支持 iter 函数。

class ObjcIter:
    def __iter__(self):
        cont = 0
        while cont < 3:
            cont += 1
            yield cont


a_iter1 = iter(ObjcIter())
print(list(a_iter1))


class ObjcGetitem:
    def __getitem__(self, item):
        cont = 0

        while cont <= item:
            cont += 1
            if cont >= 5:
                raise StopIteration()
        return cont


a_iter2 = iter(ObjcGetitem())
print(list(a_iter2))

输出：

[1, 2, 3]
[1, 2, 3, 4]

列表、元组、字典等都可直接用作 iter 的参数：

>>> i = iter([1, 2, 3])
>>> i.next()
1
>>> i.next()
2
>>> i.next()
3
>>> i.next()
Traceback (most recent call last):
  File "", line 1, in 
StopIteration

如果传入了第二参数 sentinel，此时 object 必须是一个可调用(callable)对象。对于在这种情况下创建的迭代器，每当调用其 __next__() 方法时，便会以无参数形式调用 object。如果 object 的返回值等于 sentinel，便会抛出 StopIteration ；如果返回值不等于 sentinel，则直接返回该值。比如下面这个示例：

class AutoIncrement(object):
    """每次调用该类的实例，计数器便会自动加1"""

    def __init__(self):
        self._count = 0

    def __call__(self):
        self._count += 1
        return self._count


a_iter = AutoIncrement()
for i in iter(a_iter, 3):
    # 当a_iter()返回5时，便会抛出StopIteration
    # 停止迭代
    print(i, end=',')

输出：

1,2,

也可直接使用函数对象，例如：

_count = 0


def func():
    global _count
    _count += 1
    return _count


for i in iter(func, 3):
    print(i, end=",")

输出：

1,2,

iter() 带第二参数的一个使用场景是：可以一次性读取文件中的多个行，并在某个特定行停止读取。下面这个示例会持续读取一个文件，直到 readline() 方法返回空字符串为止。

with open('mydata.txt') as fp:
    for line in iter(fp.readline, ''):
        process_line(line)

参考 Iterator Types 可了解更多有关迭代器的信息。