Python Iterators

JK1184 
Created at Jun 18, 2023 11:52:04
Updated at May 09, 2024 15:53:15 
77   0   0   0  

An iterator is an object that contains a countable number of values.

An iterator is an object that can be iterated upon, meaning that you can traverse through all the values.

Technically, in Python, an iterator is an object which implements the iterator protocol, which consist of the methods __iter__() and __next__().


Iterator vs Iterable

Lists, tuples, dictionaries, and sets are all iterable objects. They are iterable containers which you can get an iterator from.

All these objects have a iter() method which is used to get an iterator:

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

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

Even strings are iterable objects, and can return an iterator:

mystr = "banana"
myit = iter(mystr)

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

Looping Through an Iterator

We can also use a for loop to iterate through an iterable object:

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

for x in mytuple:
  print(x)
mystr = "banana"

for x in mystr:
  print(x)

The for loop actually creates an iterator object and executes the next() method for each loop.


Create an Iterator

To create an object/class as an iterator you have to implement the methods __iter__() and __next__() to your object.

As you have learned in the Python Classes/Objects chapter, all classes have a function called __init__(), which allows you to do some initializing when the object is being created.

The __iter__() method acts similar, you can do operations (initializing etc.), but must always return the iterator object itself.

The __next__() method also allows you to do operations, and must return the next item in the sequence.

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))

StopIteration

The example above would continue forever if you had enough next() statements, or if it was used in a for loop.

To prevent the iteration from going on forever, we can use the StopIteration statement.

In the __next__() method, we can add a terminating condition to raise an error if the iteration is done a specified number of times:

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)

 



Tags: Iteration Python Python Iterators Share on Facebook Share on X

◀ PREVIOUS
Python Inheritance
▶ NEXT
Python Polymorphism
  Comments 0
Login for comment
SIMILAR POSTS

Python Inheritance (updated at May 09, 2024)

Python Polymorphism (updated at May 09, 2024)

Python Scope (updated at May 09, 2024)

Python Classes/Objects (updated at May 09, 2024)

Python Modules (updated at May 09, 2024)

Python Arrays (updated at May 09, 2024)

Python Lambda (updated at May 09, 2024)

Python Functions (updated at May 09, 2024)

Python While Loops/For Loops (updated at May 09, 2024)

Python Conditions and If statements (updated at May 09, 2024)

Python Dictionaries (updated at May 09, 2024)

Python Sets (updated at May 09, 2024)

Python Tuples (updated at May 09, 2024)

Python Comparison Operators (updated at May 10, 2024)

Python Arithmetic Operators (created at Jun 14, 2023)

Python Lists (updated at May 10, 2024)

Python String Operations (updated at May 10, 2024)

Python Data Types (updated at May 10, 2024)

Python Variables (updated at May 10, 2024)

Python Comments (updated at May 10, 2024)

Python Syntax (updated at May 10, 2024)

Python Getting Started (updated at May 10, 2024)

Python Introduction (created at Jun 12, 2023)

What is Python? (updated at Jan 04, 2024)

Code Chronicles - A Caffeine-Fueled Journey into Data Software Engineering (updated at May 12, 2024)

Machine Learning Types and Programming Languages (updated at Nov 29, 2023)

Python Tutorials for AP Computer Science Principles, Data Projects and High School Internship (updated at May 10, 2024)

Mastering Excel Data Manipulation with Python (updated at Apr 26, 2024)

OTHER POSTS IN THE SAME CATEGORY

Mastering Excel Data Manipulation with Python (updated at Apr 26, 2024)

Try...Catch Helps Ignoring Data Type Miss-Match Error in Python (updated at Mar 26, 2024)

RegExp example in Python to exclude javascript from HTML code (created at Mar 22, 2024)

Python code to convert from Lunar to Solar (created at Mar 22, 2024)

Python example to download webpage (updated at May 15, 2024)

Python Tutorials for AP Computer Science Principles, Data Projects and High School Internship (updated at May 10, 2024)

Python Modules (updated at May 09, 2024)

Python Scope (updated at May 09, 2024)

Python Polymorphism (updated at May 09, 2024)

Python Inheritance (updated at May 09, 2024)

Python Classes/Objects (updated at May 09, 2024)

Python Arrays (updated at May 09, 2024)

Python Lambda (updated at May 09, 2024)

Python Functions (updated at May 09, 2024)

Python While Loops/For Loops (updated at May 09, 2024)

