python中yield用法

 

在介绍yield前有必要先说明下Python中的迭代器(iterator)和生成器(constructor)。

一、迭代器(iterator)

在Python中,for循环可以用于Python中的任何类型,包括列表、元祖等等,实际上,for循环可用于任何“可迭代对象”,这其实就是迭代器

迭代器是一个实现了迭代器协议的对象,Python中的迭代器协议就是有next方法的对象会前进到下一结果,而在一系列结果的末尾是,则会引发 StopIteration。任何这类的对象在Python中都可以用for循环或其他遍历工具迭代,迭代工具内部会在每次迭代时调用next方法,并且 捕捉StopIteration异常来确定何时离开。

使用迭代器一个显而易见的好处就是:每次只从对象中读取一条数据,不会造成内存的过大开销。

比如要逐行读取一个文件的内容,利用readlines()方法,我们可以这么写:

1
2
for line in open("test.txt").readlines():
print line

这样虽然可以工作,但不是最好的方法。因为他实际上是把文件一次加载到内存中,然后逐行打印。当文件很大时,这个方法的内存开销就很大了。

利用file的迭代器,我们可以这样写:

1
2
for line in open("test.txt"):   #use file iterators
print line

这是最简单也是运行速度最快的写法,他并没显式的读取文件,而是利用迭代器每次读取下一行。

二、生成器(constructor)

生成器函数在Python中与迭代器协议的概念联系在一起。简而言之,包含yield语句的函数会被特地编译成生成器。当函数被调用时,他们返回一个生成器对象,这个对象支持迭代器接口。函数也许会有个return语句,但它的作用是用来yield产生值的。

不像一般的函数会生成值后退出,生成器函数在生成值后会自动挂起并暂停他们的执行和状态,他的本地变量将保存状态信息,这些信息在函数恢复时将再度有效

1
2
3
4
5
6
7
8
>>> def g(n):
... for i in range(n):
... yield i **2
...
>>> for i in g(5):
... print i,":",
...
0 : 1 : 4 : 9 : 16 :

要了解他的运行原理,我们来用next方法看看:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
>>> t = g(5)
>>> t.next()
0
>>> t.next()
1
>>> t.next()
4
>>> t.next()
9
>>> t.next()
16
>>> t.next()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
StopIteration

在运行完5次next之后,生成器抛出了一个StopIteration异常,迭代终止。
再来看一个yield的例子,用生成器生成一个Fibonacci数列:

1
2
3
4
5
6
7
8
9
10
def fab(max):
a,b = 0,1
while a < max:
yield a
a, b = b, a+b
 
>>> for i in fab(20):
... print i,",",
...
0 , 1 , 1 , 2 , 3 , 5 , 8 , 13 ,

看到这里应该就能理解生成器那个很抽象的概念了吧~~

 

三、补充

yield 关键字用来定义生成器(Generator),其具体功能是可以当return使用,从函数里返回一个值,不同之处是用yield返回之后,可以让函数从 上回yield返回的地点继续执行。也就是说,yield返回函数,交给调用者一个返回值,然后再“瞬移”回去,让函数继续运行, 直到吓一跳yield语句再返回一个新的值。

使用yield返回后,调用者实际得到的是一个迭代器对象,迭代器的值就是返回值,而调用该迭代器的next()方法会导致该函数恢复yield语句的执行环境继续往下跑,直到遇到下一个yield为止,如果遇不到yield,就会抛出异常表示迭代结束。

看一个例子:

>>> def test_yield():
...     yield 1
...     yield 2
...     yield (1,2)
...
>>> a = test_yield()
>>> a.next()
1
>>> a.next()
2
>>> a.next()
(1, 2)
>>> a.next()
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
StopIteration

1. 包含yield的函数

假如你看到某个函数包含了yield,这意味着这个函数已经是一个Generator,它的执行会和其他普通的函数有很多不同。比如下面的简单的函数:

  1. def h():  
  2. print ‘To be brave‘  
  3. yield 5  
  4. h() 

可以看到,调用h()之后,print 语句并没有执行!这就是yield,那么,如何让print 语句执行呢?这就是后面要讨论的问题,通过后面的讨论和学习,就会明白yield的工作原理了。

2. yield是一个表达式

Python2.5以前,Python yield是一个语句,但现在2.5中,yield是一个表达式(Expression),比如:

  1. m = yield 5 

