Python基础篇（七）-- 迭代器和生成器

        迭代是Python最强大的功能之一，是访问集合元素的一种方式。在Python中可迭代(Iterable)、迭代器(Iterator)和生成器(Generator)这几个概念是经常用到的，本文主要介绍可迭代(Iterable)、迭代器(Iterator)和生成器(Generator)的定义和使用。

        可迭代对象: 简单的说，一个对象(在Python里面一切都是对象)只要实现了只要实现了iter()方法，那么用isinstance()函数检查就是Iterable对象；

class IterObj:
    def __iter__(self):
        return self

        上面定义了一个类IterObj并实现了iter方法，这个就是一个可迭代(Iterable)对象。

it = IterObj()
print(isinstance(it, Iterable))     # true
print(isinstance(it, Iterator))     # false
print(isinstance(it, Generator))    # false

        在Python中有哪些常见的可迭代对象呢？

1. 集合或序列类型（如list、tuple、set、dict、str）
2. 文件对象
3. 在类中定义了iter()方法的对象，可以被认为是Iterable对象，但自定义的可迭代对象要能在for循环中正确使用，就需要保证iter()实现必须是正确的（即可以通过内置iter()函数转成Iterator对象。关于Iterator下文还会说明，这里留下一个坑，只是记住iter()函数是能够将一个可迭代对象转成迭代器对象，然后在for中使用）
4. 在类中实现了如果只实现getitem()的对象可以通过iter()函数转化成迭代器但其本身不是可迭代对象。所以当一个对象能够在for循环中运行，但不一定是Iterable对象。

        下面我们验证第1、2点，

from typing import Iterable
import os.path

print(isinstance([], Iterable))     # True list是可迭代对象
print(isinstance({}, Iterable))     # True dict是可迭代对象
print(isinstance((), Iterable))     # True tuple是可迭代对象
print(isinstance(set(), Iterable))  # True set是可迭代对象
print(isinstance('', Iterable))     # True string是可迭代对象
Current_Path = os.path.dirname(os.path.abspath(__file__))
with open(Current_Path + '/iter.py') as file:
    print(isinstance(file, Iterable))  # True

        再来看第3点，

print(hasattr([], "__iter__"))  # true
print(hasattr({}, "__iter__"))  # true
print(hasattr((), "__iter__"))  # true
print(hasattr('', "__iter__"))  # true

        这些内置集合或序列对象都有__iter__属性，即他们都实现了同名方法。但这个可迭代对象要在for循环中被使用，那么它就应该能够被内置的iter()函数调用并转化成Iterator对象。例如，我们看内置的可迭代对象

print(iter([]))     # 
print(iter({}))     # 
print(iter(()))     # 
print(iter(''))     # 

        它们都相应的转成了对应的迭代器(Iterator)对象。

        现在回过头再看看一开始定义的那个IterObj类

class IterObj:
    
    def __iter__(self):
        return self 
        
it = IterObj()
print(iter(it))

        我们使用了iter()函数，这时候将再控制台上打印出以下信息：

TypeError: iter() returned non-iterator of type ‘IterObj’

        出现了类型错误，意思是iter()函数不能将‘非迭代器’类型转成迭代器。

        那如何才能将一个可迭代(Iterable)对象转成迭代器(Iterator)对象呢？ 我们修改一下IterObj类的定义

class IterObj:

    def __init__(self):
        self.a = [3, 5, 7, 11, 13, 17, 19]

    def __iter__(self):
        return iter(self.a)

        我们在构造方法中定义了一个名为a的列表，然后还实现了__iter__()方法。

        修改后的类是可以被iter()函数调用的，即也可以在for循环中使用

    it = IterObj()
    print(isinstance(it, Iterable))     # true
    print(isinstance(it, Iterator))     # false
    print(isinstance(it, Generator))    # false
    print(iter(it))     # 
    for i in it:
        print(i)        # 将打印3、5、7、11、13、17、19元素

        因此在定义一个可迭代对象时，我们要非常注意__iter__()方法的内部实现逻辑，一般情况下，是通过一些已知的可迭代对象（例如，上文提到的集合、序列、文件等或其他正确定义的可迭代对象）来辅助我们来实现.

        关于第4点说明的意思是iter()函数可以将一个实现了__getitem__()方法的对象转成迭代器对象，也可以在for循环中使用，但是如果用isinstance()方法来检测时，它不是一个可迭代对象。

class IterObj:
    
    def __init__(self):
        self.a = [3, 5, 7, 11, 13, 17, 19]
    
    def __getitem__(self, i):
        return self.a[i]
        
it = IterObj()
print(isinstance(it, Iterable))     # false
print(isinstance(it, Iterator))     # false
print(isinstance(it, Generator)) false
print(hasattr(it, "__iter__"))  # false
print(iter(it))     # 

for i in it:
    print(i)        # 将打印出3、5、7、11、13、17、19

        这个例子说明了可以在for中使用的对象，不一定是可迭代对象。

小结：

