آموزش تکرارکننده(iterator) در پایتون

یک تکرارکننده(iterator)، یک شیء یا آبجکت است که حاوی چند مقدارِ قابل شمارش می‌باشد. 

یک تکرارکننده(iterator)، یک آبجکت است که بتوانیم روی آن حلقه بزنیم؛ یعنی بتوانیم روی تمام مقادیر آن پیمایش کنیم. 

از نظر فنی، یک تکرارکننده(iterator) در پایتون، یک آبجکت است که پروتکل تکرارکننده(iterator protocol) را پیاده‌سازی می‌کند؛ که شامل متدهای __iter__() و __next__() می‌شود. 

تفاوت تکرارکننده(iterator) و تکرارپذیر(iterable) در پایتون

لیست‌ها، تاپل‌ها، دیکشنری‌ها و مجموعه‌ها(set)، همه آبجکت‌های تکرارپذیر(iterable) هستند. آنها ظرف‌های تکرارپذیری هستند که، ما می‌توانیم یک تکرارکننده(iterator) را از آنها دریافت کنیم. همه‌ی این آبجکت‌ها یک متد به نام iter() دارند که از آن برای دریافت یک تکرارکننده(iterator) استفاده می‌شود. 

mytuple = ("apple", "banana", "cherry")
myit = iter(mytuple)

print(next(myit))
print(next(myit))
print(next(myit))

apple
banana
cherry

حتی رشته‌ها(string) نیز آبجکت‌های تکرارپذیری هستند و می‌توانند یک تکرارکننده را برگردانند(return کنند). 

mystr = "banana"
myit = iter(mystr)

print(next(myit))
print(next(myit))
print(next(myit))
print(next(myit))
print(next(myit))
print(next(myit))

b
a
n
a
n
a

حلقه زدن روی یک تکرارکننده(Iterator) در پایتون

ما همچنین می‌توانیم از یک حلقه‌ی for برای حلقه زدن(تکرار کردن یا iterate) روی یک آبجکت تکرارپذیر(iterable) استفاده کنیم:

mytuple = ("apple", "banana", "cherry")

for x in mytuple:
  print(x)

apple
banana
cherry

mystr = "banana"

for x in mystr:
  print(x)

b
a
n
a
n
a

نکته: در حقیقت، حقله‌ی for یک آبجکت تکرارکننده(iterator) ایجاد می‌کند و برای هر حلقه، متد next() را اجرا می‌کند. 

ایجاد یک تکرارکننده(iterator)

برای ایجاد یک آبجکت یا کلاس، بعنوان تکرارکننده، باید متدهای __iter__() و __next__() را در آبجکت خود پیاده‌سازی کنیم. 

همان طور که در فصل کلاس‌ها و آبجکت‌ها توضیح خواهیم داد، تمام کلاس‌ها یک تابع به نام __init__() دارند، که به ما امکان می‌دهد، هنگامی که آبجکت مورد نظر در حال ایجاد شدن است، کمی به کارِ مقداردهیِ اولیه یا همان initializing بپردازیم. 

متد __iter__() نیز به همین شکل عمل می‌کند، و با استفاده از آن می‌توانیم کارهایی مثل مقداردهی اولیه و غیره را انجام دهیم، اما همیشه باید خود آبجکت تکرارکننده(iterator) را برگرداند. متد __next__() نیز به ما امکان می‌دهد تا کارهایی را انجام دهیم و باید آیتم بعدی در دنباله را برای ما برگرداند. 

class MyNumbers:
  def __iter__(self):
    self.a = 1
    return self

  def __next__(self):
    x = self.a
    self.a += 1
    return x

myclass = MyNumbers()
myiter = iter(myclass)

print(next(myiter))
print(next(myiter))
print(next(myiter))
print(next(myiter))
print(next(myiter))

1
2
3
4
5

دستور StopIteration در پایتون

در مثال بالا، اگر از دستورات next() کافی استفاده کنیم، یا اگر از یک حلقه‌ی for استفاده کنیم، این دنباله تا ابد ادامه پیدا می‌کند. برای جلوگیری از تکرار شدن دنباله تا ابد، می‌توانیم از دستور StopIteration استفاده کنیم. در متد __next__() می‌توانیم یک شرط خاتمه‌دهنده اضافه کنیم تا اگر تکرارِ دنباله، بخواهد از تعداد دفعات خاصی فراتر برود، یک خطا ایجاد شود:

class MyNumbers:
  def __iter__(self):
    self.a = 1
    return self

  def __next__(self):
    if self.a <= 20:
      x = self.a
      self.a += 1
      return x
    else:
      raise StopIteration

myclass = MyNumbers()
myiter = iter(myclass)

for x in myiter:
  print(x)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

منبع: www.w3schools.com/python