[ADD] big bit on new import: pretty much everything but o2m

[odoo/odoo.git] / openerp / tools / misc.py

diff --git a/openerp/tools/misc.py b/openerp/tools/misc.py
index 9a7b349..1ee3caf 100644 (file)
--- a/openerp/tools/misc.py
+++ b/openerp/tools/misc.py
@@ -1220,4 +1220,38 @@ class mute_logger(object):
             with self:
                 return func(*args, **kwargs)
         return deco
+
+_ph = object()
+class CountingStream(object):
+    """ Stream wrapper counting the number of element it has yielded. Similar
+    role to ``enumerate``, but for use when the iteration process of the stream
+    isn't fully under caller control (the stream can be iterated from multiple
+    points including within a library)
+
+    ``start`` allows overriding the starting index (the index before the first
+    item is returned).
+
+    On each iteration (call to :meth:`~.next`), increases its :attr:`~.index`
+    by one.
+
+    .. attribute:: index
+
+        ``int``, index of the last yielded element in the stream. If the stream
+        has ended, will give an index 1-past the stream
+    """
+    def __init__(self, stream, start=-1):
+        self.stream = iter(stream)
+        self.index = start
+        self.stopped = False
+    def __iter__(self):
+        return self
+    def next(self):
+        if self.stopped: raise StopIteration()
+        self.index += 1
+        val = next(self.stream, _ph)
+        if val is _ph:
+            self.stopped = True
+            raise StopIteration()
+        return val
+
 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: