5.16.1 Itertool functions
The following module functions all construct and return iterators. Some provide streams of infinite length, so they should only be accessed by functions or loops that truncate the stream.
-
Make an iterator that returns elements from the first iterable until
it is exhausted, then proceeds to the next iterable, until all of the
iterables are exhausted. Used for treating consecutive sequences as
a single sequence. Equivalent to:
def chain(*iterables): for it in iterables: for element in it: yield element
-
Make an iterator that returns consecutive integers starting with n.
If not specified n defaults to zero.
Does not currently support python long integers. Often used as an
argument to imap() to generate consecutive data points.
Also, used with izip() to add sequence numbers. Equivalent to:
def count(n=0): while True: yield n n += 1
Note, count() does not check for overflow and will return negative numbers after exceeding
sys.maxint
. This behavior may change in the future.
-
Make an iterator returning elements from the iterable and saving a
copy of each. When the iterable is exhausted, return elements from
the saved copy. Repeats indefinitely. Equivalent to:
def cycle(iterable): saved = [] for element in iterable: yield element saved.append(element) while saved: for element in saved: yield element
Note, this member of the toolkit may require significant auxiliary storage (depending on the length of the iterable).
-
Make an iterator that drops elements from the iterable as long as
the predicate is true; afterwards, returns every element. Note,
the iterator does not produce any output until the predicate
is true, so it may have a lengthy start-up time. Equivalent to:
def dropwhile(predicate, iterable): iterable = iter(iterable) for x in iterable: if not predicate(x): yield x break for x in iterable: yield x
-
Make an iterator that returns consecutive keys and groups from the
iterable. The key is a function computing a key value for each
element. If not specified or is
None
, key defaults to an identity function and returns the element unchanged. Generally, the iterable needs to already be sorted on the same key function.The returned group is itself an iterator that shares the underlying iterable with groupby(). Because the source is shared, when the groupby object is advanced, the previous group is no longer visible. So, if that data is needed later, it should be stored as a list:
groups = [] uniquekeys = [] for k, g in groupby(data, keyfunc): groups.append(list(g)) # Store group iterator as a list uniquekeys.append(k)
groupby() is equivalent to:
New in version 2.4.class groupby(object): def __init__(self, iterable, key=None): if key is None: key = lambda x: x self.keyfunc = key self.it = iter(iterable) self.tgtkey = self.currkey = self.currvalue = xrange(0) def __iter__(self): return self def next(self): while self.currkey == self.tgtkey: self.currvalue = self.it.next() # Exit on StopIteration self.currkey = self.keyfunc(self.currvalue) self.tgtkey = self.currkey return (self.currkey, self._grouper(self.tgtkey)) def _grouper(self, tgtkey): while self.currkey == tgtkey: yield self.currvalue self.currvalue = self.it.next() # Exit on StopIteration self.currkey = self.keyfunc(self.currvalue)
-
Make an iterator that filters elements from iterable returning only
those for which the predicate is
True
. If predicate isNone
, return the items that are true. Equivalent to:def ifilter(predicate, iterable): if predicate is None: predicate = bool for x in iterable: if predicate(x): yield x
-
Make an iterator that filters elements from iterable returning only
those for which the predicate is
False
. If predicate isNone
, return the items that are false. Equivalent to:def ifilterfalse(predicate, iterable): if predicate is None: predicate = bool for x in iterable: if not predicate(x): yield x
-
Make an iterator that computes the function using arguments from
each of the iterables. If function is set to
None
, then imap() returns the arguments as a tuple. Like map() but stops when the shortest iterable is exhausted instead of filling inNone
for shorter iterables. The reason for the difference is that infinite iterator arguments are typically an error for map() (because the output is fully evaluated) but represent a common and useful way of supplying arguments to imap(). Equivalent to:def imap(function, *iterables): iterables = map(iter, iterables) while True: args = [i.next() for i in iterables] if function is None: yield tuple(args) else: yield function(*args)
-
Make an iterator that returns selected elements from the iterable.
If start is non-zero, then elements from the iterable are skipped
until start is reached. Afterward, elements are returned consecutively
unless step is set higher than one which results in items being
skipped. If stop is
None
, then iteration continues until the iterator is exhausted, if at all; otherwise, it stops at the specified position. Unlike regular slicing, islice() does not support negative values for start, stop, or step. Can be used to extract related fields from data where the internal structure has been flattened (for example, a multi-line report may list a name field on every third line). Equivalent to:def islice(iterable, *args): s = slice(*args) next, stop, step = s.start or 0, s.stop, s.step or 1 for cnt, element in enumerate(iterable): if cnt < next: continue if stop is not None and cnt >= stop: break yield element next += step
-
Make an iterator that aggregates elements from each of the iterables.
Like zip() except that it returns an iterator instead of
a list. Used for lock-step iteration over several iterables at a
time. Equivalent to:
def izip(*iterables): iterables = map(iter, iterables) while iterables: result = [i.next() for i in iterables] yield tuple(result)
Changed in version 2.4: When no iterables are specified, returns a zero length iterator instead of raising a TypeError exception.
-
Make an iterator that returns object over and over again.
Runs indefinitely unless the times argument is specified.
Used as argument to imap() for invariant parameters
to the called function. Also used with izip() to create
an invariant part of a tuple record. Equivalent to:
def repeat(object, times=None): if times is None: while True: yield object else: for i in xrange(times): yield object
-
Make an iterator that computes the function using arguments tuples
obtained from the iterable. Used instead of imap() when
argument parameters are already grouped in tuples from a single iterable
(the data has been ``pre-zipped''). The difference between
imap() and starmap() parallels the distinction
between
function(a,b)
andfunction(*c)
. Equivalent to:def starmap(function, iterable): iterable = iter(iterable) while True: yield function(*iterable.next())
-
Make an iterator that returns elements from the iterable as long as
the predicate is true. Equivalent to:
def takewhile(predicate, iterable): for x in iterable: if predicate(x): yield x else: break
-
Return n independent iterators from a single iterable.
The case where
n==2
is equivalent to:def tee(iterable): def gen(next, data={}, cnt=[0]): for i in count(): if i == cnt[0]: item = data[i] = next() cnt[0] += 1 else: item = data.pop(i) yield item it = iter(iterable) return (gen(it.next), gen(it.next))
Note, once tee() has made a split, the original iterable should not be used anywhere else; otherwise, the iterable could get advanced without the tee objects being informed.
Note, this member of the toolkit may require significant auxiliary storage (depending on how much temporary data needs to be stored). In general, if one iterator is going to use most or all of the data before the other iterator, it is faster to use list() instead of tee(). New in version 2.4.
See About this document... for information on suggesting changes.