【Python基础】迭代器

什么是迭代

• 迭代是访问序列类型元素的一种方式

nums = [1, 2, 3, 4, 5, 6]

for num in nums:
    print(num)

1
2
3
4
5
6

• 可以使用for循环对string、list、tuple、dict、set等数据类型进行遍历，从中依次获取元素，这个过程称为迭代

---

可迭代对象

• 是否所有的数据类型都可以通过for循环进行迭代呢？

tel = 10086

for item in tel:
    print(item)

Traceback (most recent call last):
  File "C:/Users/FOLLOW_MY_HEART/Desktop/Python基础/【Python基础】迭代器/test.py", line 3, in <module>
    for item in tel:
TypeError: 'int' object is not iterable

• 通过运行发现TypeError异常，显示int类型不是iterable类型，即可迭代类型

判断数据类型是否是可迭代类型

from collections.abc import Iterable

# 判断 string 类型是否是可迭代类型
print(isinstance('abcdef', Iterable))
# 判断 list 类型是否是可迭代类型
print(isinstance([], Iterable))
# 判断 tuple 类型是否是可迭代类型
print(isinstance((0, 0), Iterable))
# 判断 dict 类型是否是可迭代类型
print(isinstance({'key': 'value'}, Iterable))
# 判断 set 类型是否是可迭代类型
print(isinstance({}, Iterable))

# 判断 int 类型是否是可迭代类型
print(isinstance(0, Iterable))
# 判断 float 类型是否是可迭代类型
print(isinstance(3.14, Iterable))

True
True
True
True
True
False
False

• 可以看到string、list、tuple、dict、set数据类型是Iterable类的实例，是可迭代类型
• int、float数据类型不是Iterable类的实例，不是可迭代类型

---

迭代器

• 迭代器是一个记录遍历位置的对象
• 迭代器对象从第一个元素开始访问，直至对所有的元素进行了访问
• 迭代器只能前进，不能后退

对可迭代对象进行迭代的本质

• 在对可迭代对象进行迭代的过程中，每迭代一步都会返回对象的下一个元素数据，一直向后读取元素数据，直至迭代了所有的元素

• 在这个过程中应该存在记录当前遍历位置的对象，以便每一步迭代都能返回下一条数据，这个对象就是迭代器

• 可迭代对象的本质就是提供了进行数据迭代的迭代器对象的对象类型

• list、tuple等都是可迭代对象，可以通过iter()函数获取这些可迭代对象提供的迭代器，然后可以通过对迭代器使用next()函数来获取下一条数据

获取可迭代对象的迭代器

• 通过iter()函数获取可迭代对象的迭代器

from collections.abc import Iterator

nums = [1, 2, 3, 4, 5, 6]

nums_iter = iter(nums)  # 获取 list 对象的迭代器

print(type(nums_iter))

print(isinstance(nums, Iterator))
print(isinstance(nums_iter, Iterator))

<class 'list_iterator'>
False
True

通过迭代器获取数据

• 通过对迭代器使用next()函数来获取下一条数据

nums = [1, 2, 3]

nums_iter = iter(nums)  # 获取 list 对象的迭代器

num1 = next(nums_iter)
print(num1)

num2 = next(nums_iter)
print(num2)

num3 = next(nums_iter)
print(num3)

1
2
3

StopIteration异常

• 如果将上面的代码多调用一次next()会发生什么？

nums = [1, 2, 3]

nums_iter = iter(nums)  # 获取 list 对象的迭代器

num1 = next(nums_iter)
print(num1)

num2 = next(nums_iter)
print(num2)

num3 = next(nums_iter)
print(num3)

num4 = next(nums_iter)  # 这里会产生异常
print(num4)

1
2
3
Traceback (most recent call last):
  File "C:/Users/FOLLOW_MY_HEART/Desktop/Python基础/【Python基础】迭代器/test.py", line 14, in <module>
    num4 = next(nums_iter)
StopIteration

• 可以看到第$14$行代码处产生了异常
• 因为列表nums中只有$3$个元素，调用$4$次next()显然无法获取到第$4$个元素
• 所以StopIteration异常其实是一种告知迭代结束的标志而已
• 添加异常处理即可解决问题

nums = [1, 2, 3]

nums_iter = iter(nums)  # 获取 list 对象的迭代器

num1 = next(nums_iter)
print(num1)

num2 = next(nums_iter)
print(num2)

num3 = next(nums_iter)
print(num3)

try:
    num4 = next(nums_iter)
    print(num4)
except StopIteration as e:
    print('迭代结束')

1
2
3
迭代结束

---

自定义迭代器

• 上面提到的iter()方法必须是对可迭代对象才能提取到迭代器对象，但是怎样保证自定义对象是可迭代对象呢？

__iter__()方法

• 无__iter__()方法

from collections.abc import Iterable


class MyList:
    def __init__(self):
        self.my_list = list()

    def add(self, item):
        self.my_list.append(item)


