yield的實現(xiàn)

yield的功能類似于return斟赚,但是不同之處在于它返回的是生成器。

生成器


生成器是通過一個或多個yield表達式構(gòu)成的函數(shù)织堂,每一個生成器都是一個迭代器(但是迭代器不一定是生成器)颓遏。
如果一個函數(shù)包含yield關(guān)鍵字狸剃,這個函數(shù)就會變成一個生成器付枫。
生成器并不會一次返回所有的結(jié)果烹玉,而是每次遇到y(tǒng)ield關(guān)鍵字后返回相應的結(jié)果,并保留函數(shù)當前的運行狀態(tài)阐滩,等待下一次的調(diào)用春霍。
由于生成器也是一個迭代器,那么他就應該支持next方法來獲取下一個值叶眉。

基本操作

# 通過`yield`來創(chuàng)建生成器
def func():
   for i in xrange(10);
        yield i

# 通過列表來創(chuàng)建生成器
[i for i in xrange(10)]
# 調(diào)用如下
>>> f = func()
>>> f # 此時生成器還沒有運行
<generator object func at 0x7fe01a853820>
>>> f.next() # 當i=0時址儒,遇到y(tǒng)ield關(guān)鍵字,直接返回
0
>>> f.next() # 繼續(xù)上一次執(zhí)行的位置衅疙,進入下一層循環(huán)
1
...
>>> f.next()
9
>>> f.next() # 當執(zhí)行完最后一次循環(huán)后莲趣,結(jié)束yield語句,生成StopIteration異常
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration
>>> 

除了next函數(shù)饱溢,生成器還支持send函數(shù)喧伞。該函數(shù)可以向生成器傳遞參數(shù)。

>>> def func():
...     n = 0
...     while 1:
...         n = yield n #可以通過send函數(shù)向n賦值
... 
>>> f = func()
>>> f.next() # 默認情況下n為0
0
>>> f.send(1) #n賦值1
1
>>> f.send(2)
2
>>> 

應用

最經(jīng)典的例子绩郎,生成無限序列潘鲫。

常規(guī)的解決方法是,生成一個滿足要求的很大的列表肋杖,這個列表需要保存在內(nèi)存中溉仑,很明顯內(nèi)存限制了這個問題。

def get_primes(start):
    for element in magical_infinite_range(start):
        if is_prime(element):
            return element

如果使用生成器就不需要返回整個列表状植,每次都只是返回一個數(shù)據(jù)浊竟,避免了內(nèi)存的限制問題。

def get_primes(number):
    while True:
        if is_prime(number):
            yield number
        number += 1

生成器源碼分析

生成器的源碼在Objects/genobject.c津畸。

調(diào)用棧

在解釋生成器之前振定,需要講解一下Python虛擬機的調(diào)用原理。

Python虛擬機有一個棧幀的調(diào)用棧肉拓,其中棧幀的是PyFrameObject后频,位于Include/frameobject.h。

typedef struct _frame {
    PyObject_VAR_HEAD
    struct _frame *f_back;  /* previous frame, or NULL */
    PyCodeObject *f_code;   /* code segment */
    PyObject *f_builtins;   /* builtin symbol table (PyDictObject) */
    PyObject *f_globals;    /* global symbol table (PyDictObject) */
    PyObject *f_locals;     /* local symbol table (any mapping) */
    PyObject **f_valuestack;    /* points after the last local */
    /* Next free slot in f_valuestack.  Frame creation sets to f_valuestack.
       Frame evaluation usually NULLs it, but a frame that yields sets it
       to the current stack top. */
    PyObject **f_stacktop;
    PyObject *f_trace;      /* Trace function */

    /* If an exception is raised in this frame, the next three are used to
     * record the exception info (if any) originally in the thread state.  See
     * comments before set_exc_info() -- it's not obvious.
     * Invariant:  if _type is NULL, then so are _value and _traceback.
     * Desired invariant:  all three are NULL, or all three are non-NULL.  That
     * one isn't currently true, but "should be".
     */
    PyObject *f_exc_type, *f_exc_value, *f_exc_traceback;

    PyThreadState *f_tstate;
    int f_lasti;        /* Last instruction if called */
    /* Call PyFrame_GetLineNumber() instead of reading this field
       directly.  As of 2.3 f_lineno is only valid when tracing is
       active (i.e. when f_trace is set).  At other times we use
       PyCode_Addr2Line to calculate the line from the current
       bytecode index. */
    int f_lineno;       /* Current line number */
    int f_iblock;       /* index in f_blockstack */
    PyTryBlock f_blockstack[CO_MAXBLOCKS]; /* for try and loop blocks */
    PyObject *f_localsplus[1];  /* locals+stack, dynamically sized */
} PyFrameObject;

