Introduction to Python iterators and their role

迭代器：初探

Python 學習的人都知道,Python 中存在兩種循環語句：while 和 for.for 循環可以用於 Python 中的任何序列,包括列表、元組、字符串.

>>> for x in [2013, 14, 15926]: print(x, end=' ')...2013 14 15926>>>>>> for x in (2021, 2022, 2023): print(x, end='->')...2021->2022->2023->>>> for x in 'HelloWorld': print(x, end=' ')...H e l l o W o r l d

實際上,for 循環還能使用於​任何可迭代對象​.可迭代對象在 Python 中是新穎特別的概念,但實際上就是序列概念的通用化：如果對象時實際保存的序列,或者可以在迭代工具中（如 for 循環）一次產生一個結果的對象,就看做可迭代的.可以說,Python 中迭代器無處不在.

什麼是迭代器？

Python 中的迭代器是一個對象,用於迭代列表、元組、字典和集合等可迭代對象.Python 迭代器對象必須實現兩個特殊的方法：​​__iter__()​​​和​​__next__()​​ 方法：

• 使用 ​​__iter__() ​​方法初始化迭代器對象

• 使用 ​​__next__() ​​ 方法進行迭代.

通過迭代器進行迭代

​​iter()​​​ 函數依次調用 ​​__iter__()​​ 方法,返回一個迭代器.我們使用 ​​next() ​​​ 函數手動遍歷迭代器的所有項.

當我們到達終點並且沒有更多數據要返回時,它將引發 ​​StopIteration​​ 異常.下面是一個例子:

# define a listmy_list = [2013, 14, 15926]# get an iterator using iter()my_iter = iter(my_list)# iterate through it using next()# Output: 2013print(next(my_iter))# Output: 14print(next(my_iter))# next(obj) is same as obj.__next__()# Output: 15926print(my_iter.__next__())# This will raise error, no items leftnext(my_iter)

依次執行上面的代碼,輸出如下：

20131415926Traceback (most recent call last): File "<string>", line 24, in <module> next(my_iter)StopIteration

一種更優雅的自動迭代方式是使用 for 循環.使用它,我們可以迭代任何可以返回迭代器的對象,例如列表、字符串、文件等.

>>> for element in my_list:... print(element)... 20131415926

迭代器 for 循環的工作

正如我們在上面的示例中看到的,for 循環能夠自動遍歷列表.

實際上 for 循環可以迭代任何可迭代對象.讓我們仔細看看 for 循環是如何在 Python 中實際實現的.

for element in iterable: # do something with element

實際實現為:

# create an iterator object from that iterableiter_obj = iter(iterable)# infinite loopwhile True: try: # get the next item element = next(iter_obj) print(element) # do something with element except StopIteration: # if StopIteration is raised, break from loop break

所以在內部,for 循環通過在可迭代對象上調用 ​​iter()​​​ 創建一個迭代器對象 ​​iter_obj​​.具有諷刺意味的是,這個 for 循環實際上是一個無限的 while 循環.

在循環內部,它調用 ​​next()​​​ 來獲取下一個元素並使用該值執行 for 循環的主體.在所有項目耗盡後,​​StopIteration​​ 被引發,內部捕獲並結束循環.請注意,任何其他類型的異常都會通過.

構建自定義迭代器

在 Python 中從頭開始構建迭代器很容易.我們只需要實現 ​​__iter__() ​​​和 ​​__next__() ​​方法.

​​__iter__() ​​方法返回迭代器對象本身.如果需要,可以執行一些初始化.

​​__next__() ​​​方法必須返回序列中的下一項.在到達終點時以及在隨後的調用中,它必須引發 ​​StopIteration​​.

class PowTwo: """Class to implement an iterator of powers of two""" def __init__(self, max=0): self.max = max def __iter__(self): self.n = 0 return self def __next__(self): if self.n <= self.max: result = 2 ** self.n self.n += 1 return result else: raise StopIteration# create an objectnumbers = PowTwo(3)# create an iterable from the objecti = iter(numbers)# Using next to get to the next iterator elementprint(next(i))print(next(i))print(next(i))print(next(i))print(next(i))

輸出結果：

1248Traceback (most recent call last): File "/Users/yuzhou_1su/go/src/iterdemo.py", line 32, in <module> print(next(i))StopIteration

我們還可以使用 for 循環來迭代我們的迭代器類.

>>> for i in PowTwo(5):... print(i)... 12481632

Python 無限迭代器

迭代器對象中的項目不必耗盡.可以有無限的迭代器（永遠不會結束）.在處理此類迭代器時,我們必須小心.

這是一個演示無限迭代器的簡單示例.

內置函數 ​​iter()​​ 可以使用兩個參數調用,其中第一個參數必須是可調用對象（函數）,第二個參數是哨兵.迭代器調用這個函數,直到返回的值等於哨兵.

>>> int()0>>> inf = iter(int,1)>>> next(inf)0>>> next(inf)0

我們可以看到 ​​int()​​​ 函數總是返回 0.因此將它作為 ​​iter(int,1)​​​ 傳遞將返回一個迭代器,該迭代器調用 ​​int()​​ 直到返回值等於 1.這永遠不會發生,我們得到一個無限迭代器.

我們還可以構建自己的無限迭代器.理論上,以下迭代器將返回所有奇數:

class InfIter: """Infinite iterator to return all odd numbers""" def __iter__(self): self.num = 1 return self def __next__(self): num = self.num self.num += 2 return num

>>> a = iter(InfIter())>>> next(a)1>>> next(a)3>>> next(a)5>>> next(a)7

在對這些類型的無限迭代器進行迭代時,請小心包含終止條件.如上所示,我們可以得到所有奇數,而無需將整個數字系統存儲在內存中.理論上,我們可以在有限的內存中擁有無限的項目.

Python 迭代器的好處

使用迭代器的好處是可以節省資源.

• 代碼減少.

• 代碼冗余得到極大解決.

• 降低代碼復雜度.

• 它為編碼帶來了更多的穩定性.

總結

Python 的迭代器提供穩定和靈活的代碼.迭代器和可迭代對象的區別：

• ​Iterable​ 是一個可以迭代的對象.它在傳遞給 ​​iter()​​ 方法時生成一個迭代器.

• ​Iterator​ 是一個對象,用於使用 ​​__next__()​​​ 方法對可迭代對象進行迭代.迭代器有 ​​__next__() ​​方法,它返回對象的下一項.

請注意,每個迭代器也是一個可迭代的,但不是每個可迭代的都是一個迭代器.

例如,列表是可迭代的,但列表不是迭代器.可以使用函數 ​​iter() ​​從可迭代對象創建迭代器.

為了實現這一點,對象的類需要一個方法 ​​__iter__​​​,它返回一個迭代器,或者一個具有從 0 開始的順序索引的 ​​__getitem__​​​ 方法.但其本質也是實現了 ​​__iter__​​ 方法.

參考資料：

• ​​https://www.geeksforgeeks.org/iterators-in-python/​​

• ​​Python Iterators​​