mylist = MyList()

print(isinstance(mylist, Iterable))

False

• 有__iter__()方法

from collections.abc import Iterable


class MyList:
    def __init__(self):
        self.my_list = list()

    def add(self, item):
        self.my_list.append(item)

    def __iter__(self):
        pass


mylist = MyList()

print(isinstance(mylist, Iterable))

True

• 可以看出，只要一个类定义了__iter__()方法，那么这个类的实例就是可迭代对象
• 实际上，当调用iter()方法获取一个可迭代对象的迭代器时，会自动触发这个对象的__iter__()方法，返回这个对象的迭代器

__next__()方法

• 通过对迭代器使用next()函数能够获取下一条数据，实际上会自动触发这个对象的__next__()方法
• 所以想要构造一个迭代器，就要实现__next__()方法
• Python要求迭代器本身也是可迭代的，所以还要为迭代器类实现__iter__()方法，而__iter__()方法要返回一个迭代器，迭代器自身正是一个迭代器，所以迭代器类的__iter__()方法返回自身即可
• 一个实现了__iter__()方法和__next__()方法的对象就是迭代器

判断数据类型是否是可迭代类型

• 使用isinstance()判断一个对象是否是Iterator对象

from collections.abc import Iterable, Iterator

nums = [1, 2, 3]

print(isinstance(nums, Iterable))
print(isinstance(nums, Iterator))

nums_iter = iter(nums)  # 获取 list 对象的迭代器

print(isinstance(nums_iter, Iterable))
print(isinstance(nums_iter, Iterator))

True
False
True
True

自定义迭代器案例

分离模式

class MyList:
    def __init__(self):
        self.items = list()
        self.current = 0  # 记录当前迭代位置

    def add(self, value):
        self.items.append(value)

    def __iter__(self):
        return MyIterator(self)  # 返回一个迭代器对象


class MyIterator:
    def __init__(self, my_list_obj):
        self.my_list_obj = my_list_obj

    def __iter__(self):
        return self

    def __next__(self):
        if self.my_list_obj.current < len(self.my_list_obj.items):
            item = self.my_list_obj.items[self.my_list_obj.current]

            self.my_list_obj.current += 1  # 当前迭代位置加 1

            return item
        else:
            raise StopIteration  # 手动抛出异常


if __name__ == '__main__':
    my_list = MyList()

    my_list.add(1)
    my_list.add(2)
    my_list.add(3)

    iter_obj = iter(my_list)

    print(next(iter_obj))  # 打印 1

    # 打印 2、3, 思考一下为什么 for 循环从 2 开始打印
    for item in my_list:
        print(item)

1
2
3

整合模式

class MyList:
    def __init__(self):
        self.items = list()
        self.current = 0  # 记录当前迭代位置

    def add(self, value):
        self.items.append(value)

    def __iter__(self):
        return self  # 返回一个迭代器对象

    def __next__(self):
        if self.current < len(self.items):
            item = self.items[self.current]

            self.current += 1  # 当前迭代位置加 1

            return item
        else:
            raise StopIteration  # 手动抛出异常


if __name__ == '__main__':
    my_list = MyList()

    my_list.add(1)
    my_list.add(2)
    my_list.add(3)

    iter_obj = iter(my_list)

    print(next(iter_obj))  # 打印 1

    # 打印 2、3, 思考一下为什么 for 循环从 2 开始打印
    for item in my_list:
        print(item)

for循环的本质

nums = [1, 2, 3, 4, 5, 6]

nums_iter = iter(nums)
while True:
    try:
        print(next(nums_iter))
    except StopIteration:
        break

1
2
3
4
5
6

• 在对可迭代对象进行迭代时，for循环先调用iter()方法，会自动触发这个对象的__iter__()方法，返回这个对象的迭代器
• 然后，对获取到的迭代器不断调用next()方法，会自动触发这个对象的__next__()方法，返回下一条数据
• 最后，通过处理StopIteration异常来结束循环

---

接收可迭代对象的方式

• 并不是只有for循环能够接收可迭代对象
• list()、tuple()等也能接收可迭代对象

示例

class MyList:
    def __init__(self):
        self.items = list()
        self.current = 0  # 记录当前迭代位置

    def add(self, value):
        self.items.append(value)

    def __iter__(self):
        return self  # 返回一个迭代器对象

    def __next__(self):
        if self.current < len(self.items):
            item = self.items[self.current]

            self.current += 1  # 当前迭代位置加 1

            return item
        else:
            raise StopIteration  # 手动抛出异常


if __name__ == '__main__':
    my_list = MyList()

    my_list.add(1)
    my_list.add(2)
    my_list.add(3)

    iter_obj = iter(my_list)

    print(list(iter_obj))

[1, 2, 3]

• 对迭代器iter_obj调用list()，返回了包含迭代出的所有数据的列表

---