棧幀保存了給出代碼的的信息和上下文暖途,其中包含最后執(zhí)行的指令卑惜,全局和局部命名空間,異常狀態(tài)等信息丧肴。f_valueblock保存了數(shù)據(jù)残揉,b_blockstack保存了異常和循環(huán)控制方法。

舉一個例子來說明芋浮,

def foo():
    x = 1
    def bar(y):
        z = y + 2  # <--- (3) ... and the interpreter is here.
        return z
    return bar(x)  # <--- (2) ... which is returning a call to bar ...
foo()              # <--- (1) We're in the middle of a call to foo ...

那么抱环,相應的調(diào)用棧如下壳快,一個py文件,一個類镇草,一個函數(shù)都是一個代碼塊眶痰,對應者一個Frame,保存著上下文環(huán)境以及字節(jié)碼指令梯啤。

c   ---------------------------
a  | bar Frame                 | -> block stack: []
l  |     (newest)              | -> data stack: [1, 2]
l   ---------------------------
   | foo Frame                 | -> block stack: []
s  |                           | -> data stack: [<Function foo.<locals>.bar at 0x10d389680>, 1]
t   ---------------------------
a  | main (module) Frame       | -> block stack: []
c  |       (oldest)            | -> data stack: [<Function foo at 0x10d3540e0>]
k   ---------------------------

每一個棧幀都擁有自己的數(shù)據(jù)棧和block棧竖伯,獨立的數(shù)據(jù)棧和block棧使得解釋器可以中斷和恢復棧幀(生成器正式利用這點)。

Python代碼首先被編譯為字節(jié)碼因宇,再由Python虛擬機來執(zhí)行七婴。一般來說,一條Python語句對應著多條字節(jié)碼(由于每條字節(jié)碼對應著一條C語句察滑,而不是一個機器指令打厘,所以不能按照字節(jié)碼的數(shù)量來判斷代碼性能)。

調(diào)用dis模塊可以分析字節(jié)碼贺辰,

from dis import dis

dis(foo)

  5           0 LOAD_CONST               1 (1) # 加載常量1
              3 STORE_FAST               0 (x) # x賦值為1

  6           6 LOAD_CONST               2 (<code object bar at 0x7f3cdee3a030, file "t1.py", line 6>) # 加載常量2
              9 MAKE_FUNCTION            0 # 創(chuàng)建函數(shù)
             12 STORE_FAST               1 (bar) 

  9          15 LOAD_FAST                1 (bar) 
             18 LOAD_FAST                0 (x)
             21 CALL_FUNCTION            1  # 調(diào)用函數(shù)
             24 RETURN_VALUE      

其中户盯,

第一行為代碼行號;
第二行為偏移地址饲化;
第三行為字節(jié)碼指令莽鸭;
第四行為指令參數(shù);
第五行為參數(shù)解釋吃靠。

生成器源碼分析

由了上面對于調(diào)用棧的理解硫眨,就可以很容易的明白生成器的具體實現(xiàn)。

生成器的源碼位于object/genobject.c撩笆。

生成器的創(chuàng)建
PyObject *
PyGen_New(PyFrameObject *f)
{
    PyGenObject *gen = PyObject_GC_New(PyGenObject, &PyGen_Type); # 創(chuàng)建生成器對象
    if (gen == NULL) {
        Py_DECREF(f);
        return NULL;
    }
    gen->gi_frame = f; # 賦予代碼塊
    Py_INCREF(f->f_code); # 引用計數(shù)+1
    gen->gi_code = (PyObject *)(f->f_code);
    gen->gi_running = 0; # 0表示為執(zhí)行捺球,也就是生成器的初始狀態(tài)
    gen->gi_weakreflist = NULL;
    _PyObject_GC_TRACK(gen); # GC跟蹤
    return (PyObject *)gen;
}
send與next

next與send函數(shù),如下

static PyObject *
gen_iternext(PyGenObject *gen)
{
    return gen_send_ex(gen, NULL, 0);
}


