3.2.1. What is an Iterator?

An iterator is an object that represents a stream of data; it returns one element at a time when asked. Python’s iterator protocol is a standard interface for these objects.

An iterator is essentially a way to access each item in a collection (like a list) one at a time, without needing to know the entire collection in advance. When you use an iterator, you're asking for the next item in the data stream whenever you need it. This is particularly useful for working with large datasets where you might not want to load everything into memory at once.

Think of an iterator like a waiter in a restaurant who serves one dish at a time. Instead of bringing out all the food (data) at once, the waiter (iterator) brings each dish one by one when you ask for it, ensuring you only handle what you'll consume at any given moment.

An object is an iterator if it implements two methods:

● iter() — Returns the iterator object itself.

● next() — Returns the next item in the sequence. Raises StopIteration when no more items exist.

To be considered an iterator, an object in Python needs to implement two specific methods: __iter__ and __next__. The __iter__ method returns the iterator object itself, which allows you to use it in a loop. The __next__ method retrieves the next item in the sequence. When there are no more items to retrieve, it raises a StopIteration exception, signaling that the iteration is complete.

Imagine a library where each book has a card that tells you if it's the last book on the shelf. The __iter__ method is like the librarian giving you the entire shelf of books (the iterator object), and the __next__ method is like asking the librarian to pass you the next book. When you run out of books, the librarian tells you there's no more (raises StopIteration).

Example: Custom Iterator

class CountDown:
    def __init__(self, start):
        self.current = start

    def __iter__(self):
        return self

    def __next__(self):
        if self.current <= 0:
            raise StopIteration
        else:
            self.current -= 1
            return self.current + 1

cd = CountDown(3)
for number in cd:
    print(number)

Output: 3 2 1

This example defines a custom iterator called CountDown. In this class, the __init__ method sets a starting value. The __iter__ method returns the object itself, allowing it to be used in loops. The __next__ method checks if the countdown is complete (current is less than or equal to zero). If it is not, it decrements the value and returns the next number; if it is, it raises a StopIteration exception to indicate that there are no more numbers to return.

Think of a countdown timer you might use when cooking. You set it to 3 minutes, and it gives you a signal (the next number) each minute until it hits zero. Once it reaches zero, it stops signaling (raises StopIteration). This way, you can use just one timer (iterator) without having to manage individual minutes (data items) manually.

● for loops internally call iter() to get an iterator.

● The loop repeatedly calls next() until StopIteration is raised.

● Iterators maintain internal state to produce the next element.

Key points highlight how for loops and iterators work together. When you use a for loop, Python calls the iter() function on the object you provide, which returns an iterator. Then, the loop continuously calls the next() function to retrieve the next item, stopping only when StopIteration indicates that there are no further items. Additionally, iterators keep track of their current position or state internally, which enables them to know 'where' they are in the data stream.

Imagine a train traveling through several stations. The for loop is like the conductor who announces each stop (calls next() for each item), and the train maintains its position along the track (internal state) until it reaches the final destination (no more items left, raising StopIteration). The conductor knows when to stop announcing once the train has finished its route.

--