From: Raymond Hettinger <python@rcn.com>
Date: Mon, 9 Mar 2009 11:56:52 +0000 (+0000)
Subject: Add consume() recipe to itertools docs.
X-Git-Tag: 3.0~329
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a5b0e9a565e96a74852a53accc47c3831b8b6d9a;p=thirdparty%2FPython%2Fcpython.git

Add consume() recipe to itertools docs.
---

diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst
index 16a0fa9638fc..91aa09bb237d 100644
--- a/Doc/library/itertools.rst
+++ b/Doc/library/itertools.rst
@@ -549,6 +549,10 @@ which incur interpreter overhead.
        "Return function(0), function(1), ..."
        return map(function, count(start))
 
+   def consume(iterator, n):
+       "Advance the iterator n-steps ahead. If n is none, consume entirely."
+       collections.deque(islice(iterator, n), maxlen=0)
+
    def nth(iterable, n, default=None):
        "Returns the nth item or a default value"
        return next(islice(iterable, n, None), default)