Python-迭代器、生成器

妖狐艹你老母 2023-06-25 06:22 33阅读 0赞

# Python-迭代器、生成器 #

生成器是 Python 初级开发者最难理解的概念之一，虽被认为是 Python 编程中的高级技能，但在各种项目中可以随处见到生成器的身影，你得不得去理解它、使用它、甚至爱上它。

提到生成器，总不可避免地要把迭代器拉出来对比着讲，**生成器就是一个在行为上和迭代器非常类似的对象**，如果把迭代器比作 Android 系统，那么生成器就是 iOS，二者功能上差不多，但是**生成器更优雅**。

### 什么是迭代器 ###

顾名思义，迭代器就是用于迭代操作（`for 循环`）的对象，它像列表一样可以迭代获取其中的每一个元素，任何实现了`__next__`方法 （python2 是 next）的对象都可以称为迭代器。

它与列表的区别在于，构建迭代器的时候，不像列表把所有元素一次性加载到内存，而是以一种延迟计算（lazy evaluation）方式返回元素，这正是它的优点。比如列表含有中一千万个整数，需要占超过400M的内存，而迭代器只需要几十个字节的空间。**因为它并没有把所有元素装载到内存中，而是等到调用 next 方法时候才返回该元素**（按需调用 call by need 的方式，本质上 for 循环就是不断地调用迭代器的next方法）。

以斐波那契数列为例来实现一个`迭代器`：

class Fib:
        def __init__(self, n):
            self.prev = 0
            self.cur = 1
            self.n = n
    
        def __iter__(self):
            return self
    
        def __next__(self):
            if self.n > 0:
                value = self.cur
                self.cur = self.cur + self.prev
                self.prev = value
                self.n -= 1
                return value
            else:
                raise StopIteration()
        # 兼容python2
        def __next__(self):
            return self.next()
    
    f = Fib(10)
    print([i for i in f])
    #[1, 1, 2, 3, 5, 8, 13, 21, 34, 55]

### 什么是生成器 ###

知道迭代器之后，就可以正式进入生成器的话题了。普通函数用 `return` 返回一个值，和 Java 等其他语言是一样的，然而在 Python 中还有一种函数，用关键字`yield`来返回值，这种函数叫生成器函数，函数被调用时会返回一个生成器对象，**生成器本质上还是一个迭代器**，也是用在迭代操作中，因此它有和迭代器一样的特性，唯一的区别在于实现方式上不一样，后者更加简洁

最简单的生成器函数：

>>> def func(n):
    ...     yield n*2
    ...
    >>> func
    <function func at 0x00000000029F6EB8>
    >>> g = func(5)
    >>> g
    <generator object func at 0x0000000002908630>
    >>>

func 就是一个生成器函数，调用该函数时返回对象就是生成器 g ，这个生成器对象的行为和迭代器是非常相似的，可以用在 for 循环等场景中。注意 yield 对应的值在函数被调用时不会立刻返回，而是调用next方法时（本质上 for 循环也是调用 next 方法）才返回

>>> g = func(5)
    >>> next(g)
    10
    
    >>> g = func(5)
    >>> for i in g:
    ...     print(i)
    ...
    10

\*\*那为什么要用生成器呢？\*\*显然，用生成器在逼格上要比迭代器高几个等级，它没有那么多冗长代码了，而且性能上一样的高效，为什么不用呢？来看看用生成器实现斐波那契数列有多简单。

def fib(n):
        prev, curr = 0, 1
        while n > 0:
            n -= 1
            yield curr
            prev, curr = curr, curr + prev
    
    print([i for i in fib(10)])
    #[1, 1, 2, 3, 5, 8, 13, 21, 34, 55]

--------------------

# Python生成器 #

通过列表生成式，我们可以直接创建一个列表。但是，受到内存限制，列表容量肯定是有限的。而且，创建一个包含100万个元素的列表，不仅占用很大的存储空间，**如果我们仅仅需要访问前面几个元素，那后面绝大多数元素占用的空间都白白浪费了**。

所以，如果列表元素可以按照某种算法推算出来，那我们是否可以在循环的过程中不断推算出后续的元素呢？这样就不必创建完整的list，从而节省大量的空间。在Python中，这种一边循环一边计算的机制，称为`生成器：generator`。

**创建生成器的方式**

*  （1）通过`列表推导式（生成式）`
 *  （2）通过`函数 + yield关键字`

--------------------

# 1、通过列表推导式创建 #

只要把一个列表生成式的`[]`改成`()`，就创建了一个generator：

