1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 """Text progressbar library for python.
23
24 This library provides a text mode progressbar. This is tipically used
25 to display the progress of a long running operation, providing a
26 visual clue that processing is underway.
27
28 The ProgressBar class manages the progress, and the format of the line
29 is given by a number of widgets. A widget is an object that may
30 display diferently depending on the state of the progress. There are
31 three types of widget:
32 - a string, which always shows itself;
33 - a ProgressBarWidget, which may return a diferent value every time
34 it's update method is called; and
35 - a ProgressBarWidgetHFill, which is like ProgressBarWidget, except it
36 expands to fill the remaining width of the line.
37
38 The progressbar module is very easy to use, yet very powerful. And
39 automatically supports features like auto-resizing when available.
40 """
41
42 __author__ = "Nilton Volpato"
43 __author_email__ = "first-name dot last-name @ gmail.com"
44 __date__ = "2006-05-07"
45 __version__ = "2.2"
46
47
48
49
50
51
52
53
54
55
56
57 import sys, time
58 from array import array
59 try:
60 from fcntl import ioctl
61 import termios
62 except ImportError:
63 pass
64 import signal
65
82
102
103
104 -class ETA(ProgressBarWidget):
105 "Widget for the Estimated Time of Arrival"
109 if pbar.currval == 0:
110 return 'ETA: --:--:--'
111 elif pbar.finished:
112 return 'Time: %s' % self.format_time(pbar.seconds_elapsed)
113 else:
114 elapsed = pbar.seconds_elapsed
115 eta = elapsed * pbar.maxval / pbar.currval - elapsed
116 return 'ETA: %s' % self.format_time(eta)
117
119 "Widget for showing the transfer speed (useful for file transfers)."
121 self.fmt = '%6.2f %s'
122 self.units = ['B','K','M','G','T','P']
124 if pbar.seconds_elapsed < 2e-6:
125 bps = 0.0
126 else:
127 bps = float(pbar.currval) / pbar.seconds_elapsed
128 spd = bps
129 for u in self.units:
130 if spd < 1000:
131 break
132 spd /= 1000
133 return self.fmt % (spd, u+'/s')
134
136 "A rotating marker for filling the bar of progress."
138 self.markers = markers
139 self.curmark = -1
141 if pbar.finished:
142 return self.markers[0]
143 self.curmark = (self.curmark + 1)%len(self.markers)
144 return self.markers[self.curmark]
145
147 "Just the percentage done."
150
151 -class Bar(ProgressBarWidgetHFill):
152 "The bar of progress. It will strech to fill the line."
153 - def __init__(self, marker='#', left='|', right='|'):
154 self.marker = marker
155 self.left = left
156 self.right = right
162 - def update(self, pbar, width):
163 percent = pbar.percentage()
164 cwidth = width - len(self.left) - len(self.right)
165 marked_width = int(percent * cwidth / 100)
166 m = self._format_marker(pbar)
167 bar = (self.left + (m*marked_width).ljust(cwidth) + self.right)
168 return bar
169
171 "The reverse bar of progress, or bar of regress. :)"
172 - def update(self, pbar, width):
173 percent = pbar.percentage()
174 cwidth = width - len(self.left) - len(self.right)
175 marked_width = int(percent * cwidth / 100)
176 m = self._format_marker(pbar)
177 bar = (self.left + (m*marked_width).rjust(cwidth) + self.right)
178 return bar
179
180 default_widgets = [Percentage(), ' ', Bar()]
182 """This is the ProgressBar class, it updates and prints the bar.
183
184 The term_width parameter may be an integer. Or None, in which case
185 it will try to guess it, if it fails it will default to 80 columns.
186
187 The simple use is like this:
188 >>> pbar = ProgressBar().start()
189 >>> for i in xrange(100):
190 ... # do something
191 ... pbar.update(i+1)
192 ...
193 >>> pbar.finish()
194
195 But anything you want to do is possible (well, almost anything).
196 You can supply different widgets of any type in any order. And you
197 can even write your own widgets! There are many widgets already
198 shipped and you should experiment with them.
199
200 When implementing a widget update method you may access any
201 attribute or function of the ProgressBar object calling the
202 widget's update method. The most important attributes you would
203 like to access are:
204 - currval: current value of the progress, 0 <= currval <= maxval
205 - maxval: maximum (and final) value of the progress
206 - finished: True if the bar is have finished (reached 100%), False o/w
207 - start_time: first time update() method of ProgressBar was called
208 - seconds_elapsed: seconds elapsed since start_time
209 - percentage(): percentage of the progress (this is a method)
210 """
213 assert maxval > 0
214 self.maxval = maxval
215 self.widgets = widgets
216 self.fd = fd
217 self.signal_set = False
218 if term_width is None:
219 try:
220 self.handle_resize(None,None)
221 signal.signal(signal.SIGWINCH, self.handle_resize)
222 self.signal_set = True
223 except:
224 self.term_width = 79
225 else:
226 self.term_width = term_width
227
228 self.currval = 0
229 self.finished = False
230 self.prev_percentage = -1
231 self.start_time = None
232 self.seconds_elapsed = 0
233 self._line_sep_char = '\r'
234
236 h,w=array('h', ioctl(self.fd,termios.TIOCGWINSZ,'\0'*8))[:2]
237 self.term_width = w
238
240 "Returns the percentage of the progress."
241 return self.currval*100.0 / self.maxval
242
263
266
268 return int(self.percentage()) != int(self.prev_percentage)
269
271 "Updates the progress bar to a new value."
272 assert 0 <= value <= self.maxval
273 self.currval = value
274 if not self._need_update() or self.finished:
275 return
276 if not self.start_time:
277 self.start_time = time.time()
278 self.seconds_elapsed = time.time() - self.start_time
279 self.prev_percentage = self.percentage()
280 if value != self.maxval:
281 self.fd.write(self._format_line() + self._line_sep_char)
282 else:
283 self.finished = True
284 self.fd.write(self._format_line() + '\n')
285
287 self._line_sep_char = '\n'
288 self.update(value)
289 self.fd.write('\n')
290
292 self._line_sep_char = '\r'
293 self.update(value)
294
296 """Start measuring time, and prints the bar at 0%.
297
298 It returns self so you can use it like this:
299 >>> pbar = ProgressBar().start()
300 >>> for i in xrange(100):
301 ... # do something
302 ... pbar.update(i+1)
303 ...
304 >>> pbar.finish()
305 """
306 self.update(0)
307 return self
308
310 """Used to tell the progress is finished."""
311 self.update(self.maxval)
312 if self.signal_set:
313 signal.signal(signal.SIGWINCH, signal.SIG_DFL)
314
315
316
317
318
319
320 if __name__=='__main__':
321 import os
322
332
334 class CrazyFileTransferSpeed(FileTransferSpeed):
335 "It's bigger between 45 and 80 percent"
336 def update(self, pbar):
337 if 45 < pbar.percentage() < 80:
338 return 'Bigger Now ' + FileTransferSpeed.update(self,pbar)
339 else:
340 return FileTransferSpeed.update(self,pbar)
341
342 widgets = [CrazyFileTransferSpeed(),' <<<', Bar(), '>>> ', Percentage(),' ', ETA()]
343 pbar = ProgressBar(widgets=widgets, maxval=10000000)
344
345 pbar.start()
346 for i in range(2000000):
347
348 pbar.update(5*i+1)
349 pbar.finish()
350 print
351
360
362 widgets = ['Test: ', Percentage(), ' ',
363 Bar(marker='0',left='[',right=']'),
364 ' ', ETA(), ' ', FileTransferSpeed()]
365 pbar = ProgressBar(widgets=widgets, maxval=500)
366 pbar.start()
367 for i in range(100,500+1,50):
368 time.sleep(0.2)
369 pbar.update(i)
370 pbar.finish()
371 print
372
373
374 example1()
375 example2()
376 example3()
377 example4()
378