Python中,使用for循環可以迭代容器對象中的元素,這裏容器對象包括是列表(list)、元組(tuple)、字典(dict)、集合(set)等。但是,爲什麼這些對象可以使用for循環進行操作呢?
首先,定義一個簡單的類嘗試一下:
class TestRange:
def __init__(self, num):
self.num = num
for i in TestRange(10):
print(i)
# 輸出
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'TestRange' object is not iterable
錯誤信息提示,‘TestRange’ object 不是可迭代的對象。那麼,什麼纔是可迭代的對象呢?
在可迭代的對象中,需要實現一個__iter__
魔法方法,而且這個方法的返回值需要是一個迭代器。那麼,什麼是迭代器呢?
迭代器只需要實現__next__
魔法方法。
以列表(list)爲例:
>>> nums = [13,12,33]
>>> iter_ret = nums.__iter__() # x有此方法,說明list是可迭代的,而且該方法返回一個迭代器
>>> iter_ret
<list_iterator object at 0x100f32198>
>>> iter_ret.__next__()
13
>>> iter_ret.__next__()
12
>>> iter_ret.__next__()
33
>>> iter_ret.__next__()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
StopIteration
分析:
如上所示,列表nums中實現了
__iter__
方法,而且返回一個迭代器(iterator),迭代器中實現了__next__
方法。在不斷調用__next__
的過程中,就是在不斷返回nums中的元素,直到出現StopIteration
的錯誤。
其實,for語句的作用與此類似。for語句的內部機制爲:
- 先判斷對象是否爲可迭代對象,即是否存在
__iter__
方法,如果存在則調用__iter__
方法,返回一個迭代器;否則,直接拋出TypeError異常; - 不斷地調用迭代器的
__next__
方法,每次調用按順序迭代獲取當前的值; - 迭代完所有元素,就拋出異常 StopIteration,這個異常 python 解釋器自己會處理;
前面的 TestRange 報錯是因爲它沒有實現迭代器協議裏面的這兩個方法,現在繼續改進:
class TestRange:
def __init__(self, _max):
self.i = 0
self._max = _max
def __iter__(self):
return self
def __next__(self):
if self.i < self._max:
i = self.i
self.i += 1
return i
else:
# 達到停止條件時,拋出此異常
raise StopIteration()
# 進行測試
for i in TestRange(3):
print(i)
# 輸出
0
1
2
分析:
因爲這個類中,已經實現了
__next__
方法,所以基於這個類所創建的對象,本身就是一個迭代器。又因爲可迭代對象需要有__iter__
方法,而且返回一個迭代器,所以__iter__
返回對象本身self
即可。