Python Iterator Pattern

\\n\\n

Imagine you have a jar filled with candies of various colors. You want to taste them one by one, without dumping all the candies out at once. So you reach into the jar and take out one candy at a time — this process is iteration.

\\n\\n

In programming, the Iterator Pattern is a design pattern that provides a way to sequentially access elements in a collection object without exposing its internal representation.

\\n\\n

Core Concepts

\\n\\n

The Iterator Pattern consists of two main components:

\\n\\n

\\n
1. Iterator: Responsible for defining the interface for accessing and traversing elements
\\n
2. Iterable: Provides a method to create an iterator
\\n

\\n\\n

In Python, the Iterator Pattern is deeply integrated into the language’s core features, making our programming more elegant and intuitive.

\\n\\n

---

\\n\\n

Why Do We Need Iterators?

\\n\\n

Limits of Traditional Approaches

\\n\\n

Let’s first look at an example that does not use iterators:

\\n\\n

Example

\\n\\n

# A simple book collection class\\n\\nclass BookCollection:\\n\\n    def __init__(self):\\n        self.books = ["PythonGetting Started", "Introduction to Algorithms", "Design Patterns", "Data Structures"]\\n\\n    def get_books(self):\\n        return self.books\\n\\n# Using the collection\\ncollection = BookCollection()\\nbooks = collection.get_books()\\n\\n# Iterating over books — exposes internal implementation details\\nfor i in range(len(books)):\\n    print(books)\\n

\\n\\n

Problem Analysis:

\\n\\n

\\n
• Client code must know the internal structure of the collection (list)
\\n
• If the internal implementation changes (e.g., from list to dict), all client code must be modified
\\n
• Traversal logic is tightly coupled with the collection implementation
\\n

\\n\\n

Advantages of Iterators

\\n\\n

Example

\\n\\n

# Using the iterator approach\\nfor book in collection:\\n    print(book)\\n

\\n\\n

Benefits brought by iterators:

\\n\\n

\\n
• Encapsulation: Hides the internal implementation of the collection
\\n
• Unified interface: Different collection types can use the same traversal method
\\n
• Flexibility: Easy to switch collection implementations
\\n
• Supports multiple traversals: Multiple traversal operations can be performed simultaneously
\\n

\\n\\n

---

\\n\\n

Iterator Protocol in Python

\\n\\n

Python implements the iterator protocol using two special methods:

\\n\\n

__iter__() Method

\\n\\n

\\n
• Returns an iterator object
\\n
• Iterable objects must implement this method
\\n

\\n\\n

__next__() Method

\\n\\n

\\n
• Returns the next element in the sequence
\\n
• Raises StopIteration exception when no more elements remain
\\n

\\n\\n

Let’s understand how iterators work using a flowchart:

\\n\\n

\\n\\n

---

\\n\\n

Creating Custom Iterators

\\n\\n

Method 1: Implementing an Iterator Using a Class

\\n\\n

Let’s create a custom book iterator:

\\n\\n

Example

\\n\\n

class BookIterator:\\n    """Book iterator class"""\\n\\n    def __init__(self, books):\\n        self.books = books\\n        self.index = 0\\n\\n    def __iter__(self):\\n        """Return the iterator itself"""\\n        return self\\n\\n    def __next__(self):\\n        """Return the next book; raise StopIteration if no more books"""\\n        if self.index < len(self.books):\\n            book = self.books[self.index]\\n            self.index += 1\\n            return book\\n        else:\\n            raise StopIteration\\n\\nclass BookCollection:\\n    """Iterable book collection class"""\\n\\n    def __init__(self):\\n        self.books = ["PythonGetting Started", "Introduction to Algorithms", "Design Patterns", "Data Structures"]\\n\\n    def __iter__(self):\\n        """Return an iterator instance"""\\n        return BookIterator(self.books)\\n\\n# Using the custom iterator\\ncollection = BookCollection()\\nfor book in collection:\\n    print(f"Currently Reading: {book}")\\n

\\n\\n

Output:

\\n\\n

