Python中的yield关键字

Yield

总的来说,yield关键字和return关键字有相似之处,但其工作机制却大相径庭。想要完整地理解yield的工作机制,我们首先需要明白什么是generator。而为了明白什么是generator,我们需要明白什么是iterable

本文接下来将首先给出一种理解含yield关键字的函数/代码的便捷方法。然后讨论iterablegenerator。接着在此基础上讨论yield的工作机制。

理解yield关键字的葵花宝典

在遇到一段含有yield的函数的代码时,使用如下方法我们就可以轻松的读懂这个函数。

  1. 在函数开头插入result = []
  2. 将所有的yield表达式替换成result.append(表达式)
  3. 在函数结尾插入return result
  4. 此时这段代码已经变为不含yield的普通代码, 重读一遍代码就可以轻松理解该函数了
  5. 和原代码对比一下,理解yield的意义是什么

通过这种方法我们可以理解函数的逻辑是什么,但是实际上yield的工作机制和用list替换实现的工作机制是非常不同的。在某些情况下,使用yield关键字从内存和运行时间角度看都更加高效。在另外一些情况下,即使原本的代码工作良好,使用本方法替换yield却可能会导致死循环的产生。

iterableiterator

for ele in mylist:
    loop body

在Python中,任何可以使用for ... in ...模式进行循环的对象都是iterable。例如list, string, file等。或者说,在Python中,实现了__iter()__方法的类实例都是iterable__iter()__方法需要返回一个iteratoriterator指的是实现了next()方法的对象。在一个类中同时实现__iter()__next()是合法的。这种情况下__iter()__只需要返回self即可。在简单的应用中这样做没有问题。但是如果我们想要同时使用两个或两个以上的iterator同时循环同一个对象,这种模式就无法满足要求了。

换句话说,iterable是任何你能通过调用iter()方法得到iterator的对象。而iterator是你用来循环iterable对象的对象。

for ele in mylist在Python中的工作模式如下:

  1. 得到一个mylistiterator:调用iter(mylist)-->该方法返回一个实现了next()方法(Python3中为__next()__)的对象(iterator)。
  2. 使用该iterator逐个循环mylist中的项目:不断调用iterator中的next()方法。next()方法的返回值被赋给ele,然后执行loop body中的语句。如果iterator中所有元素都已被循环,则next()方法抛出StopIteration异常,意味着循环结束。

事实上,Python在任何执行循环的时候都会执行以上两部——可能是在显式地for循环中,也可能是otherlist.extend(mylist)这样含有隐式循环的操作(其中otherlist是一个list)。

所以Python中的iterable有如下几种:

  1. Python中可使用for ... in ...循环的对象:list, dict, string, files
  2. 用户自定义的实现了iter()方法的类实例。
  3. Generator

需要注意的是,Python中的for循环并不关心它处理的是以上哪一种情况。只要其处理的是可以通过next()方法逐个调用元素的iteratorfor循环就可以正常工作。例如我们使用for循环逐个访问list中的元素,dict中的keyfile中的行,等等。

generator

generator的功能实际上同iterator完全相同,但其与iterator的区别在于generator中的元素只能被循环一次。这是因为generator不会在内存中存储全部的元素,而是动态地产生下一个将被循环的元素。

# 这是一个iterator
>>> mylist = [x * x for x in range(3)]
>>> for ele in mylist:
...     print(ele)
0
1
4

# 这是一个generator
>>> mylist = (x * x for x in range(3))
>>> for ele in mylist:
...     print(ele)
0
1
4

可以看出,只需要将[]换成()我们就得到了一个generator。与iterator不同的是,对于generator,我们只能调用一次for ele in mylist。因为generator将先计算0,然后删除这部分内容;再计算1,然后再删除这部分内容,等等。也就是说generator不会在内存中保存任何之前已经循环过的元素的值。

yield

yield关键字的用法类似于return,但是区别在于yield关键使得函数返回一个generator对象。看如下示例代码。

def createGenerator():
    yield 1
    yield 2
    yield 3

myGenerator = createGenerator()
print(myGenerator) #(1)

for ele in myGenerator:
    print(ele) #(2)

print(myGenerator.next())

上述代码的三个输出结果分别为:

<generator object createGenerator at 0x1010b1960> #(1)

1
2
3
#(2)

Traceback (most recent call last):
  File "<stdin>", line 12, in <module>
StopIteration
#(3)

从输出结果我们可以看出,yield关键字返回了一个generator,且generator只能被循环一次。

createGenerator()被调用的时候,事实上其不会返回yield语句中的任何值。该函数返回的其实是一个generator对象。并且函数事实上也并没有退出,而是处于一种暂停的状态。当我们使用for循环来遍历generator的时候,函数将会从暂停的状态恢复,并继续执行之前最后执行的yield语句后面的代码。在createGenerator()中也就是下一行yield语句,然后将yield中的值返回给for循环。这个过程会持续到函数执行至结尾退出之前(函数退出,或者说generator为空意味着函数持续运行但无法发现yield语句。这可能是由于函数已经执行至结尾,也可能是因为我们的函数中包含的if/else条件无法被继续满足)。此时generator会抛出StopIteration异常,for循环结束。需要注意的是,在for循环第一次调用generator时,函数将会从开头执行至第一个yield并返回该语句中的值。

相反,如果我们用return代替createGenerator()中的yield,则函数中只有第一行会被执行,函数返回1后就会结束。

从某种程度上来说,generator的作用类似于一个适配器。一方面其next()方法使得for循环能够逐个取得下一个值。另一方面,它将函数执行至恰好取得下一个值的部分,然后将函数重新置为暂停状态。

为什么使用generator?

通常情况下,我们可以写出不使用generator但是实现完全相同的逻辑的代码。方法之一就是使用前面替换yield关键字的list方法。但这种方法并不是永远都有效。比如当我们有无限长的循环的时候;并且如果list非常大的话,这种方法对内存的利用效率非常低。

另一种方法是实现另一个iterable类并利用这个类中的实例成员记录状态。利用这个类中实现的next()方法(Python3中的__next()__)来实现逐个循环的操作。根据逻辑设计的需要,next()中的代码块可能会非常复杂并且容易产生bug。这种情况下,使用generator也可以提供干净利落的解决方法。

控制generator元素的耗尽

>>> class Bank(): # let's create a bank, building ATMs
...    crisis = False
...    def create_atm(self):
...        while not self.crisis:
...            yield "$100"
>>> hsbc = Bank() # when everything's ok the ATM gives you as much as you want
>>> corner_street_atm = hsbc.create_atm()
>>> print(corner_street_atm.next())
$100
>>> print(corner_street_atm.next())
$100
>>> print([corner_street_atm.next() for cash in range(5)])
['$100', '$100', '$100', '$100', '$100']
>>> hsbc.crisis = True # crisis is coming, no more money!
>>> print(corner_street_atm.next())
<type 'exceptions.StopIteration'>
>>> wall_street_atm = hsbc.create_atm() # it's even true for new ATMs
>>> print(wall_street_atm.next())
<type 'exceptions.StopIteration'>
>>> hsbc.crisis = False # trouble is, even post-crisis the ATM remains empty
>>> print(corner_street_atm.next())
<type 'exceptions.StopIteration'>
>>> brand_new_atm = hsbc.create_atm() # build a new one to get back in business
>>> for cash in brand_new_atm:
...    print cash
$100
$100
$100
$100
$100
$100
$100
$100
$100
...

在某些需要控制对某个资源的获取的时候,这个方法可能会有用。

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

推荐阅读更多精彩内容