Python生成器

我就是我 2022-11-10 14:25 171阅读 0赞

## 生成器简述 ##

利用迭代器，我们可以在每次迭代获取数据（通过 `next()` 方法）时按照特定的规律进行生成。但是我们在实现一个迭代器时，关于当前迭代到的状态需要我们自己记录，进而才能根据当前状态生成下一个数据。为了达到记录当前状态，并配合 `next()` 函数进行迭代使用，我们可以采用更简便的语法，即 **生成器(generator)。**

**生成器是一类特殊的迭代器**。

## 生成器的创建方法 ##

### 推导式 ###

要创建一个生成器，有很多种方法。第一种方法很简单，只要把一个列表生成式的 `[ ]` 改成 `( )`

In [26]: L = [num * 2 for num in range(5)]
    
    In [27]: L
    Out[27]: [0, 2, 4, 6, 8]
    
    In [28]: G = (num * 2 for num in range(5))
    
    In [29]: G
    Out[29]: <generator object <funexpr> at 0x000001D62EA28248>

创建 L 和 G 的区别仅在于最外层的 \[ \] 和 ( ) ， L 是一个列表，而 G 是一个生成器对象。我们可以直接打印出列表L的每一个元素，而对于生成器G，我们可以按照迭代器的使用方法来使用，即可以通过 `next()函数、for循环、list()`等方法使用。

**next() 函数**

In [30]: next(G)
    Out[30]: 0
    
    In [31]: next(G)
    Out[31]: 2
    
    In [32]: next(G)
    Out[32]: 4
    
    In [33]: next(G)
    Out[33]: 6
    
    In [34]: next(G)
    Out[34]: 8
    
    In [35]: next(G)
    ---------------------------------------------------------------------------
    StopIteration                             Traceback (most recent call last)
    <ipython-input-35-b4d1fcb0baf1> in <module>
    ----> 1 next(G)
    
    StopIteration:

**for 循环与 list**

In [38]: G = (num * 2 for num in range(5))
    
    In [39]: for i in G:
        ...:     print(i)
        ...:
    0
    2
    4
    6
    8
    
    In [40]: list(G)
    Out[40]: []
    
    In [41]: G = (num * 2 for num in range(5))
    
    In [42]: list(G)
    Out[42]: [0, 2, 4, 6, 8]

**注意：在 `ipython` 测试中由于 `G` 已经迭代到了最后，所以要重新构造G，否则没有数据。**

### yield关键字 ###

`generator` 非常强大。如果推算的算法比较复杂，用类似列表生成式的 for 循环无法实现的时候，还可以用带`yield` 关键字的函数来实现。

我们仍然用斐波那契数列来举例，回顾一下用迭代器的实现方式：

class FibIterator(object):
        """斐波那契数列迭代器"""
        def __init__(self, n):
            """ :param n: int, 指明生成数列的前n个数 """
            self.n = n
            # current用来保存当前生成到数列中的第几个数了
            self.current = 0
            # num1用来保存前前一个数，初始值为数列中的第一个数0
            self.num1 = 0
            # num2用来保存前一个数，初始值为数列中的第二个数1
            self.num2 = 1
    
        def __next__(self):
            """被next()函数调用来获取下一个数"""
            if self.current < self.n:
                num = self.num1
                self.num1, self.num2 = self.num2, self.num1+self.num2
                self.current += 1
                return num
            else:
                raise StopIteration
    
        def __iter__(self):
            """迭代器的__iter__返回自身即可"""
            return self

注意，在用迭代器实现的方式中，我们要借助几个变量 `n、current、num1、num2` 来保存迭代的状态。

现在用生成器来实现一下。

In [43]: def fib(n):
       ....:     current = 0
       ....:     num1, num2 = 0, 1
       ....:     while current < n:
       ....:         num = num1
       ....:         num1, num2 = num2, num1+num2
       ....:         current += 1
       ....: 	     yield num
       ....:     return 'done'
       ....:
    
    In [44]: F = fib(5)
    
    In [45]: next(F)
    Out[45]: 0
    
    In [46]: next(F)
    Out[46]: 1
    
    In [47]: next(F)
    Out[47]: 1
    
    In [48]: next(F)
    Out[48]: 2
    
    In [49]: next(F)
    Out[49]: 3
    
    In [50]: next(F)
    ---------------------------------------------------------------------------
    StopIteration                             Traceback (most recent call last)
    <ipython-input-37-8c2b02b4361a> in <module>()
    ----> 1 next(F)
    
    StopIteration: done

