What is the implementation detail for enumerate?

Question

Python has enumerate() to iterate over objects with an index.I doubt that interpreters create a lot of int objects for the sole purpose of keeping track of where things are. The PEP page says the following, but I do not really understand what is going on under the hood:

It provides all iterables with the same advantage that iteritems() affords to dictionaries -- a compact, readable, reliable index notation.

So what is the magic here?

Python creates a lot of `int` objects *everywhere*, but interns the small values (somewhere in the range -5 through to 256). — Martijn Pieters, May 29 '13 at 07:59
@jamylak I am new to Ptyhon so I have trouble finding the source code just by googling. Which one of those files contain the source code for `enumerate`? — Forethinker, May 29 '13 at 08:01
@Forethinker: http://hg.python.org/cpython/file/2.7/Objects/enumobject.c — Martijn Pieters, May 29 '13 at 08:03

score 16 · Accepted Answer · answered May 29 '13 at 08:05

enumerate() is an iterator; it only produces the index int value on the fly; it does not produce them all up front.

You can try to read the enumobject.c source code, but it basically can be translated to Python like this:

def enumerate(iterable, start=0):
    count = start
    for elem in iterable:
        yield count, elem
        count += 1

The yield keyword makes this a generator function, and you need to loop over the generator (or call next() on it) to advance the function to produce data, one yield call at a time.

Python also interns int values, all values between -5 and 256 (inclusive) are singletons, so the above code doesn't even produce new int objects until you reach 257.

Programming language source code is still a bit daunting for me. Anyone who brushes up on `yield` will get this right away. Thanks a lot Martijn! — Forethinker, May 29 '13 at 08:12

score 2 · Answer 2 · answered May 29 '13 at 08:02

It helps you know where things are....

l = ['apple', 'banana', 'cabbage']

for idx, item in enumerate(l):
    print "the item: %s, is at position %s" % (item, idx)

>>> 
the item: apple, is at position 0
the item: banana, is at position 1
the item: cabbage, is at position 2

This helps in the following scenario.. Imagine you want to find every 'cabbage' item in the list. And know their indexes.

l = ['apple', 'banana', 'cabbage', 'monkey', 'kangaroo', 'cabbage']

def find_indexes(lst, match):
    results = []
    for idx, item in enumerate(l):
        if item == match:
            results.append(idx)
    return results

print find_indexes(l, 'cabbage')

>>> 
[2, 5]

What is the implementation detail for enumerate?

2 Answers2

Linked