跳到主要內容

[Python] 關鍵字yield和return究竟有什麼不同?

學習Scrapy的過程中碰到 yeild 這個關鍵字,我使用Python快半年了,還真的是第一次遇到這個關鍵字,於是我花了點時間研究後,終於明白它的作用了,怕下次看到時忘記,所以用這篇文將yield這個關鍵字重點整理一下。

1. yield的核心目的:為了節省記憶體

如果想要印出0~100的平方時,我們可能會這樣寫。

  1. powers = [x**2 for x in range(100)]
  2. for x in powers:
  3. print(x)

但這樣有一個致命問題在於,必須把整個list都存放在記憶體中,100個元素可能還不成問題,但如果今天的對象是一百萬筆資料,記憶體可能會承受不了,程式就崩潰了。

接下來就會說明yield要如何節省記憶體,但在此之前,先來談談Python的生成器(generator)。

2. 什麼是生成器(generator)?

生成器是一個可迭代的物件,可以放在for迴圈的in前面,或者使用next()函數呼叫執行下一次迭代。

和列表的差別在於,生成器會保存上次紀錄,並只有在呼叫下一層迭代的時候才載入記憶體執行

所以將上面的例子改寫成生成器,結果是一樣的,卻可以防止超過記憶體,注意我用的是 ( 而不是 [

  1. powers = (x**2 for x in range(100))
  2. for x in powers:
  3. print(x)

3. 函數加入yield後不再是一般的函數,而被視作為生成器(generator)

呼叫函數後,回傳的並非數值,而是函數的生成器物件。

4. yield和return一樣會回傳值,不過yield會記住上次執行的位置

yield和return一樣都會回傳值並中斷在目前位置,但最大不同在於yield在下次迭代時會從上次迭代的下一行接續執行,一直執行到下一個yield出現,如果沒有下一個yield則結束這個生成器。而且接續上一個迭代前的變數不會改變,就是維持上次結束前的模樣。

這部分我們來看下面這個例子:

  1. def yield_test(n):
  2. print("start n =", n)
  3. for i in range(n):
  4. yield i*i
  5. print("i =", i)
  6. print("end")
  7. tests = yield_test(5)
  8. for test in tests:
  9. print("test =", test)
  10. print("--------")

執行結果:

  1. start n = 5
  2. test = 0
  3. --------
  4. i = 0
  5. test = 1
  6. --------
  7. i = 1
  8. test = 4
  9. --------
  10. i = 2
  11. test = 9
  12. --------
  13. i = 3
  14. test = 16
  15. --------
  16. i = 4
  17. end
  1. 從第10、11行看到呼叫yield_test()後回傳的不是一個數值,而是一個可迭代的生成器。
  2. 在第一次迭代時,印出了 "start n = 5",因為不在迴圈中,所以僅僅印出這一次。
  3. 進入迴圈中,第一次時 i=0,接著遇到yield並回傳 0*0 = 0,並回到主程序。
  4. 主程序的test接收到回傳的0,於是印出 "test = 0" 並印出 "--------",結束這次迭代。
  5. 接著進行第二次迭代,會從上次結束的下一行開始,因此印出 "i = 0"。
  6. 完成後又回到迴圈開始,這時 i=1,接著再次遇到yield並回傳 1*1 = 1,並回到主程序。
  7. 主程序的test接收到回傳的1,於是印出 "test = 1" 並印出 "--------",結束這次迭代。
  8. 其他次迭代依此類推,直到i=5跳出迴圈,印出 "end" 之後已經沒有yield了,生成器會返回一個error StopIteration (這邊沒有印出來),告訴主程序迭代已經結束了。
  9. 結束主程序。

看完上面例子後,應該會從原本朦朦朧朧到有點概念了吧,其實yield有點像偵錯模式的中斷點,只是多了中斷時回傳值而已。

5. next()呼叫下一次迭代,send(n)呼叫下一次迭代並傳遞參數

  1. def test():
  2. print("start...")
  3. while True:
  4. throw = yield 10
  5. print("throw:", throw)
  6. p = test()
  7. print(next(p))
  8. print("-----------")
  9. print(next(p))
  10. print("-----------")
  11. print(g.send(7))
  12. print("-----------")

執行結果:

  1. start...
  2. 10
  3. -----------
  4. throw: None
  5. 10
  6. -----------
  7. throw: 7
  8. 10
  9. -----------
  1. 建立一個可迭代生成器p。
  2. next()執行第一次迭代,印出 "start..." 並回傳 10,但注意throw在賦予值之前就被中斷了。
  3. next()執行第二次迭代,因為throw並沒有被沒有被賦予值,所以印出 "throw: None",接著回傳 10。
  4. send()傳入7,等同於在上次結束的位置填入7,因此 throw=7,印出 "throw: 7"。

順帶一提,第一次迭代不可以send任何數值進去,因為沒有上一個位置可以接收。

6. Python range小知識

在Python 2.X中,有分range和xrange兩種,range就像第一個例子,生成一個[0, 1, 2, ...]的list。xrange則像第二種例子,使用生成器減少記憶體消耗。

但在Python 3.X後range就等於xrange,使用type()檢查會知道已經是range型態了。

  1. print(type(range(10))) # <class 'range'>

如果開始學就是Python3.X,就不必在意這些細節,繼續放心地用range吧!

參考資料

Python 裡的 yield - 讓你簡單、快速瞭解 yield 的概念

python中yield的用法详解--最简单,最清晰的解释_mieleizhi0522的博客-CSDN博客_python yield

彻底理解Python中的yield

Python 的可迭代物件、迭代器和產生器


如果喜歡這篇文章,請訂閱我並且拍五下手給予回饋(使用Google或Facebook帳號免費登入,只需要30秒),資金由LikeCoin提供,完全不會花到各位半毛錢!

因為您的支持,我才更有動力創作出更優質的文章~

留言

這個網誌中的熱門文章

[Python] 關於 with 你所不知道的事

相信用 C 語言寫過檔案讀取的人都知道,經常開檔後就忘記關檔,或者程式中間跳出例外,因此沒有關檔。這些問題常常讓人非常頭痛😱。 所幸 Python 中有 with 這個語法糖,可以自動幫你開關檔,跳出例外也難不倒他,真的非常好用。 但你真的了解 with 背後的運行原理嗎? 🤔 不知道沒關係,因為你現在就會知道了! context manager 在講 with 之前,必須先介紹一下 context manager ,中文可以翻成 情境管理器 。 為什麼叫做 情境管理器 呢? 我們試想一個情境… 當你進入房間時,就要開啟房間的燈:然後當你離開房間時,就要關閉房間的燈。 像這樣理所當然一定要做的事情,我們就稱為一個情境。而 Python 就是透過情境管理器處理這些情境。 要自己實作 context manager 其實很簡單,只要在 Class 中實作 __enter__() 和 __exit__() 即可。 就以進入房間當作例子。 class Room (): def turn_on_light ( self ): print ( "開燈" ) def turn_off_light ( self ): print ( "關燈" ) def __enter__ ( self ): print ( "進入房間" ) self.turn_on_light() return "在房間裡" def __exit__ ( self, exc_type, exc_value, traceback ): self.turn_off_light() print ( "離開房間" ) with Room() as room: ...

[2021 IT鐵人賽] Day 23:專案05 - KKBOX風雲榜02 | AJAX

昨天已經找到的KKBOX用來傳資料的API,也知道各個參數的意義了,今天就實際將資料抓下來吧! 歌曲資訊 回到昨天那個API,是用JSON格式傳遞資料,資料的格式大致如下: 我們可以發現新歌的資料都放在 “newrelease” 之下,一個element就是一首歌的資訊,另外,每首歌的資訊也以key:value的形式整理的很清楚。 接著,就用之前教過的 requests.get(url) 直接取得API回傳的資料,但回傳的型態是json字串,所以再用Python本身內建的 json.loads() 函數轉成Python的list和dict資料型態。 # KKBOX華語新歌日榜 url = "https://kma.kkbox.com/charts/api/v1/daily?category=297&lang=tc&limit=50&terr=tw&type=newrelease" # 取得歌曲資訊json檔 response = requests.get(url) # 將json字串轉為Python的字典型態 data = json.loads(response.text) 既然已經轉成list和dict的型態了,再根據剛才觀察API得知的架構,要篩選資料就非常簡單,直接來看程式碼: song_list = data[ "data" ][ "charts" ][ "newrelease" ] # 取得每首歌的排名、曲名、連結、作者、時間 for song in song_list: song_rank = song[ "rankings" ][ "this_period" ] song_name = song[ "song_name" ] song_url = song[ "song_url" ] song_artist = song[ "artist_name"...

[Python] yield from用法

之前我寫過一篇文章專門在講yield,對yield不了解的朋友建議先看這篇 [Python] 關鍵字yield和return究竟有什麼不同? 。 yield from 是Python3.3後新增的語法,用法是將生成器的工作委任給另外一個生成器,簡單來說,就是借用 其他生成器返回的物件 當成 自己返回的物件 。 另外在之前, yield 和 return 是不能同時出現在同一個函數中的,但在Python3.3之後有了新的用法,「 yield from 表達式 」會為被解析為「 生成器函數中 return 回傳的回傳值 」。 舉下面例子: def example1(): for i in range(3): yield i return "end" def example2(): print("start") x = yield from example1() print("example2: x =", x) for i in example2(): print("i =", i) 結果: start i = 0 i = 1 i = 2 example2: x = end example1最後回傳"end",被x接收到,所以印出x會是"end"。 希望這篇文章有幫助到你~ 參考資料 Python3: 淺談 Python 3.3 的 Yield From 表達式