python中的yield关键字是个什么鬼？它有什么用处？

最新推荐文章于 2024-09-23 09:21:23 发布

向东的笔记本

最新推荐文章于 2024-09-23 09:21:23 发布

阅读量1w

点赞数 14

分类专栏： Python错误文章标签： yield 迭代器生成器函数生成器

本文链接：https://blog.csdn.net/gaifuxi9518/article/details/81055856

版权

Python错误专栏收录该内容

14 篇文章 3 订阅

订阅专栏

yield是一个常用于python函数定义中的关键字，它的作用是返回一个可以用来迭代（for循环）的生成器，它的应用场景通常为一个需要返回一系列值的，含有循环的函数中。

如果想要彻底搞懂yield关键词的用法，你务必先要搞懂如下词的意思：迭代，可迭代，迭代器，生成器。接下来我将逐一介绍这些词的含义，以及相应的用法。

迭代（iteration）和可迭代（iterable）

迭代是一种操作。很多数据本身就是一种容器(container)，它们里面装有各种类型的其他数据，比如列表（list），字典（dict），元组(tuple)等。当我们在实际中使用这些容器的时候，常常需要逐一从里面获取数据，例如说，我们常用for...in...来打印列表中数据，而这种逐个获取数据的过程就叫做迭代。

# iteration
a_list = [1, 2, 3]
for i in a_list:
    print(i)

可迭代则是对象的一种特性，比如说列表（list）是可迭代的，元组(tuple)是可迭代的，字典(dict)是可迭代的，字符串(string)是可迭代的，file对象也是可以迭代的。因为我们都可以从这些数据类型中逐一获取数据。

迭代器（iterator）

迭代器是一个对象，这种对象每次只能调取一个数据元素。对迭代器不断调用 next() 方法（将迭代起变量放入next()中当参数），则可以依次获取下一个元素；当迭代器中没有元素时，调用 next() 方法会抛出 StopIteration（停止迭代）异常。迭代器的 __iter__() 方法返回迭代器自身；因此迭代器也是可迭代的。

def liebiao():
	for x in range(10):
		yield x

g = liebiao()

#0
print(next(g))

#1
print(next(g))

#2
print(next(g))

#3
print(next(g))

#4
print(next(g))

#<generator object liebiao at 0x02C70E70>
g.__iter__()

生成器函数（generation function）和生成器（generation）

生成器函数是一种特殊的函数，它的函数内部含有yield表达式，调用它会返回一个特殊的迭代器，称生成器。

def func():
    return 1

def gen():
    yield 1

print(type(func))   # <class 'function'>
print(type(gen))    # <class 'function'>

print(type(func())) # <class 'int'>
print(type(gen()))  # <class 'generator'>

yield表达式

如前所述，如果一个函数定义中包含 yield 表达式，那么该函数是一个生成器函数（而非普通函数）。实际上，yield 仅能用于定义生成器函数。

与普通函数不同，生成器函数被调用后，其函数体内的代码并不会立即执行，而是返回一个生成器（generator-iterator）。当返回的生成器调用成员方法时，相应的生成器函数中的代码才会执行。

def square():
    for x in range(4):
        yield x ** 2
square_gen = square()
for x in square_gen:
    print(x)

前面说到，for 循环会调用 iter() 函数，获取一个生成器；而后调用 next() 函数，将生成器中的下一个值赋值给 x；再执行循环体。因此，上述 for 循环基本等价于：

genitor = square_gen.__iter__()
while True:
    x = geniter.next() # Python 3 是 __next__()
    print(x)

注意到，square 是一个生成器函数；作为它的返回值，square_gen 已经是一个迭代器；迭代器的 __iter__() 返回它自己。因此 geniter 对应的生成器函数，即是 square。

每次执行到 x = geniter.next() 时，square 函数会从上一次暂停的位置开始，一直执行到下一个 yield 表达式，将 yield 关键字后的表达式列表返回给调用者，并再次暂停。注意，每次从暂停恢复时，生成器函数的内部变量、指令指针、内部求值栈等内容和暂停时完全一致。

换个说法

如果你看不懂生成器函数，也就是带有yield关键字的函数，那么你可以这样去理解：

在函数开始处，加入 result = list()；
将每个 yield 表达式 yield expr 替换为 result.append(expr)；
在函数末尾处，加入 return result。

也就是说，yield的本质功能还是返回了一个可供迭代的列表。

yield的好处

介绍了这么多定义和用法，那么到底为什么要用yield呢？它有什么样的好处呢？

在很多时候，我们需要逐个去获取容器内的某些数据，而这种仅仅获取部分元素的情况，并不需要我们将容器内所有的元素都取出来。比如说一个容器内现有10000个元素，但我们只需要前5个元素，那么解决办法通常由如下两种：

获取容器内的所有元素，然后取出前 5 个；
从头开始，逐个迭代容器内的元素，迭代 5 个元素之后停止。

显而易见，如果容器内的元素数量非常多（比如有 10 ** 8 个），或者容器内的元素体积非常大，那么后一种方案能节省巨大的时间、空间开销。

现在假设，我们有一个函数，其产出（返回值）是一个列表。而若我们知道，调用者对该函数的返回值，只有逐个迭代这一种方式。那么，如果函数生产列表中的每一个元素都需要耗费非常多的时间，或者生成所有元素需要等待很长时间，则使用 yield 把函数变成一个生成器函数，每次只产生一个元素，就能节省很多开销了。

参考文章：https://liam0205.me/2017/06/30/understanding-yield-in-python/