16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
Simple text-mode progress indicator.
22
Everyone loves ascii art!
19
"""Simple text-mode progress indicator.
24
21
To display an indicator, create a ProgressBar object. Call it,
25
22
passing Progress objects indicating the current state. When done,
29
26
not to clutter log files.
32
# TODO: remove functions in favour of keeping everything in one class
34
29
# TODO: should be a global option e.g. --silent that disables progress
35
30
# indicators, preferably without needing to adjust all code that
36
31
# potentially calls them.
38
# TODO: Perhaps don't write updates faster than a certain rate, say
33
# TODO: If not on a tty perhaps just print '......' for the benefit of IDEs, etc
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
# when the rate is unpredictable
47
"""Return estimated terminal width.
49
TODO: Do something smart on Windows?
51
TODO: Is there anything that gets a better update when the window
52
is resized while the program is running?
56
return int(os.environ['COLUMNS'])
57
except (IndexError, KeyError, ValueError):
42
from collections import deque
61
45
def _supports_progress(f):
62
return hasattr(f, 'isatty') and f.isatty()
66
class ProgressBar(object):
46
if not hasattr(f, 'isatty'):
50
if os.environ.get('TERM') == 'dumb':
51
# e.g. emacs compile window
57
def ProgressBar(to_file=sys.stderr, **kwargs):
58
"""Abstract factory"""
59
if _supports_progress(to_file):
60
return TTYProgressBar(to_file=to_file, **kwargs)
62
return DotsProgressBar(to_file=to_file, **kwargs)
65
class _BaseProgressBar(object):
74
self.to_file = to_file
78
self.last_total = None
79
self.show_pct = show_pct
80
self.show_spinner = show_spinner
81
self.show_eta = show_eta
82
self.show_bar = show_bar
83
self.show_count = show_count
87
class DummyProgress(_BaseProgressBar):
88
"""Progress-bar standin that does nothing.
90
This can be used as the default argument for methods that
91
take an optional progress indicator."""
95
def update(self, msg=None, current=None, total=None):
102
class DotsProgressBar(_BaseProgressBar):
103
def __init__(self, **kwargs):
104
_BaseProgressBar.__init__(self, **kwargs)
111
def update(self, msg=None, current_cnt=None, total_cnt=None):
112
if msg and msg != self.last_msg:
114
self.to_file.write('\n')
116
self.to_file.write(msg + ': ')
119
self.to_file.write('.')
123
self.to_file.write('\n')
126
class TTYProgressBar(_BaseProgressBar):
67
127
"""Progress bar display object.
69
129
Several options are available to control the display. These can
86
146
SPIN_CHARS = r'/-\|'
87
147
MIN_PAUSE = 0.1 # seconds
100
self.to_file = to_file
101
self.suppressed = not _supports_progress(self.to_file)
150
def __init__(self, **kwargs):
151
from bzrlib.osutils import terminal_width
152
_BaseProgressBar.__init__(self, **kwargs)
102
153
self.spin_pos = 0
106
self.last_total = None
107
self.show_pct = show_pct
108
self.show_spinner = show_spinner
109
self.show_eta = show_eta
110
self.show_bar = show_bar
111
self.show_count = show_count
154
self.width = terminal_width()
155
self.start_time = None
156
self.last_update = None
157
self.last_updates = deque()
161
"""Return True if the bar was updated too recently"""
163
if self.start_time is None:
164
self.start_time = self.last_update = now
167
interval = now - self.last_update
168
if interval > 0 and interval < self.MIN_PAUSE:
171
self.last_updates.append(now - self.last_update)
172
self.last_update = now
115
177
self.update(self.last_msg, self.last_cnt, self.last_total)
119
181
def update(self, msg, current_cnt=None, total_cnt=None):
120
182
"""Update and redraw progress bar."""
187
if current_cnt > total_cnt:
188
total_cnt = current_cnt
124
190
# save these for the tick() function
125
191
self.last_msg = msg
126
192
self.last_cnt = current_cnt
127
193
self.last_total = total_cnt
130
if self.start_time is None:
131
self.start_time = now
133
interval = now - self.last_update
134
if interval > 0 and interval < self.MIN_PAUSE:
137
self.last_update = now
142
assert current_cnt <= total_cnt
144
assert current_cnt >= 0
146
198
if self.show_eta and self.start_time and total_cnt:
147
eta = get_eta(self.start_time, current_cnt, total_cnt)
199
eta = get_eta(self.start_time, current_cnt, total_cnt,
200
last_updates = self.last_updates)
148
201
eta_str = " " + str_tdelta(eta)
244
294
assert total_duration >= elapsed
296
if last_updates and len(last_updates) >= n_recent:
297
while len(last_updates) > n_recent:
298
last_updates.popleft()
299
avg = sum(last_updates) / float(len(last_updates))
300
time_left = avg * (total - current)
302
old_time_left = total_duration - elapsed
304
# We could return the average, or some other value here
305
return (time_left + old_time_left) / 2
246
307
return total_duration - elapsed
260
from time import sleep
323
print 'dumb-terminal test:'
324
pb = DotsProgressBar()
326
pb.update('Leoparden', i, 99)
332
print 'smart-terminal test:'
261
333
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
262
334
for i in range(100):
263
335
pb.update('Elephanten', i, 99)
added
removed
bzrlib/progress.py
