30
30
# indicators, preferably without needing to adjust all code that
31
31
# potentially calls them.
33
# TODO: If not on a tty perhaps just print '......' for the benefit of IDEs, etc
33
# TODO: Perhaps don't write updates faster than a certain rate, say
35
36
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
37
# when the rate is unpredictable
50
49
TODO: Is there anything that gets a better update when the window
51
50
is resized while the program is running?
54
54
return int(os.environ['COLUMNS'])
55
55
except (IndexError, KeyError, ValueError):
71
def ProgressBar(to_file=sys.stderr, **kwargs):
72
"""Abstract factory"""
73
if _supports_progress(to_file):
74
return TTYProgressBar(to_file=to_file, **kwargs)
76
return DotsProgressBar(to_file=to_file, **kwargs)
79
class _BaseProgressBar(object):
88
self.to_file = to_file
92
self.last_total = None
93
self.show_pct = show_pct
94
self.show_spinner = show_spinner
95
self.show_eta = show_eta
96
self.show_bar = show_bar
97
self.show_count = show_count
101
class DummyProgress(_BaseProgressBar):
102
"""Progress-bar standin that does nothing.
104
This can be used as the default argument for methods that
105
take an optional progress indicator."""
109
def update(self, msg=None, current=None, total=None):
116
class DotsProgressBar(_BaseProgressBar):
117
def __init__(self, **kwargs):
118
_BaseProgressBar.__init__(self, **kwargs)
125
def update(self, msg=None, current_cnt=None, total_cnt=None):
126
if msg and msg != self.last_msg:
128
self.to_file.write('\n')
130
self.to_file.write(msg + ': ')
133
self.to_file.write('.')
137
self.to_file.write('\n')
140
class TTYProgressBar(_BaseProgressBar):
72
class ProgressBar(object):
141
73
"""Progress bar display object.
143
75
Several options are available to control the display. These can
160
92
SPIN_CHARS = r'/-\|'
161
93
MIN_PAUSE = 0.1 # seconds
164
def __init__(self, **kwargs):
165
_BaseProgressBar.__init__(self, **kwargs)
105
object.__init__(self)
106
self.to_file = to_file
107
self.suppressed = not _supports_progress(self.to_file)
166
108
self.spin_pos = 0
112
self.last_total = None
113
self.show_pct = show_pct
114
self.show_spinner = show_spinner
115
self.show_eta = show_eta
116
self.show_bar = show_bar
117
self.show_count = show_count
167
119
self.width = _width()
168
self.start_time = None
169
self.last_update = None
170
self.last_updates = deque()
174
"""Return True if the bar was updated too recently"""
176
if self.start_time is None:
177
self.start_time = self.last_update = now
180
interval = now - self.last_update
181
if interval > 0 and interval < self.MIN_PAUSE:
184
self.last_updates.append(now - self.last_update)
185
self.last_update = now
194
127
def update(self, msg, current_cnt=None, total_cnt=None):
195
128
"""Update and redraw progress bar."""
200
if current_cnt > total_cnt:
201
total_cnt = current_cnt
203
132
# save these for the tick() function
204
133
self.last_msg = msg
205
134
self.last_cnt = current_cnt
206
135
self.last_total = total_cnt
138
if self.start_time is None:
139
self.start_time = now
141
interval = now - self.last_update
142
if interval > 0 and interval < self.MIN_PAUSE:
145
self.last_update = now
148
assert current_cnt <= total_cnt
150
assert current_cnt >= 0
211
152
if self.show_eta and self.start_time and total_cnt:
212
eta = get_eta(self.start_time, current_cnt, total_cnt,
213
last_updates = self.last_updates)
153
eta = get_eta(self.start_time, current_cnt, total_cnt)
214
154
eta_str = " " + str_tdelta(eta)
287
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
230
def get_eta(start_time, current, total, enough_samples=3):
288
231
if start_time is None:
307
250
assert total_duration >= elapsed
309
if last_updates and len(last_updates) >= n_recent:
310
while len(last_updates) > n_recent:
311
last_updates.popleft()
312
avg = sum(last_updates) / float(len(last_updates))
313
time_left = avg * (total - current)
315
old_time_left = total_duration - elapsed
317
# We could return the average, or some other value here
318
return (time_left + old_time_left) / 2
320
252
return total_duration - elapsed
336
print 'dumb-terminal test:'
337
pb = DotsProgressBar()
339
pb.update('Leoparden', i, 99)
345
print 'smart-terminal test:'
266
from time import sleep
346
267
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
347
268
for i in range(100):
348
269
pb.update('Elephanten', i, 99)
added
removed
bzrlib/progress.py
