Python yield使用详解(一)

生成器

yield语句可以作为生成器

def countdown(n):
    while n > 0:
        yield n
        n -= 1
        
# 可以当迭代器来使用它
for x in countdown(10):
    print('T-minus', x)
    
# 可以使用next()来产出值,当生成器函数return(结束)时,报错。
>>> c = countdown(3)
>>> c
<generator object countdown at 0x10064f900>
>>> next(c)
3
>>> next(c)
2
>>> next(c)
1
>>> next(c)
Traceback (most recent call last):
 File "<stdin>", line 1, in ?
StopIteration
>>>

这篇文章我着重讲yield作为协程的使用方法,作为生成器的话我一笔带过,想要仔细了解迭代器生成器使用,我这里推荐个教程。完全理解Python迭代对象、迭代器、生成器 ,很棒,还有的话就是与生成器密切相关的itertools模块,可以了解下。但是我在讲yield协程之前我再给出一张图来说yield一个有趣的用法。

生成器类似于UNIX管道的作用

这个process会有难以置信的作用,比如实现UNIX中grep的作用。不展开,以后肯定会用到它。

生成器进化为协程

一个协程例子

重头戏来了。
如果你想更多的使用yield,那么就是协程了。协程就不仅仅是产出值了,而是能消费发送给它的值。
那么这里的例子就用协程实现上面的UNIX的grep作用

def grep(pattern):
    print("Looking for {}".format(pattern))
    while True:
        line = yield
        if pattern in line:
            print('{} : grep success '.format(line))
            
>>> g=grep('python')
# 还是个生成器
>>> g
<generator object grep at 0x7f17e86f3780>  
# 激活协程!只能用一次,也可以用g.send(None)来代替next(g)
>>> next(g)
Looking for python
# 使用.send(...)发送数据,发送的数据会成为生成器函数中yield表达式值,即变量line的值
>>> g.send("Yeah, but no, but yeah, but no")

>>> g.send("A series of tubes")
# 协程,协程,就是互相协作的程序,我发数据过去然后你协助我一下看看grep成功没
>>> g.send("python generators rock!")
python generators rock! : grep success 
# 关闭
>>> g.close()

例子讲完了。有几个注意点:

  • 生成器用于生成供迭代的数据
  • 协程是数据的消费者
  • 为了避免脑袋炸裂,不能把两个概念混为一谈
  • 协程与迭代无关
  • 注意,虽然在协程值会使用yield产出值,但这与迭代无关

发送数据给协程

预激活,到yield处暂停。然后发送item值,协程继续了,协程中item接收到发送的那个值,然后到下一个yield再暂停。

使用一个装饰器

如果不预激(primer),那么协程没什么用,调用g.send(x)之前。记住一定要调用next(g)。为了简化协程用法,有时会使用一个预激装饰器,如下。

def coroutine(func):
    def primer(*args,**kwargs):
        cr = func(*args,**kwargs)
        next(cr)
        return cr
    return primer
    
@coroutine
def grep(pattern):
 ...  

关闭一个协程

  • 一个协程有可能永远运行下去
  • 可以 .close()让它停下来
    例子中已经体现,不展开。

捕捉close()

def grep(pattern):
    print("Looking for {}".format(pattern))
    try:
        while True:
            line = yield
            if pattern in line:
                print(line)
    except GeneratorExit:
        print("Going away. Goodbye")

捕捉到.close()方法,然后会打印"Going away. Goodbye"

抛出异常

>>> g = grep("python")
>>> next(g) # Prime it
Looking for python
>>> g.send("python generators rock!")
python generators rock! : grep success 
>>> g.throw(RuntimeError,"You're hosed")
Traceback (most recent call last):
.....
.....
RuntimeError: You're hosed
>>>

说明:

  • 在协程内部能抛出一个异常
  • 异常发生于yield表达式
  • 不慌,我们可以平常的方法处理它

生成器返回数值

鉴于上面的例子是一直run下去的,所以稍加修改:

def grep(pattern):
    print("Looking for {}".format(pattern))
    while True:
        line = yield
        # 当发送的数据为None时,跳出while循环
        if line is None:
            break
        else:
            if pattern in line:
                print('{} : grep success '.format(line))
    return 'End'
    
>>> ..... 省略
>>> g.send(None)
Traceback (most recent call last):
 ...
 ...
StopIteration: End
  
# 这里可以用try捕捉异常,异常对象的value属性保存着返回的值
    try:
        g.send(None)
    except StopIteration as exc:
        result = exc.value
                   
>>> result
End

图解如下


说明:

  • 通过捕捉异常获取返回值
  • 只支持python3

总结

  1. yield的基本用法已经差不多了,有两个方面:生成器与协程(理解协程的关键在于明白它在何处暂停发送出的数据传到了哪个变量)
  2. yield的另一方面的应用是上下文管理器下一节讲
  3. yield from我这里暂时不讲,留到后面。yield from会在内部自动捕获StopIteration异常等

参考资料

David beazley协程
Fluent Python

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,240评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,328评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,182评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,121评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,135评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,093评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,013评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,854评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,295评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,513评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,398评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,989评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,636评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,657评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352

推荐阅读更多精彩内容