static PyObject *
gen_send(PyGenObject *gen, PyObject *arg)
{
    return gen_send_ex(gen, arg, 0);
}

從上面的代碼中可以看到夕冲,send和next都是調(diào)用的同一函數(shù)gen_send_ex,區(qū)別在于是否帶有參數(shù)裂逐。

static PyObject *
gen_send_ex(PyGenObject *gen, PyObject *arg, int exc)
{
    PyThreadState *tstate = PyThreadState_GET();
    PyFrameObject *f = gen->gi_frame;
    PyObject *result;

    if (gen->gi_running) { # 判斷生成器是否已經(jīng)運行
        PyErr_SetString(PyExc_ValueError,
                        "generator already executing");
        return NULL;
    }
    if (f==NULL || f->f_stacktop == NULL) { # 如果代碼塊為空或調(diào)用棧為空歹鱼,則拋出StopIteration異常
        /* Only set exception if called from send() */
        if (arg && !exc)
            PyErr_SetNone(PyExc_StopIteration);
        return NULL;
    }

    if (f->f_lasti == -1) { # f_lasti=1 代表首次執(zhí)行
        if (arg && arg != Py_None) { # 首次執(zhí)行不允許帶有參數(shù)
            PyErr_SetString(PyExc_TypeError,
                            "can't send non-None value to a "
                            "just-started generator");
            return NULL;
        }
    } else {
        /* Push arg onto the frame's value stack */
        result = arg ? arg : Py_None;
        Py_INCREF(result); # 該參數(shù)引用計數(shù)+1
        *(f->f_stacktop++) = result; # 參數(shù)壓棧
    }

    /* Generators always return to their most recent caller, not
     * necessarily their creator. */
    f->f_tstate = tstate;
    Py_XINCREF(tstate->frame);
    assert(f->f_back == NULL);
    f->f_back = tstate->frame;

    gen->gi_running = 1; # 修改生成器執(zhí)行狀態(tài)
    result = PyEval_EvalFrameEx(f, exc); # 執(zhí)行字節(jié)碼
    gen->gi_running = 0; # 恢復為未執(zhí)行狀態(tài)

    /* Don't keep the reference to f_back any longer than necessary.  It
     * may keep a chain of frames alive or it could create a reference
     * cycle. */
    assert(f->f_back == tstate->frame);
    Py_CLEAR(f->f_back);
    /* Clear the borrowed reference to the thread state */
    f->f_tstate = NULL;

    /* If the generator just returned (as opposed to yielding), signal
     * that the generator is exhausted. */
    if (result == Py_None && f->f_stacktop == NULL) {
        Py_DECREF(result);
        result = NULL;
        /* Set exception if not called by gen_iternext() */
        if (arg)
            PyErr_SetNone(PyExc_StopIteration);
    }

    if (!result || f->f_stacktop == NULL) {
        /* generator can't be rerun, so release the frame */
        Py_DECREF(f);
        gen->gi_frame = NULL;
    }

    return result;
}
字節(jié)碼的執(zhí)行

PyEval_EvalFrameEx函數(shù)的功能為執(zhí)行字節(jié)碼并返回結(jié)果。

# 主要流程如下卜高,
for (;;) {
   switch(opcode) { # opcode為操作碼弥姻,對應著各種操作
        case NOP:
            goto  fast_next_opcode;
        ...
        ...
        case YIELD_VALUE: # 如果操作碼是yield
            retval = POP(); 
            f->f_stacktop = stack_pointer;
            why = WHY_YIELD;
            goto fast_yield; # 利用goto跳出循環(huán)
    }
}

fast_yield:
    ... 
return vetval; # 返回結(jié)果

舉一個例子,f_back上一個Frame掺涛,f_lasti上一次執(zhí)行的指令的偏移量庭敦,

import sys
from dis import dis


def func():
    f = sys._getframe(0)
    print f.f_lasti
    print f.f_back
    yield 1

    print f.f_lasti
    print f.f_back
    yield 2


a = func()
dis(func)
a.next()
a.next()

