annotate SMART/Java/Python/misc/Progress.py @ 56:97aa2e42bfdf

Uploaded
author m-zytnicki
date Wed, 05 Feb 2014 11:51:11 -0500
parents 769e306b7933
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
1 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
2 # Copyright INRA-URGI 2009-2010
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
3 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
4 # This software is governed by the CeCILL license under French law and
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
5 # abiding by the rules of distribution of free software. You can use,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
6 # modify and/ or redistribute the software under the terms of the CeCILL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
7 # license as circulated by CEA, CNRS and INRIA at the following URL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
8 # "http://www.cecill.info".
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
9 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
10 # As a counterpart to the access to the source code and rights to copy,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
11 # modify and redistribute granted by the license, users are provided only
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
12 # with a limited warranty and the software's author, the holder of the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
13 # economic rights, and the successive licensors have only limited
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
14 # liability.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
15 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
16 # In this respect, the user's attention is drawn to the risks associated
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
17 # with loading, using, modifying and/or developing or reproducing the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
18 # software by the user in light of its specific status of free software,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
19 # that may mean that it is complicated to manipulate, and that also
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
20 # therefore means that it is reserved for developers and experienced
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
21 # professionals having in-depth computer knowledge. Users are therefore
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
22 # encouraged to load and test the software's suitability as regards their
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
23 # requirements in conditions enabling the security of their systems and/or
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
24 # data to be ensured and, more generally, to use and operate it in the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
25 # same conditions as regards security.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
26 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
27 # The fact that you are presently reading this means that you have had
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
28 # knowledge of the CeCILL license and that you accept its terms.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
29 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
30 import sys
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
31 import time
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
32
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
33 class Progress(object):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
34 """Show the progress of a process"""
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
35
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
36 def __init__(self, aim, message = "Progress", verbosity = 0):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
37 self.aim = aim
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
38 self.progress = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
39 self.message = message
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
40 self.length = -1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
41 self.verbosity = verbosity
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
42 self.maxMessageSize = 50
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
43 self.barSize = 80
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
44 self.startTime = time.time()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
45 self.elapsed = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
46 if len(self.message) > self.maxMessageSize:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
47 self.message = self.message[0:self.maxMessageSize-3] + "..."
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
48 self.show()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
49
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
50
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
51 def inc(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
52 self.progress += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
53 self.show()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
54
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
55
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
56 def getPrintableElapsedTime(self, time):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
57 timeHou = int(time) / 3600
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
58 timeMin = int(time) / 60 - 60 * timeHou
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
59 timeSec = int(time) % 60
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60 if timeHou > 0:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
61 return "%3dh %2dm" % (timeHou, timeMin)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
62 if timeMin > 0:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
63 return "%2dm %2ds" % (timeMin, timeSec)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
64 return "%2ds " % (timeSec)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
65
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
66
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
67 def show(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
68 if self.verbosity <= 0:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
69 return
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
70 if self.aim == 0:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
71 return
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
72 messageSize = len(self.message)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
73 length = int(self.progress / float(self.aim) * self.barSize)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
74 elapsed = int(time.time() - self.startTime)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
75 if (length > self.length) or (elapsed > self.elapsed + 10):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76 self.length = length
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
77 self.elapsed = elapsed
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
78 string = "%s%s[%s%s] %d/%d" % (self.message, " " * max(0, self.maxMessageSize - messageSize), "=" * self.length, " " * (self.barSize - self.length), self.progress, self.aim)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
79 if elapsed > 5:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
80 done = float(self.progress) / self.aim
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
81 total = elapsed / done
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
82 remaining = total - elapsed
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
83 string += " ETA: %s " % (self.getPrintableElapsedTime(remaining))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
84 string += "\r"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
85 sys.stdout.write(string)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
86 sys.stdout.flush()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
87
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
88
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
89 def done(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
90 if self.verbosity > 0:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
91 messageSize = len(self.message)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
92 elapsed = time.time() - self.startTime
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93 print "%s%s[%s] %d completed in %s " % (self.message, " " * max(0, self.maxMessageSize - messageSize), "=" * self.barSize, self.aim, self.getPrintableElapsedTime(elapsed))