表达式(yield 5)的返回值将赋值给m,所以,认为 m = 5 是错误的。那么如何获取(yield 5)的返回值呢?需要用到后面要介绍的send(msg)方法。

3. 透过next()语句看原理

现在,我们来揭晓yield的工作原理。我们知道,我们上面的h()被调用后并没有执行,因为它有yield表达式,因此,我们通过next()语句让它执行。next()语句将恢复Generator执行,并直到下一个yield表达式处。比如:

  1. def h():  
  2. print ‘Wen Chuan‘  
  3. yield 5  
  4. print ‘Fighting!‘  
  5. c = h()  
  6. c.next()c.next() 

调用后,h()开始执行,直到遇到yield 5,因此输出结果:

  1. Wen Chuan 

当我们再次调用c.next()时,会继续执行,直到找到下一个yield表达式。由于后面没有Python yield了,因此会拋出异常:

  1. Wen Chuan  
  2. Fighting!  
  3. Traceback (most recent call last):  
  4. File "/home/evergreen/Codes/yidld.py", line 11, in <module> 
  5. c.next()  
  6. StopIteration 

4. send(msg) 与 next()

了 解了next()如何让包含yield的函数执行后,我们再来看另外一个非常重要的函数send(msg)。其实next()和send()在一定意义上 作用是相似的,区别是send()可以传递yield表达式的值进去,而next()不能传递特定的值,只能传递None进去。因此,我们可以看做 c.next() 和 c.send(None) 作用是一样的。来看这个例子:

  1. def h():  
  2. print ‘Wen Chuan‘,  
  3. m = yield 5 # Fighting!  
  4. print m  
  5. d = yield 12  
  6. print ‘We are together!‘  
  7. c = h()  
  8. c.next() #相当于c.send(None)  
  9. c.send(‘Fighting!‘) #(yield 5)表达式被赋予了‘Fighting!‘输出的结果为:  
  10. Wen Chuan Fighting! 

需要提醒的是,第一次调用时,请使用next()语句或是send(None),不能使用send发送一个非None的值,否则会出错的,因为没有Python yield语句来接收这个值。

5. send(msg) 与 next()的返回值

send(msg) 和 next()是有返回值的,它们的返回值很特殊,返回的是下一个yield表达式的参数。比如yield 5,则返回 5 。到这里,是不是明白了一些什么东西?本文第一个例子中,通过for i in alist 遍历 Generator,其实是每次都调用了alist.Next(),而每次alist.Next()的返回值正是yield的参数,即我们开始认为被压进 去的东东。我们再延续上面的例子:

  1. def h():  
  2. print ‘Wen Chuan‘,  
  3. m = yield 5 # Fighting!  
  4. print m  
  5. d = yield 12  
  6. print ‘We are together!‘  
  7. c = h()  
  8. m = c.next() #m 获取了yield 5 的参数值 5  
  9. d = c.send(‘Fighting!‘) #d 获取了yield 12 的参数值12  
  10. print ‘We will never forget the date‘, m, ‘.‘, d输出结果:  
  11. Wen Chuan Fighting!  
  12. We will never forget the date 5 . 12 

6. throw() 与 close()中断 Generator

中断Generator是一个非常灵活的技巧,可以通过throw抛出一个GeneratorExit异常来终止Generator。Close()方法作用是一样的,其实内部它是调用了throw(GeneratorExit)的。我们看:

  1. def close(self):  
  2. try:  
  3. self.throw(GeneratorExit)  
  4. except (GeneratorExit, StopIteration):  
  5. pass  
  6. else:  
  7. raise RuntimeError("generator ignored GeneratorExit")  
  8. # Other exceptions are not caught 

因此,当我们调用了close()方法后,再调用next()或是send(msg)的话会抛出一个异常:

    1. Traceback (most recent call last):  
    2. File "/home/evergreen/Codes/yidld.py", line 14, in <module> 
    3. d = c.send(‘Fighting!‘) #d 获取了yield 12 的参数值12  
    4. StopIteration

郑重声明:本站内容如果来自互联网及其他传播媒体,其版权均属原媒体及文章作者所有。转载目的在于传递更多信息及用于网络分享,并不代表本站赞同其观点和对其真实性负责,也不构成任何其他建议。