結(jié)果如下,其中第三行的英文為操作碼薪缆,對應著上面的opcode秧廉,每次switch都是在不同的opcode之間進行選擇。

  6           0 LOAD_GLOBAL              0 (sys)
              3 LOAD_ATTR                1 (_getframe)
              6 LOAD_CONST               1 (0)
              9 CALL_FUNCTION            1
             12 STORE_FAST               0 (f)

  7          15 LOAD_FAST                0 (f)
             18 LOAD_ATTR                2 (f_lasti) 
             21 PRINT_ITEM          
             22 PRINT_NEWLINE       

  8          23 LOAD_FAST                0 (f)
             26 LOAD_ATTR                3 (f_back)
             29 PRINT_ITEM          
             30 PRINT_NEWLINE       

  9          31 LOAD_CONST               2 (1)
             34 YIELD_VALUE     # 此時操作碼為YIELD_VALUE,直接跳轉(zhuǎn)上述goto語句疼电,此時f_lasti為當前指令嚼锄,f_back為當前frame
             35 POP_TOP             

 11          36 LOAD_FAST                0 (f)
             39 LOAD_ATTR                2 (f_lasti)
             42 PRINT_ITEM          
             43 PRINT_NEWLINE       

 12          44 LOAD_FAST                0 (f)
             47 LOAD_ATTR                3 (f_back)
             50 PRINT_ITEM          
             51 PRINT_NEWLINE       

 13          52 LOAD_CONST               3 (2)
             55 YIELD_VALUE         
             56 POP_TOP             
             57 LOAD_CONST               0 (None)
             60 RETURN_VALUE        
18
<frame object at 0x7fa75fcebc20> #和下面的frame相同,屬于同一個frame蔽豺,也就是說在同一個函數(shù)(命名空間)內(nèi)区丑,frame是同一個。
39
<frame object at 0x7fa75fcebc20>

轉(zhuǎn)載自:cococo點點 http://www.cnblogs.com/coder2012

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末修陡,一起剝皮案震驚了整個濱河市沧侥,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌魄鸦,老刑警劉巖宴杀,帶你破解...
    沈念sama閱讀 206,602評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異号杏,居然都是意外死亡婴氮,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,442評論 2 382
  • 文/潘曉璐 我一進店門盾致,熙熙樓的掌柜王于貴愁眉苦臉地迎上來主经,“玉大人,你說我怎么就攤上這事庭惜≌肿ぃ” “怎么了?”我有些...
    開封第一講書人閱讀 152,878評論 0 344
  • 文/不壞的土叔 我叫張陵护赊,是天一觀的道長惠遏。 經(jīng)常有香客問我,道長骏啰,這世上最難降的妖魔是什么节吮? 我笑而不...
    開封第一講書人閱讀 55,306評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮判耕,結(jié)果婚禮上透绩,老公的妹妹穿的比我還像新娘。我一直安慰自己壁熄,他們只是感情好帚豪,可當我...
    茶點故事閱讀 64,330評論 5 373
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著草丧,像睡著了一般狸臣。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上昌执,一...
    開封第一講書人閱讀 49,071評論 1 285
  • 那天烛亦,我揣著相機與錄音诈泼,去河邊找鬼。 笑死此洲,一個胖子當著我的面吹牛厂汗,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播呜师,決...
    沈念sama閱讀 38,382評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼娶桦,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了汁汗?” 一聲冷哼從身側(cè)響起衷畦,我...
    開封第一講書人閱讀 37,006評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎知牌,沒想到半個月后祈争,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,512評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡角寸,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,965評論 2 325
  • 正文 我和宋清朗相戀三年菩混,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片扁藕。...
    茶點故事閱讀 38,094評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡沮峡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出亿柑,到底是詐尸還是另有隱情邢疙,我是刑警寧澤,帶...
    沈念sama閱讀 33,732評論 4 323
  • 正文 年R本政府宣布望薄,位于F島的核電站疟游,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏痕支。R本人自食惡果不足惜颁虐,卻給世界環(huán)境...
    茶點故事閱讀 39,283評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望卧须。 院中可真熱鬧聪廉,春花似錦、人聲如沸故慈。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,286評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽察绷。三九已至,卻和暖如春津辩,著一層夾襖步出監(jiān)牢的瞬間拆撼,已是汗流浹背容劳。 一陣腳步聲響...
    開封第一講書人閱讀 31,512評論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留闸度,地道東北人竭贩。 一個月前我還...
    沈念sama閱讀 45,536評論 2 354
  • 正文 我出身青樓,卻偏偏與公主長得像莺禁,于是被迫代替她去往敵國和親留量。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 42,828評論 2 345

推薦閱讀更多精彩內(nèi)容