Пользовательские итераторы

Объектно-ориентированное программирование на Python: средний уровень

Jake Roach

Data Engineer

Итераторы

Классы, которые позволяют обходить коллекции объектов или потоки данных и возвращают по одному элементу

Похожи на list и tuple, но работают иначе
Навигация, преобразование, генерация
Обход с помощью цикла for
Функция next()

Протокол итератора...

# Collection
chuck = NameIterator("Charles Carmicheal")
for letter in chuck:
    print(letter)

C
h
u
...

# Data stream
fun_game = DiceGame(rolls=3)
next(fun_game)  # ... and so on

Протокол итератора

__iter__()

Возвращает итератор — в данном случае ссылку на себя
... return self

__next__()

Возвращает следующее значение из коллекции или потока данных
Здесь происходит итерация, преобразование и генерация

Для создания итератора в классе необходимо определить оба метода — __iter__() и __next__()!

Пример итератора

class CoinFlips:
    def __init__(self, number_of_flips):
        self.number_of_flips = number_of_flips  # Store the total number of flips
        self.counter = 0

    def __iter__(self):
        return self  # Return a reference of the iterator

    # Flip the next coin, return the output
    def __next__(self):
        if self.counter < self.number_of_flips:
            self.counter += 1
            return random.choice(["H", "T"])

Использование итератора

three_flips = CoinFlips(3)

# Flip the coin three times
next(three_flips)
next(three_flips)
next(three_flips)

H
H
T

Обход итератора в цикле

three_flips = CoinFlips(3)

# Now, try to loop through every element of the iterator
for flip in three_flips:
    print(flip)

T
H
T
None
None
None
...

StopIteration

...
    def __next__(self):
        # Only do this if the coin hasn't been flipped "number_of_flips" times
        if self.counter < self.number_of_flips:
            self.counter += 1
            return random.choice(["H", "T"])

        else:  # Otherwise, stop execution with StopIteration
            raise StopIteration

Сигнализирует об окончании коллекции или потока данных
Предотвращает бесконечные циклы
Легко обрабатывается

Обход итератора в цикле

three_flips = CoinFlips(3)

# Now, try to loop through every element of the iterator
for flip in three_flips:
    print(flip)

H
T
H

Обработка исключений StopIteration

while True:
    try:
        next(three_flips)  # Pull the next element of three_flips

    # Catch a stop iteration exception
    except StopIteration:
        print("Completed all coin flips!")
        break

H
H
H
Completed all coin flips!

Давайте потренируемся!

Объектно-ориентированное программирование на Python: средний уровень