Currently Reading: PythonGetting Started
\\nCurrently Reading: Introduction to Algorithms
\\nCurrently Reading: Design Patterns
\\nCurrently Reading: Data Structures

\\n\\n

Method 2: Using a Generator Function

\\n\\n

Python provides a more concise approach — generator functions:

\\n\\n

Example

\\n\\n

class BookCollection:\\n\\n    def __init__(self):\\n        self.books = ["PythonGetting Started", "Introduction to Algorithms", "Design Patterns", "Data Structures"]\\n\\n    def __iter__(self):\\n        """Create an iterator using a generator function"""\\n        for book in self.books:\\n            yield book\\n\\n# Usage is identical\\ncollection = BookCollection()\\nfor book in collection:\\n    print(f"Read: {book}")\\n

\\n\\n

Advantages of generators:

\\n\\n

\\n
• Code is more concise
\\n
• Automatically handles state saving
\\n
• Better performance
\\n

\\n\\n

---

\\n\\n

Practical Applications of Iterators

\\n\\n

Scenario 1: Paginated Data Reading

\\n\\n

Example

\\n\\n

class PaginatedData:\\n    """Simulate a paginated data iterator"""\\n\\n    def __init__(self, total_items, page_size=3):\\n        self.total_items = total_items\\n        self.page_size = page_size\\n        self.current_page = 0\\n\\n    def __iter__(self):\\n        return self\\n\\n    def __next__(self):\\n        start = self.current_page * self.page_size\\n        end = start + self.page_size\\n        if start >= self.total_items:\\n            raise StopIteration\\n\\n        # Simulate reading one page of data from a database\\n        page_data = list(range(start, min(end, self.total_items)))\\n        self.current_page += 1\\n        return page_data\\n\\n# Using the paginated iterator\\npaginator = PaginatedData(10, 3)  # 10 total items, 3 per page\\nfor page_num, page_data in enumerate(paginator, 1):\\n    print(f"Line{page_num}Page data: {page_data}")\\n

\\n\\n

Output:

\\n\\n

Line1Page data: [0, 1, 2]
\\nLine2Page data: [3, 4, 5]
\\nLine3Page data: [6, 7, 8]
\\nLine4Page data:

\\n\\n

Scenario 2: Generating Infinite Sequences

\\n\\n

Example

\\n\\n

class FibonacciIterator:\\n    """Fibonacci sequence iterator"""\\n\\n    def __init__(self, max_count=10):\\n        self.max_count = max_count\\n        self.count = 0\\n        self.a, self.b = 0, 1\\n\\n    def __iter__(self):\\n        return self\\n\\n    def __next__(self):\\n        if self.count >= self.max_count:\\n            raise StopIteration\\n\\n        result = self.a\\n        self.a, self.b = self.b, self.a + self.b\\n        self.count += 1\\n        return result\\n\\n# Generate Fibonacci sequence\\nfib = FibonacciIterator(8)\\nprint("Fibonacci sequence:", list(fib))\\n

\\n\\n

Output:

\\n\\n

Fibonacci sequence: [0, 1, 1, 2, 3, 5, 8, 13]

\\n\\n

---

\\n\\n

Built-in Iterator Tools

\\n\\n

Python provides rich built-in functions for working with iterators:

\\n\\n

iter() and next() Functions

\\n\\n

Example

\\n\\n

numbers = [1, 2, 3, 4, 5]\\n\\n# Manually using an iterator\\niterator = iter(numbers)\\nprint(next(iterator))  # Output: 1\\nprint(next(iterator))  # Output: 2\\nprint(next(iterator))  # Output: 3\\n

\\n\\n

enumerate() Function

\\n\\n

Example

\\n\\n

fruits = ['apple', 'banana', 'orange']\\nfor index, fruit in enumerate(fruits):\\n    print(f"Index {index}: {fruit}")\\n

\\n\\n

zip() Function

\\n\\n

Example

\\n\\n