• 一个可迭代的对象是实现了__iter__()方`法的对象
• 它要在for循环中使用，就必须满足iter()的调用(即调用这个函数不会出错，能够正确转成一个Iterator对象)
• 可以通过已知的可迭代对象来辅助实现我们自定义的可迭代对象
• 一个对象实现了__getitem__()方法可以通过iter()函数转成Iterator，即可以在for循环中使用，但它不是一个可迭代对象(可用isinstance方法检测())

        迭代器是一个可以记住遍历的位置的对象。迭代器对象从集合的第一个元素开始访问，直到所有的元素被访问完结束。迭代器只能往前不会后退。迭代器有两个基本的方法：iter()和next()。上文很多地方都提到了Iterator,现在我们把这个坑填上。一个对象实现了__iter__()和__next__()方法，那么它就是一个迭代器对象。 例如一个对象实现了__iter__()和__next__()方法，那么它就是一个迭代器对象。 例如

class IterObj:

    def __init__(self):
        self.a = [3, 5, 7, 11, 13, 17, 19]

        self.n = len(self.a)
        self.i = 0

    def __iter__(self):
        return iter(self.a)

    def __next__(self):
        while self.i < self.n:
            v = self.a[self.i]
            self.i += 1
            return v
        else:
            self.i = 0
            raise StopIteration()

        在IterObj中，构造函数中定义了一个列表a,列表长度n,索引i。

it = IterObj()
print(isinstance(it, Iterable))     # true
print(isinstance(it, Iterator))     # true
print(isinstance(it, Generator))    # false
print(hasattr(it, "__iter__"))      # true
print(hasattr(it, "__next__"))      # true

        集合和序列对象是可迭代的但不是迭代器，但文件对象是迭代器。

print(isinstance([], Iterator))         # false
print(isinstance({}, Iterator))         # false
print(isinstance((), Iterator))         # false
print(isinstance(set(), Iterator))      # false
print(isinstance('', Iterator))         # false
currPath = os.path.dirname(os.path.abspath(__file__))
with open(currPath+'/model.py') as file:
    print(isinstance(file, Iterator)) # true

        一个迭代器(Iterator)对象不仅可以在for循环中使用，还可以通过内置函数next()函数进行调用。

# 可迭代对象转为迭代器对象的方法
s = "字符串"
s_iter = s.__iter__()  # 此时的s_iter含有__next__的内置方法，就转为了迭代器对象。

# __next__:从头一次取出迭代器对象中的值。
print(s_iter.__next__())
print(s_iter.__next__())
print(s_iter.__next__())

# 如果迭代器对象中的值被取完之后依然继续取，就会报错。

        迭代器对象的值一旦被取完，就会“死亡”，不能再进行取值了，在想重新取值的话，就必须重新在赋值然后重新取。

        这时候我们就可以了解一下for循环的工作机理了。

# while循环取字典的值。
dic = {"1":2,"2":2}
dic_iter = dic_iter.__iter__()

while True:
    try:
        print(dic_iter.__next__())
    except StopIteration:
        break

        可以看出来，while循环也可以取出字典的值，但是比较麻烦，我们经常用的for循环更加的方便，那么for循环又是怎么工作的呢？

for k in dic:
	print(k)

# 以上述为例。
# 第一步：首先会进行dic = dic.__iter__(),将可迭代对象转化为迭代器对象
# 第二步：进行dic.__next__的调用，得到返回值给k，然后进行代码块的操作
# 第三步：循环第二步，直到出现StopIteration错误，对错误进行捕捉，退出循环。

        通过上面的例子，实际上for循环就是迭代器循环。

优点：

• 为序列和非序列提供了一个统一的迭代取值的方式。
• 惰性计算：不管迭代器对象有多大，同一时刻只有一行数据存在。

缺点：

• 在取得时候我们并不知道这个迭代器的长度。
• 取值是一次性的，过去的就让它过去，永远无法回来，除非我们在定义一个新的迭代器对象。

小结：
        所有的迭代器对象都是可迭代对象，但是不是所有的可迭代对象都是迭代器对象。可迭代对象用iter之后会转化为迭代器对象，迭代器对象用iter转化依然是迭代器对象本身。

        一个生成器既是可迭代的也是迭代器，定义生成器有两种方式：

• 列表(集合、字典)生成器
• 使用yield定义生成器函数

第一种方式：

g = (x * 2 for x in range(10))      # 0～18的偶数生成器 
print(isinstance(g, Iterable))      # true
print(isinstance(g, Iterator))      # true
print(isinstance(g, Generator))     # true
print(hasattr(g, "__iter__"))       # true
print(hasattr(g, "__next__"))       # true
print(next(g))      # 0
print(next(g))      # 2

        通过列表推导式，可以直接创建一个列表，但是受到内存限制，列表容量肯定是有限的而且，创建一个包含100万个元素的列表，占用很大的存储空间。如果我们仅仅需要访问前面几个元素，后面元素的占用存储空间就被浪费。

        所以，如果列表元素可以按照某种算法算出来，那我们就可以再循环当中不断地推导它，生成元素，这样就不必创建完整的list，从而大大节省了存储空间。

第二种方式：

def gen():
    for i in range(10):
        yield i 

这里yield的作用就相当于return,这个函数就是顺序地返回[0,10)的之间的自然数，可以通过next()或使用for循环来遍历。

当程序遇到yield关键字时，这个生成器函数就返回了，直到再次执行了next()函数，它就会从上次函数返回的执行点继续执行，即yield退出时保存了函数执行的位置、变量等信息，再次执行时，就从这个yield退出的地方继续往下执行。

在Python中利用生成器的这些特点可以实现协程。协程可以理解为一个轻量级的线程，它相对于线程处理高并发场景有很多优势。

• 迭代器与生成器：https://www.runoob.com/python3/python3-iterator-generator.html
• 一文彻底搞懂Python可迭代(Iterable)、迭代器(Iterator)和生成器(Generator)的概念：https://juejin.cn/post/6844903834381189127