annotate SMART/Java/Python/misc/UnlimitedProgress.py @ 18:94ab73e8a190

Uploaded

#
# Copyright INRA-URGI 2009-2010
# 
# This software is governed by the CeCILL license under French law and
# abiding by the rules of distribution of free software. You can use,
# modify and/ or redistribute the software under the terms of the CeCILL
# license as circulated by CEA, CNRS and INRIA at the following URL
# "http://www.cecill.info".
# 
# As a counterpart to the access to the source code and rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty and the software's author, the holder of the
# economic rights, and the successive licensors have only limited
# liability.
# 
# In this respect, the user's attention is drawn to the risks associated
# with loading, using, modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean that it is complicated to manipulate, and that also
# therefore means that it is reserved for developers and experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and, more generally, to use and operate it in the
# same conditions as regards security.
# 
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license and that you accept its terms.
#
import sys
import time

class UnlimitedProgress(object):
    """Show the progress of a process when no upper bound is known"""

    def __init__(self, step = 1000, message = "Progress", verbosity = 0):
        self.step           = step
        self.progress       = 0
        self.message        = message
        self.verbosity      = verbosity
        self.maxMessageSize = 50
        self.startTime      = time.time()
        self.elapsed        = 0
        if len(self.message) > self.maxMessageSize:
            self.message = self.message[0:self.maxMessageSize-3] + "..."
        self.show()


    def inc(self):
        self.progress += 1
        self.show()
        
        
    def getPrintableElapsedTime(self, time):
        timeHou = int(time) / 3600
        timeMin = int(time) / 60 - 60 * timeHou
        timeSec = int(time) % 60
        if timeHou > 0:
            return "%3dh %2dm" % (timeHou, timeMin)
        if timeMin > 0:
            return "%2dm %2ds" % (timeMin, timeSec)
        return "%2ds" % (timeSec)


    def show(self):
        if self.verbosity <= 0:
            return
        elapsed = int(time.time() - self.startTime)
        if (self.progress % self.step == 0) or (elapsed > self.elapsed + 10):
            self.elapsed = elapsed            
            string = "%s %d -- time spent: %s\r" % (self.message, self.progress, self.getPrintableElapsedTime(elapsed))
            sys.stdout.write(string)
            sys.stdout.flush()


    def done(self):
        if self.verbosity > 0:
            elapsed = time.time() - self.startTime
            string = "%s %d -- time spent: %s\r" % (self.message, self.progress, self.getPrintableElapsedTime(elapsed))
            print string