Python中的yield,几个例子和理解

yield 实现Fibonacci数列

实现Fibonacci数列是生成器的经典例子:

def fab(max):  
n, a, b = 0, 0, 1  
while n < max:  
        yield b  
        # print b  
        a, b = b, a + b  
        n = n + 1 

代码是如此的简单,但想要深入了解yield并非表面上这么简单。其实yield是个语法糖,其作用就是把一个函数变成一个 generator类,因此带有 yield 的函数不再是一个普通函数,Python 解释器会将其视为一个 generator,调用 fab(5) 不会执行 fab 函数,而是返回一个 可迭代的对象在 for 循环执行时,每次循环都会执行 fab 函数内部的代码,执行到 yield b 时,fab 函数就返回一个迭代值,下次迭代时,代码从 yield b 的下一条语句继续执行,而函数的本地变量看起来和上次中断执行前是完全一样的,于是函数继续执行,直到再次遇到 yield。

进一步地深入:next()和send()

写一个更简单的例子来说明问题:

def h(): 
        print "hello" 
        yield 5 
        print "world"

如前面所说,在写这个函数的时候,由于使用了yield,使得改函数变为一个生成器类,而生成器自带.next()方法。将其实例化:
c = h()
则它带有next()方法。在每次执行c.next()的时候,python会依次执行函数h()体内的语句,直到出现一个yield,程序返回yield 后的内容,并会挂起。直到下一次执行c.next()。重复上述过程,直到后面没有yield语句时,会抛出StopInteration异常,如果迭代发生在for循环中,相应地,循环会结束。因此有以下的执行结果(# 后为输出结果):

c.next()  # hello   # 5
c.next()  # world   # StopIteration

进一步,可以将 yield看作表达式,并赋值给一个变量,如下面的函数:

def h(): 
        print "hello" 
        m = yield 5 
        print "m:", m 
        d = yield 12 
        print "d:", d 
        print "world"

那么问题来了:这里的md的值是什么呢?下面来看运行结果:

c = h()
c.next()  # hello   # 5
c.next()  # m: None   # 12
c.next()  # d: None   # world   # StopIteration

这里第一次调用next()时候返回的5是第一个yield 5的结果。可以看出,第二次掉用next()时返回的None就是变量m的值。那m的值为什么是None?其实生成器还有一个内建的send()方法,且send()方法和next()方法的功能有很大的重合:都是让函数体继续向下执行直到遇到下一个yield语句并挂起。而不同点是send(msg)方法会给生成器发送变量msg,并作为yield表达式的返回值赋值给其前面的变量,也就是h()中的m和d.

因此,next()就等价于send(None)。我们再用send方法来运行上面的函数:

c = h()
c.send("I am m") 
# TypeError: can't send non-None value to a just-started generator

可以看到出错了,正如错误提示所说,对于刚开始的生成器是不能send 一个non-None值的。由此也可以知道,必须要先yield,才能send(msg)。再来:

c = h()
c.send(None) # hello   # 5
c.send("I am m") # m: I am m   # 12
c.send("I am d")  # d: I am d   # world   # StopIteration

由上可以总结出,yield 后面的内容和前面的赋值其实没什么关系,前面的赋值是在yield 完成以后由send()决定的。

有了上述知识,再看一个稍微复杂的例子加深理解:

def countdown(n): 
        print "Counting down from", n 
        while n >= 0: 
                newvalue = (yield n) 
                # If a new value got sent in, reset n with it 
                if newvalue is not None: 
                        n = newvalue 
                else: 
                        n -= 1

c = countdown(10)
for x in c: 
        print x 
        if x == 10: 
                c.send(3)

输出结果是:

10
2
1
0

在for循环的第一次,相当于执行了c.next(),程序往下执行直到yield 10,因此x得到了值10且程序挂起,等待下一次的next()或send()调用。 此时,由于x=10, 在for循环中又会执行一次c.send(3),刚才挂起的程序将会继续往下执行:因为send的是3,上一次被yield表达式赋值的变量newvalue将会被赋值为3,因此在接下来的if语句中,n被赋值为3. 接着进入下一轮while循环,yield出了n=3,且程序被挂起。注意:这一次yield n并不是由for循环引起的(而是c.send()引起的),因此x并没有得到3这个值。接着才是下一轮for循环,相当于又掉用了c.next(),程序向下执行:n -= 1 (使得n变为2)-->yield n =2。这是x才得到了n=2这个值,并且被print了出来。依次类推,因此得到了序列10, 2, 1, 0

2016.12.11 更新:

注:以上代码适用于python2。在python3中,generator的next()方法被改名为__next__()

推荐阅读更多精彩内容