>>> L = [x * x for x in range(10)]
    >>> L
    [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
    >>> g = (x * x for x in range(10))
    >>> g
    <generator object <genexpr> at 0x1022ef630>

我们可以直接打印出list的每一个元素，但我们怎么打印出generator的每一个元素呢？

如果要一个一个打印出来，可以通过`next()`函数获得`generator`的下一个返回值：

>>> next(g)
    0
    >>> next(g)
    1
    >>> next(g)
    4
    >>> next(g)
    9
    >>> next(g)
    16
    >>> next(g)
    25
    >>> next(g)
    36
    >>> next(g)
    49
    >>> next(g)
    64
    >>> next(g)
    81
    >>> next(g)
    Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
    StopIteration

我们讲过，generator保存的是算法，每次调用`next(g)`，就计算出`g`的下一个元素的值，直到计算到最后一个元素，没有更多的元素时，抛出`StopIteration`的错误。

当然，上面这种不断调用`next(g)`实在是太变态了，正确的方法是使用`for循环`，因为**generator也是可迭代对象**：

>>> g = (x * x for x in range(10))
    >>> for n in g:
    ...     print(n)
    ... 
    0
    1
    4
    9
    16
    25
    36
    49
    64
    81

所以，我们创建了一个`generator`后，**基本上永远不会调用**`next()`，而是通过`for循环`来迭代它，并且不需要关心`StopIteration`的错误。

--------------------

# 2、通过函数+yield关键字创建 #

如果推算的算法比较复杂，用类似列表生成式的for循环无法实现的时候，还可以用`函数`来实现。

比如，著名的`斐波拉契数列`（Fibonacci），除第一个和第二个数外，任意一个数都可由前两个数相加得到：

1, 1, 2, 3, 5, 8, 13, 21, 34, …

斐波拉契数列用`列表生成式`写不出来，但是，用函数把它打印出来却很容易：

def fib(max):
        n, a, b = 0, 0, 1
        while n < max:
            print(b)
            a, b = b, a + b
            n = n + 1
        return 'done'

上面的函数可以输出斐波那契数列的前N个数：

>>> fib(6)
    1
    1
    2
    3
    5
    8
    'done'

仔细观察，可以看出，`fib`函数实际上是定义了斐波拉契数列的推算规则，可以从第一个元素开始，推算出后续任意的元素，这种逻辑其实非常类似generator。

也就是说，上面的函数和generator仅一步之遥。要把`fib`函数变成`generator`，只需要把`print(b)`改为`yield b`就可以了：

def fib(max):
        n, a, b = 0, 0, 1
        while n < max:
            yield b
            a, b = b, a + b
            n = n + 1
        return 'done'

**这就是定义generator的另一种方法**。如果一个函数定义中包含`yield`关键字，那么这个函数就不再是一个普通函数，而是一个`generator`：

>>> f = fib(6)
    >>> f
    <generator object fib at 0x104feaaa0>

这里，最难理解的就是generator和函数的执行流程不一样。函数是顺序执行，遇到`return`语句或者最后一行函数语句就返回。而变成generator的函数，在每次调用`next()`的时候执行，遇到`yield`语句返回，再次执行时从上次返回的`yield`语句处继续执行。

**yield关键字的作用是**：`return + 记忆上次代码执行的位置`。

举个简单的例子，定义一个generator，依次返回数字1，3，5：

def odd():
        print('step 1')
        yield 1
        print('step 2')
        yield(3)
        print('step 3')
        yield(5)

调用该generator时，首先要生成一个generator对象，然后用`next()`函数不断获得下一个返回值：

>>> o = odd()
    >>> next(o)
    step 1
    1
    >>> next(o)
    step 2
    3
    >>> next(o)
    step 3
    5
    >>> next(o)
    Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
    StopIteration

可以看到，`odd`不是普通函数，而是generator，在执行过程中，遇到`yield`就中断，下次又继续执行。执行3次`yield`后，已经没有`yield`可以执行了，所以，第4次调用`next(o)`就报错。

回到`fib`的例子，我们在循环过程中不断调用`yield`，就会不断中断。当然要给循环设置一个条件来退出循环，不然就会产生一个无限数列出来。

同样的，把函数改成`generator`后，我们基本上从来不会用`next()`来获取下一个返回值，而是直接使用`for循环`来迭代：

>>> for n in fib(6):
    ...     print(n)
    ...
    1
    1
    2
    3
    5
    8

但是用`for循环`调用generator时，发现拿不到generator的`return`语句的返回值。如果想要拿到返回值，必须捕获`StopIteration`错误，返回值包含在`StopIteration`的`value`中：

>>> g = fib(6)
    >>> while True:
    ...     try:
    ...         x = next(g)
    ...         print('g:', x)
    ...     except StopIteration as e:
    ...         print('Generator return value:', e.value)
    ...         break
    ...
    g: 1
    g: 1
    g: 2
    g: 3
    g: 5
    g: 8
    Generator return value: done

# 参考内容 #

[廖雪峰的官方网站][Link 1]

[Link 1]: https://www.liaoxuefeng.com/wiki/1016959663602400/1017318207388128