for迴圈在Python中是怎麼工作的

劉志軍發表於2019-02-18

for...in 是Python程式設計師使用最多的語句,for 迴圈用於迭代容器物件中的元素,這些物件可以是列表、元組、字典、集合、檔案,甚至可以是自定義類或者函式,例如:

作用於列表

>>> for elem in [1,2,3]:
...     print(elem)
...
1
2
3複製程式碼

作用於元組

>>> for i in ("zhang", "san", 30):
...     print(i)
...
zhang
san
30複製程式碼

作用於字串

>>> for c in "abc":
...     print(c)
...
a
b
c複製程式碼

作用於集合

>>> for i in {"a","b","c"}:
...     print(i)
...
b
a
c複製程式碼

作用於字典

>>> for k in {"age":10, "name":"wang"}:
...     print(k)
...
age
name複製程式碼

作用於檔案

>>> for line in open("requirement.txt"):
...     print(line, end="")
...
Fabric==1.12.0
Markdown==2.6.7複製程式碼

可能有人不經要問,為什麼這麼多不同型別物件都支援 for 語句,還有哪些型別的物件可以作用在 for 語句中呢?回答這個問題之前,我們先要了解 for 迴圈背後的執行原理。

for 迴圈是對容器進行迭代的過程,什麼是迭代?迭代就是從某個容器物件中逐個地讀取元素,直到容器中沒有更多元素為止。那麼,哪些物件支援迭代操作?任何物件都可以嗎?先隨便自定義一個類試試,看行不行:

>>> class MyRange:
...     def __init__(self, num):
...         self.num = num
...
>>> for i in MyRange(10):
...     print(i)
...
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: `MyRange` object is not iterable複製程式碼

錯誤堆疊日誌非常清楚地告訴我們,MyRange 不是一個可迭代物件,所以它不能用於迭代,那麼到底什麼樣的物件才稱得上是可迭代物件(iterable)呢?

可迭代物件需要實現__iter__方法,並返回一個迭代器,什麼是迭代器呢?迭代器只需要實現 __next__方法。現在我們就來驗證一下列表為什麼支援迭代:

>>> x = [1,2,3]
>>> its = x.__iter__() # x有此方法,說明列表是可迭代物件
>>> its
<list_iterator object at 0x100f32198>

>>> its.__next__()  # its有此方法,說明its是迭代器
1
>>> its.__next__()
2
>>> its.__next__()
3
>>> its.__next__()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration複製程式碼

從試驗結果來看,列表是一個可迭代物件,因為它實現了 __iter__方法,並且返回了一個迭代器物件(list_iterator),因為它實現了 __next__方法。我們看到它不斷地呼叫__next__方法,其實就是不斷地迭代獲取容器中的元素,直到容器中沒有更多元素丟擲 StopIteration 異常為止。

那麼 for 語句又是如何迴圈的呢?到這裡,恐怕你也猜到了,它的步驟是:

  1. 先判斷物件是否為可迭代物件,不是的話直接報錯,丟擲TypeError異常,是的話,呼叫 __iter__方法,返回一個迭代器
  2. 不斷地呼叫迭代器的__next__方法,每次按序返回迭代器中的一個值
  3. 迭代到最後,沒有更多元素了,就丟擲異常 StopIteration,這個異常 python 自己會處理,不會暴露給開發者

對於元組,字典,字串也是同樣的道理,弄明白了 for 的執行原理之後,我們就可以實現自己的迭代器用在 for 迴圈中。

前面的 MyRange 報錯是因為它沒有實現迭代器協議裡面的這兩個方法,現在繼續改進:

class MyRange:
    def __init__(self, num):
        self.i = 0
        self.num = num

    def __iter__(self):
        return self

    def __next__(self):
        if self.i < self.num:
            i = self.i
            self.i += 1
            return i
        else:
            # 達到某個條件時必須丟擲此異常,否則會無止境地迭代下去
            raise StopIteration()複製程式碼

因為它實現了__next__方法,所以 MyRange 本身已經是一個迭代器了,所以 __iter__返回的就是物件本身 self。現在用在 for 迴圈中試試:

for i in MyRange(3):
    print(i)
# 輸出
 0
 1
 2複製程式碼

有沒有發現,自定義的 MyRange 功能和內建函式 range很相似。for 迴圈本質是不斷地呼叫迭代器的__next__方法,直到有 StopIteration 異常為止,所以任何可迭代物件都可以作用在for迴圈中。

同步發表於:foofish.net/how-for-wor…

公眾號:python之禪
公眾號:python之禪

相關文章