Python - 迭代器

Python 迭代器

Python 中的迭代器是一個物件，它允許遍歷一個集合（例如列表或元組），一次一個元素。它遵循迭代器協議，透過使用兩個方法__iter__() 和 __next__() 的實現。

__iter__() 方法返回迭代器物件本身，而 __next__() 方法返回序列中的下一個元素，當沒有更多元素可用時，會引發 StopIteration 異常。

迭代器提供了一種記憶體高效的方式來迭代資料，對於大型資料集尤其有用。它們可以使用 iter() 函式從可迭代物件建立，或者使用自定義類和生成器實現。

可迭代物件 vs 迭代器

在深入瞭解迭代器的工作原理之前，我們應該瞭解可迭代物件和迭代器之間的區別。

可迭代物件：能夠一次返回其成員的一個物件（例如，列表、元組）。
迭代器：表示資料流的物件，一次返回一個元素。

我們通常使用 for 迴圈來迭代可迭代物件，如下所示：

for element in sequence:
   print (element)

Python 的內建方法 iter() 實現 __iter__() 方法。它接收一個可迭代物件並返回迭代器物件。

Python 迭代器示例

以下程式碼從序列型別（如列表、字串和元組）獲取迭代器物件。iter() 函式還從字典返回鍵迭代器。

print (iter("aa"))
print (iter([1,2,3]))
print (iter((1,2,3)))
print (iter({}))

它將產生以下輸出：

<str_iterator object at 0x7fd0416b42e0>
<list_iterator object at 0x7fd0416b42e0>
<tuple_iterator object at 0x7fd0416b42e0>
<dict_keyiterator object at 0x7fd041707560>

然而，整數不可迭代，因此它會產生 TypeError。

iterator = iter(100)
print (iterator)

它將產生以下輸出：

Traceback (most recent call last):
   File "C:\Users\user\example.py", line 5, in <module>
      print (iter(100))
            ^^^^^^^^^
TypeError: 'int' object is not iterable

迭代器中的錯誤處理

迭代器物件有一個名為 __next__() 的方法。每次呼叫它時，它都會返回迭代器流中的下一個元素。呼叫 next() 函式等效於呼叫迭代器物件的 __next__() 方法。

此方法在沒有更多專案要返回時引發StopIteration異常。

示例

下面是一個示例，我們建立的迭代器物件只有 3 個元素，並且我們對其迭代次數超過 3 次。

it = iter([1,2,3])
print (next(it))
print (it.__next__())
print (it.__next__())
print (next(it))

它將產生以下輸出：

1
2
3
Traceback (most recent call last):
   File "C:\Users\user\example.py", line 5, in <module>
      print (next(it))
            ^^^^^^^^
StopIteration

可以使用 try 和 except 程式碼塊捕獲使用迭代器的程式碼中的此異常，儘管更常見的是透過使用 for 迴圈等內部管理 StopIteration 異常的結構隱式處理它。

it = iter([1,2,3, 4, 5])
print (next(it))
while True:
   try:
      no = next(it)
      print (no)
   except StopIteration:
      break

它將產生以下輸出：

自定義迭代器

Python 中的自定義迭代器是一個使用者定義的類，它實現了迭代器協議，該協議包含兩個方法__iter__()和__next__()。這允許類表現得像一個迭代器，從而能夠一次遍歷其元素。

要在 Python 中定義自定義迭代器類，該類必須定義這些方法。

示例

在下面的示例中，Oddnumbers 是一個實現了 __iter__() 和 __next__() 方法的類。每次呼叫 __next__() 時，數字都會增加 2，從而在 1 到 10 的範圍內流式傳輸奇數。

class Oddnumbers:

   def __init__(self, end_range):
      self.start = -1
      self.end = end_range

   def __iter__(self):
      return self

   def __next__(self):
      if self.start < self.end-1:
         self.start += 2
         return self.start
      else:
         raise StopIteration

countiter = Oddnumbers(10)
while True:
   try:
      no = next(countiter)
      print (no)
   except StopIteration:
      break

它將產生以下輸出：

示例

讓我們再建立一個迭代器，使用以下程式碼生成前 n 個斐波那契數。

class Fibonacci:
   def __init__(self, max_count):
      self.max_count = max_count
      self.count = 0
      self.a, self.b = 0, 1

   def __iter__(self):
      return self

   def __next__(self):
      if self.count >= self.max_count:
         raise StopIteration
        
      fib_value = self.a
      self.a, self.b = self.b, self.a + self.b
      self.count += 1
      return fib_value

# Using the Fibonacci iterator
fib_iterator = Fibonacci(10)

for number in fib_iterator:
   print(number)

它將產生以下輸出：

非同步迭代器

Python 中的非同步迭代器允許我們迭代非同步序列，從而能夠在迴圈中處理非同步操作。

它們遵循非同步迭代器協議，該協議包含__aiter__()和__anext__()方法（從 Python 3.10 版本開始新增）。這些方法與 async for 迴圈結合使用以迭代非同步資料來源。

aiter()函式返回一個非同步迭代器物件。它是經典迭代器的非同步對應部分。任何非同步迭代器都必須支援___aiter()__和__anext__()方法。這兩個內建函式會在內部呼叫這些方法。

非同步函式稱為協程，並使用asyncio.run()方法執行。main() 協程包含一個 while 迴圈，該迴圈依次獲取奇數，如果數字超過 9 則引發 StopAsyncIteration。

與經典迭代器一樣，非同步迭代器提供物件流。當流耗盡時，將引發 StopAsyncIteration 異常。

示例

在下面給出的示例中，聲明瞭一個非同步迭代器類 Oddnumbers。它實現了 __aiter__() 和 __anext__() 方法。在每次迭代中，都會返回下一個奇數，並且程式會等待一秒鐘，以便它可以非同步執行任何其他程序。

import asyncio

class Oddnumbers():
   def __init__(self):
      self.start = -1

   def __aiter__(self):
      return self
      
   async def __anext__(self):
      if self.start >= 9:
         raise StopAsyncIteration
      self.start += 2
      await asyncio.sleep(1)
      return self.start
      
async def main():
   it = Oddnumbers()
   while True:
      try:
         awaitable = anext(it)
         result = await awaitable
         print(result)
      except StopAsyncIteration:
         break
         
asyncio.run(main())

輸出

它將產生以下輸出：

列印頁面