Search code examples
pythoniterator

How to create a copy of an iterator?


I tried to create a copy of my iterator using assignment, however it created a copy of iterator which referenced the original iterator itself. For instance:

my_list = [5, 4, 3,2]
first_it = iter(my_list)
second_it = first_it 
print next(first_it )        #it will print 5
print next(second_it)        #it will print 4
print next(first_it )        #it will print 3

As you see in the example first_it and second_it both refer to same iterator object. Is it possible to create a copy of iterator object which is not reference to the original object


Solution

  • Use the itertools.tee() function to produce copies; these use a buffer to share results between different iterators:

    from itertools import tee
    
    my_list = [5, 4, 3,2]
    first_it = iter(my_list)
    first_it, second_it = tee(first_it)
    print next(first_it)   # prints 5
    print next(second_it)  # prints 5
    print next(first_it)   # prints 4
    

    Note that you should no longer use the original iterator; use only the tees.

    Note that the buffer also means that these can incur a significant memory cost if you advance one of the copies far ahead of the others! From the documentation:

    This itertool may require significant auxiliary storage (depending on how much temporary data needs to be stored). In general, if one iterator uses most or all of the data before another iterator starts, it is faster to use list() instead of tee().