names = ['Alice', 'Bob', 'Charlie']\\nscores = [85, 92, 78]\\nfor name, score in zip(names, scores):\\n    print(f"{name} Score: {score}")\\n

\\n\\n

---

\\n\\n

Iterator vs Iterable

\\n\\n

Understanding the distinction between these two concepts is important:

\\n\\n\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n

Feature	Iterable	Iterator
Definition	An object implementing the __iter__() method	An object implementing both __iter__() and __next__() methods
Purpose	Can be iterated over	Actually performs iteration
State	Usually stateless	Maintains iteration state (e.g., current position)
Examples	Lists, tuples, dictionaries, strings	Objects returned by iter()

\\n\\n

Relationship Diagram

\\n\\n

Example

\\n\\n

graph TD\\n A -->|Call iter| B\\n B -->|Repeatedly call next| C\\n C --> D\\n

\\n\\n

---

\\n\\n

Best Practices and Common Mistakes

\\n\\n

Best Practices

\\n\\n

\\n
1. Use generators to simplify code
\\n

\\n\\n

Example

\\n\\n

# Recommended: Use a generator\\ndef countdown(n):\\n    while n > 0:\\n        yield n\\n        n -= 1\\n\\n# Not recommended: Manually implement an iterator class\\n

\\n\\n

\\n
2. Leverage built-in functions
\\n

\\n\\n

Example

\\n\\n

# Recommended\\nsquares = (x * x for x in range(10))  # generator expression\\n\\n# Not recommended\\nclass SquareIterator:\\n    # ... verbose implementation\\n

\\n\\n

Common Mistakes

\\n\\n

Mistake 1: Confusing iterators with iterables

\\n\\n

Example

\\n\\n

numbers = [1, 2, 3]\\n\\n# Error: a list itself is not an iterator\\ntry:\\n    next(numbers)  # TypeError: 'list' object is not an iterator\\nexcept TypeError as e:\\n    print(f"Errors: {e}")\\n\\n# Correct: obtain an iterator first\\niterator = iter(numbers)\\nprint(next(iterator))  # Output: 1\\n

\\n\\n

Mistake 2: Continuing to use an exhausted iterator

\\n\\n

Example

\\n\\n

numbers = [1, 2, 3]\\niterator = iter(numbers)\\nprint(list(iterator))  # Output: [1, 2, 3]\\nprint(list(iterator))  # Output: [] — iterator exhausted!\\n

\\n\\n

---

\\n\\n

Practice Exercises

\\n\\n

Exercise 1: Create a Custom Iterator

\\n\\n

Create a Countdown class that implements an iterator counting down from a given number to 1:

\\n\\n

Example

\\n\\n

class Countdown:\\n    def __init__(self, start):\\n        self.start = start\\n\\n    def __iter__(self):\\n        # Your code here\\n        current = self.start\\n        while current > 0:\\n            yield current\\n            current -= 1\\n\\n# Test your implementation\\nfor num in Countdown(5):\\n    print(num)  # Should output: 5, 4, 3, 2, 1\\n

\\n\\n

Exercise 2: File Line Iterator

\\n\\n

Create an iterator that reads a file line by line and prefixes each line with its line number:

\\n\\n

Example

\\n\\n

class NumberedLines:\\n    def __init__(self, filename):\\n        self.filename = filename\\n\\n    def __iter__(self):\\n        with open(self.filename, 'r', encoding='utf-8') as file:\\n            for line_num, line in enumerate(file, 1):\\n                yield f"{line_num}: {line.rstrip()}"\\n

\\n\\n

---

\\n\\n

Summary

\\n\\n

The Iterator Pattern is an extremely important concept in Python programming, enabling us to:

\\n\\n

\\n
• Unify access: Traverse different data structures using the same method
\\n
• Encapsulate implementation: Hide the internal structure of collections
\\n
• Enable lazy evaluation: Generate data only when needed, saving memory
\\n
• Enable composition: Work seamlessly with generators, comprehensions, and other features
\\n

\\n\\n

Remember this simple principle: Any object implementing __iter__() is iterable; any object implementing __next__() is an iterator.