How Do Python Iterators Work: A Guide to the `__iter__` and `__next__` Methods?

How Python Iterators Work: A Comprehensive Guide

Iterators are essential elements in Python programming, allowing efficient and concise traversal of sequences or generation of values on the fly. This article explores how to create a basic iterator in Python, focusing on the fundamental concepts and implementation.

Understanding the Iterator Protocol

Python iterators follow a specific protocol, defined by the __iter__() and __next__() methods. The __iter__() method returns the iterator object, which serves as an entry point for iteration. Conversely, the __next__() method returns the next value in the sequence or raises a StopIteration exception when there are no more values.

Creating a Custom Iterator

Consider the following Example class that logically "contains" values:

class Example:
    def __init__(self, values):
        self.values = values

To implement an iterator for this class, we define the __iter__() and __next__() methods:

class Example:
    def __init__(self, values):
        self.values = values

    def __iter__(self):
        return self

    def __next__(self):
        if self.values:
            return self.values.pop(0)
        else:
            raise StopIteration

In this example, the iterator returns values from the values list by popping them one by one. When the list is empty, it raises a StopIteration exception.

Using the Iterator

Now, we can use the iterator as follows:

e = Example([1, 2, 3])

for value in e:
    print("The example object contains", value)

This code will iterate over the values [1, 2, 3] and print each value to the console.

More Complex Iterators

Iterators are not limited to accessing specific attributes or values of an instance. They can also control where values come from or even compute them on the fly. For instance, the following Counter class generates a range of values:

class Counter:
    def __init__(self, low, high):
        self.current = low - 1
        self.high = high

    def __iter__(self):
        return self

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

By calling the __iter__() method on this class, we obtain an iterator that will generate values in the specified range.

Conclusion

Python iterators provide a powerful and flexible mechanism for iterating over sequences or generating values. Understanding the iterator protocol and how to implement custom iterators empowers developers to create efficient and versatile code.

The above is the detailed content of How Do Python Iterators Work: A Guide to the `__iter__` and `__next__` Methods?. For more information, please follow other related articles on the PHP Chinese website!