Lichen

Annotated lib/__builtins__/iteration/enumeration.py

979:2957d8a7ccfb
14 months ago Paul Boddie Introduce special well-defined instances, similar to predefined constants, to support loop exit conditions without having to raise a new instance as an exception on every occasion. well-defined-instances
paul@528 1
#!/usr/bin/env python
paul@528 2
paul@528 3
"""
paul@528 4
Enumeration-related functions.
paul@528 5
paul@528 6
Copyright (C) 2015, 2016, 2017 Paul Boddie <paul@boddie.org.uk>
paul@528 7
paul@528 8
This program is free software; you can redistribute it and/or modify it under
paul@528 9
the terms of the GNU General Public License as published by the Free Software
paul@528 10
Foundation; either version 3 of the License, or (at your option) any later
paul@528 11
version.
paul@528 12
paul@528 13
This program is distributed in the hope that it will be useful, but WITHOUT
paul@528 14
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
paul@528 15
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
paul@528 16
details.
paul@528 17
paul@528 18
You should have received a copy of the GNU General Public License along with
paul@528 19
this program.  If not, see <http://www.gnu.org/licenses/>.
paul@528 20
"""
paul@528 21
paul@528 22
def enumerate(iterable, start=0):
paul@528 23
paul@528 24
    """
paul@528 25
    Iterate over 'iterable', obtaining items and combining them with position
paul@528 26
    information, producing a sequence containing tuples of the form
paul@528 27
    (position, item). The first position is indicated by 'start' (which is zero
paul@528 28
    by default) and each subsequent positions is incremented from the one
paul@528 29
    preceding it.
paul@528 30
    """
paul@528 31
paul@528 32
    l = []
paul@528 33
    pos = start
paul@528 34
paul@528 35
    for i in iterable:
paul@528 36
        l.append((pos, i))
paul@528 37
        pos += 1
paul@528 38
paul@528 39
    return l
paul@528 40
paul@528 41
# vim: tabstop=4 expandtab shiftwidth=4