在使用生成器实现的方式中，我们将原本在迭代器 `__next__` 方法中实现的基本逻辑放到一个函数中来实现，但是将每次迭代返回数值的 `return` 换成了 `yield`，此时新定义的函数便不再是函数，而是一个**生成器**了。

简单来说：**只要在函数中有 `yield` 关键字的就称为 生成器**

此时按照调用函数的方式( 案例中为 `F = fib(5)` )使用生成器就不再是执行函数体了，而是会 **返回一个生成器对象**，然后就可以按照使用 **迭代器的方式** 来使用生成器了。

In [51]: for n in fib(5):
       ....:     print(n)
       ....:     
    0
    1
    1
    2
    3

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

In [52]: g = fib(5)
    
    In [53]: while True:
       ....:     try:
       ....:         x = next(g)
       ....:         print("value:%d" % x)      
       ....:     except StopIteration as e:
       ....:         print("生成器返回值:%s" % e.value)
       ....:         break
       ....:     
    value:1
    value:1
    value:2
    value:3
    value:5
    生成器返回值:done

### 总结 ###

*  使用了 `yield` 关键字的函数不再是函数，而是生成器。
 *  `yield` 关键字有两点作用：
    
     *  保存当前上下文环境即运行状态（断点），然后暂停执行，即将生成器（函数）挂起
     *  将 `yield` 关键字后面表达式的值作为返回值返回，此时可以理解为起到了 `return` 的作用
 *  可以使用 `next()` 函数让生成器从断点处继续执行，即唤醒生成器（函数）

**说明**

`Python3` 中的生成器可以使用 `return` 返回最终运行的返回值，而 `Python2` 中的生成器 **不允许** 使用 `return` 返回一个返回值（即可以使用 `return` 从生成器中退出，但 `return` 后不能有任何表达式）。

## 使用send唤醒 ##

除了可以使用 `next()` 函数来唤醒生成器继续执行外，还可以使用 `send()` 函数来唤醒执行。使用 `send()`函数的一个好处是可以在唤醒的同时向断点处 **传入一个附加数据**。

例如：执行到 `yield` 时，`fun()` 函数作用暂时保存，返回 `i` 的值；`temp` 接收下次 `f.send("python")`，send发送过来的值，`next(f)` 等价 `f.send(None)`

def fun():
        i = 0
        while i<5:
            temp = yield i
            print(temp)
            i+=1

### 使用send ###

In [43]: f = fun()
    
    In [44]: next(f)
    Out[44]: 0
    
    In [45]: f.send('haha')
    haha
    Out[45]: 1
    
    In [46]: next(f)
    None
    Out[46]: 2
    
    In [47]: f.send('haha')
    haha
    Out[47]: 3
    
    In [48]:

### 使用next函数 ###

In [11]: f = fun()
    
    In [12]: next(f)
    Out[12]: 0
    
    In [13]: next(f)
    None
    Out[13]: 1
    
    In [14]: next(f)
    None
    Out[14]: 2
    
    In [15]: next(f)
    None
    Out[15]: 3
    
    In [16]: next(f)
    None
    Out[16]: 4
    
    In [17]: next(f)
    None
    ---------------------------------------------------------------------------
    StopIteration                             Traceback (most recent call last)
    <ipython-input-17-468f0afdf1b9> in <module>()
    ----> 1 next(f)
    
    StopIteration:

### 使用 `__next__()` 方法（不常使用） ###

In [18]: f = fun()
    
    In [19]: f.__next__()
    Out[19]: 0
    
    In [20]: f.__next__()
    None
    Out[20]: 1
    
    In [21]: f.__next__()
    None
    Out[21]: 2
    
    In [22]: f.__next__()
    None
    Out[22]: 3
    
    In [23]: f.__next__()
    None
    Out[23]: 4
    
    In [24]: f.__next__()
    None
    ---------------------------------------------------------------------------
    StopIteration                             Traceback (most recent call last)
    <ipython-input-24-39ec527346a9> in <module>()
    ----> 1 f.__next__()
    
    StopIteration:

## 公众号 ##

**新建文件夹X**

> 大自然用数百亿年创造出我们现实世界，而程序员用几百年创造出一个完全不同的虚拟世界。我们用键盘敲出一砖一瓦，用大脑构建一切。人们把1000视为权威，我们反其道行之，捍卫1024的地位。我们不是键盘侠，我们只是平凡世界中不凡的缔造者 。