Zope2 Interfaces package delenda est\!

ProgressHandler.py

@@ -0,0 +1,109 @@
+##############################################################################
+#
+# Copyright (c) 2002 Zope Corporation and Contributors. All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""
+$Id$
+"""
+
+import time, sys
+from logging import getLogger
+
+from DateTime.DateTime import DateTime
+from zope.interface import Interface
+from zope.interface import implements
+
+LOG = getLogger('ProgressHandler')
+
+class IProgressHandler(Interface):
+    """ A handler to log progress informations for long running 
+        operations.
+    """
+
+    def init(ident, max):
+        """ Called at the start of the long running process.
+
+            'ident' -- a string identifying the operation
+            'max' -- maximum number of objects to be processed (int)
+        """ 
+
+    def info(text):
+        """ Log some 'text'"""
+
+    def finish():
+        """ Called up termination """
+
+    def report(current, *args, **kw):
+        """ Called for every iteration.
+
+            'current' -- an integer representing the number of objects 
+                         processed so far.
+        """
+
+    def output(text):
+        """ Log 'text' to some output channel """        
+
+
+class StdoutHandler:
+    """ A simple progress handler """
+
+    implements(IProgressHandler)
+
+    def __init__(self, steps=100):
+        self._steps = steps
+
+    def init(self, ident, max):
+        self._ident = ident
+        self._max = max
+        self._start = time.time()
+        self.fp = sys.stdout
+        self.output('Process started (%d objects to go)' % self._max)
+
+    def info(self, text):
+        self.output(text)
+
+    def finish(self):
+        self.output('Process terminated. Duration: %0.2f seconds' % \
+                    (time.time() -self._start))
+
+    def report(self, current, *args, **kw):
+        if current > 0:
+            if current % self._steps == 0: 
+                seconds_so_far = time.time() - self._start
+                seconds_to_go  = seconds_so_far / current * (self._max - current)
+                self.output('%d/%d (%.2f%%) Estimated termination: %s' % \
+                (current, self._max, (100.0 * current / self._max), 
+                 DateTime(time.time() + seconds_to_go).strftime('%Y/%m/%d %H:%M:%Sh')))
+
+    def output(self, text):
+        print >>self.fp, '%s: %s' % (self._ident, text)
+
+
+class ZLogHandler(StdoutHandler):
+    """ Use Zope logger"""
+
+    implements(IProgressHandler)
+
+    def output(self, text):
+        LOG.info(text)
+
+
+class FilelogHandler(StdoutHandler):
+    """ Use a custom file for logging """
+
+    implements(IProgressHandler)
+
+    def __init__(self, filename, steps=100):
+        StdoutHandler.__init__(self, steps)
+        self.filename = filename
+
+    def output(self, text):
+        open(self.filename, 'a').write(text + '\n')