Python Conditions and If statements (updated at May 09, 2024)

Python Dictionaries (updated at May 09, 2024)

Python Sets (updated at May 09, 2024)

Python Tuples (updated at May 09, 2024)

Python Comparison Operators (updated at May 10, 2024)

Python Arithmetic Operators (created at Jun 14, 2023)

Python Lists (updated at May 10, 2024)

Python String Operations (updated at May 10, 2024)

Python Data Types (updated at May 10, 2024)

UPDATES

Aiming for Congressional Award Gold? Your Registration Guide! (created at May 19, 2024)

Digital SAT what you should know (updated at May 17, 2024)

Reflections on a Year of Volunteering at Torrance Wilson Park: Season in 2023-2024 (updated at May 16, 2024)

ChatGPT Reset command and Ignore the Previous Response feature to have a Solid Result (updated at May 16, 2024)

Python example to download webpage (updated at May 15, 2024)

Impact in the theird party cookie on web browser (updated at May 15, 2024)

Why Nike Card Wallets Are a Smart Buy for the Stylishly Practical (updated at May 15, 2024)

How to Rip a Leg that hundreds of people succeeded in (updated at May 15, 2024)

Little Johnny Kang's Taekwondo Journey at the Kukkiwon in 2016 (created at May 15, 2024)

IU's Life Snapshots (updated at May 15, 2024)

Java Tutorials associated with AP Computer Science A (updated at May 15, 2024)

Java Getting Started (updated at May 15, 2024)

Java Syntax (updated at May 15, 2024)

Java Comments (updated at May 15, 2024)

Java Variables (updated at May 15, 2024)

Java Math (updated at May 15, 2024)

Java If ... Else (updated at May 15, 2024)

Java Short Hand If...Else (Ternary Operator) (updated at May 15, 2024)

Java Switch Statements (updated at May 15, 2024)

Loading XML Data with JavaScript (created at May 15, 2024)

Finding Comfort in the Chaos: My LOL Journey on US Servers (updated at May 14, 2024)

Java While Loop/Do While Loop/For Loop/For-Each Loop/Break/Continue (updated at May 13, 2024)

Java Arrays (updated at May 13, 2024)

Meet NewJeans Danielle: The Rising Star with Killer Dance Moves! (updated at May 13, 2024)

IU's 5.16MHz with UAENA (updated at May 12, 2024)

Microsoft Windows commands frquently used (updated at May 12, 2024)

Key Features of the Apache License (updated at May 12, 2024)

Naver Papago - multilingual machine translation service (updated at May 12, 2024)

What is Sitemap? Why do we need it? (updated at May 12, 2024)

What is a smart TV? (updated at May 12, 2024)

Semantic Network - a method of expressing knowledge based on a mesh structure (updated at May 12, 2024)

What is the role of README.md at GitHub/GitLab Repository? (updated at May 12, 2024)

Google Map Link Logic (updated at May 12, 2024)

Flying side kick - Run → Jump → Kick (updated at May 12, 2024)

Las Vegas KÀ by Cirque du Soleil that showed us an exciting fantasy (updated at May 12, 2024)

Physics Areas and Formulas (updated at May 12, 2024)

Statistics Formulas (updated at May 12, 2024)

PreCalculus Formulas for Trigonometry and Math Analysis (updated at May 12, 2024)

Differential/Integral Calculus Formulas (updated at May 12, 2024)

Mean(Averange) and Median based on Global Wealth per Person (updated at May 12, 2024)

Sneaker Style: Perfect Shoes to Wear with Jeans (updated at May 12, 2024)

YouTube Multiview Video Games Dataset from UC Irvine Machine Learning Repository (updated at May 12, 2024)

How to tie your Taekwondo Belt? (updated at May 12, 2024)

Taekwondo Tornado Kick Tutorial - one of my favorite kicks (updated at May 12, 2024)

Exploring the Heartfelt History and Traditions of Valentine's Day (updated at May 12, 2024)

Resell Price $9,400 - Apple Vision Pro Goes Off Right After Launch (updated at May 12, 2024)

Clack Attack - Embracing the Joyful Chaos of Mechanical Keyboards (updated at May 12, 2024)

Indulging in Delight: Waffles and Long Drinks in Seoul, Korea (updated at May 12, 2024)

A House Tour Adventure in the California, US (updated at May 12, 2024)

Base camp for house hunting in Anaheim near Disney Land (updated at May 12, 2024)