1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# Copyright (C) 2005 Aaron Bentley
# <aaron.bentley@utoronto.ca>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import sys
class Progress(object):
def __init__(self, units, current, total=None):
self.units = units
self.current = current
self.total = total
self.percent = None
if self.total is not None:
self.percent = 100.0 * current / total
def __str__(self):
if self.total is not None:
return "%i of %i %s %.1f%%" % (self.current, self.total, self.units,
self.percent)
else:
return "%i %s" (self.current, self.units)
def progress_bar(progress):
fmt = " %i of %i %s (%.1f%%)"
f = fmt % (progress.total, progress.total, progress.units, 100.0)
max = len(f)
cols = 77 - max
markers = int (float(cols) * progress.current / progress.total)
txt = fmt % (progress.current, progress.total, progress.units,
progress.percent)
sys.stderr.write("\r[%s%s]%s" % ('='*markers, ' '*(cols-markers), txt))
def clear_progress_bar():
sys.stderr.write('\r%s\r' % (' '*79))
def spinner_str(progress, show_text=False):
"""
Produces the string for a textual "spinner" progress indicator
:param progress: an object represinting current progress
:param show_text: If true, show progress text as well
:return: The spinner string
>>> spinner_str(Progress("baloons", 0))
'|'
>>> spinner_str(Progress("baloons", 5))
'/'
>>> spinner_str(Progress("baloons", 6), show_text=True)
'- 6 baloons'
"""
positions = ('|', '/', '-', '\\')
text = positions[progress.current % 4]
if show_text:
text+=" %i %s" % (progress.current, progress.units)
return text
def spinner(progress, show_text=False, output=sys.stderr):
"""
Update a spinner progress indicator on an output
:param progress: The progress to display
:param show_text: If true, show text as well as spinner
:param output: The output to write to
>>> spinner(Progress("baloons", 6), show_text=True, output=sys.stdout)
\r- 6 baloons
"""
output.write('\r%s' % spinner_str(progress, show_text))
def run_tests():
import doctest
result = doctest.testmod()
if result[1] > 0:
if result[0] == 0:
print "All tests passed"
else:
print "No tests to run"
if __name__ == "__main__":
run_tests()
|