58
61
def _supports_progress(f):
59
if not hasattr(f, 'isatty'):
63
if os.environ.get('TERM') == 'dumb':
64
# e.g. emacs compile window
70
def ProgressBar(to_file=sys.stderr, **kwargs):
71
"""Abstract factory"""
72
if _supports_progress(to_file):
73
return TTYProgressBar(to_file=to_file, **kwargs)
75
return DotsProgressBar(to_file=to_file, **kwargs)
78
class _BaseProgressBar(object):
62
return hasattr(f, 'isatty') and f.isatty()
66
class Progress(object):
67
"""Description of progress through a task.
69
Basically just a fancy tuple holding:
72
noun string describing what is being traversed, e.g.
76
how many objects have been processed so far
79
total number of objects to process, if known.
82
def __init__(self, units, current, total=None):
84
self.current = current
87
def _get_percent(self):
88
if self.total is not None and self.current is not None:
89
return 100.0 * self.current / self.total
91
percent = property(_get_percent)
94
if self.total is not None:
95
return "%i of %i %s %.1f%%" % (self.current, self.total, self.units,
98
return "%i %s" (self.current, self.units)
102
class ProgressBar(object):
103
def __init__(self, to_file=sys.stderr):
86
104
object.__init__(self)
87
106
self.to_file = to_file
91
self.last_total = None
92
self.show_pct = show_pct
93
self.show_spinner = show_spinner
94
self.show_eta = show_eta
95
self.show_bar = show_bar
96
self.show_count = show_count
100
class DotsProgressBar(_BaseProgressBar):
101
def __init__(self, **kwargs):
102
_BaseProgressBar.__init__(self, **kwargs)
109
def update(self, msg=None, current_cnt=None, total_cnt=None):
110
if msg and msg != self.last_msg:
112
self.to_file.write('\n')
114
self.to_file.write(msg + ': ')
117
self.to_file.write('.')
107
self.suppressed = not _supports_progress(self.to_file)
110
def __call__(self, progress):
111
if self.start is None:
112
self.start = datetime.datetime.now()
113
if not self.suppressed:
114
draw_progress_bar(progress, start_time=self.start,
115
to_file=self.to_file)
121
self.to_file.write('\n')
124
class TTYProgressBar(_BaseProgressBar):
125
"""Progress bar display object.
127
Several options are available to control the display. These can
128
be passed as parameters to the constructor or assigned at any time:
131
Show percentage complete.
133
Show rotating baton. This ticks over on every update even
134
if the values don't change.
136
Show predicted time-to-completion.
140
Show numerical counts.
142
The output file should be in line-buffered or unbuffered mode.
145
MIN_PAUSE = 0.1 # seconds
148
def __init__(self, **kwargs):
149
_BaseProgressBar.__init__(self, **kwargs)
151
self.width = _width()
152
self.start_time = None
153
self.last_update = None
157
"""Return True if the bar was updated too recently"""
159
if self.start_time is None:
160
self.start_time = self.last_update = now
163
interval = now - self.last_update
164
if interval > 0 and interval < self.MIN_PAUSE:
167
self.last_update = now
172
self.update(self.last_msg, self.last_cnt, self.last_total)
176
def update(self, msg, current_cnt=None, total_cnt=None):
177
"""Update and redraw progress bar."""
179
# save these for the tick() function
181
self.last_cnt = current_cnt
182
self.last_total = total_cnt
188
assert current_cnt <= total_cnt
190
assert current_cnt >= 0
192
if self.show_eta and self.start_time and total_cnt:
193
eta = get_eta(self.start_time, current_cnt, total_cnt)
194
eta_str = " " + str_tdelta(eta)
198
if self.show_spinner:
199
spin_str = self.SPIN_CHARS[self.spin_pos % 4] + ' '
203
# always update this; it's also used for the bar
206
if self.show_pct and total_cnt and current_cnt:
207
pct = 100.0 * current_cnt / total_cnt
208
pct_str = ' (%5.1f%%)' % pct
212
if not self.show_count:
214
elif current_cnt is None:
216
elif total_cnt is None:
217
count_str = ' %i' % (current_cnt)
219
# make both fields the same size
220
t = '%i' % (total_cnt)
221
c = '%*i' % (len(t), current_cnt)
222
count_str = ' ' + c + '/' + t
225
# progress bar, if present, soaks up all remaining space
226
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
227
- len(eta_str) - len(count_str) - 3
230
# number of markers highlighted in bar
231
markers = int(round(float(cols) * current_cnt / total_cnt))
232
bar_str = '[' + ('=' * markers).ljust(cols) + '] '
234
# don't know total, so can't show completion.
235
# so just show an expanded spinning thingy
236
m = self.spin_pos % cols
237
ms = (' ' * m + '*').ljust(cols)
239
bar_str = '[' + ms + '] '
245
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
247
assert len(m) < self.width
248
self.to_file.write('\r' + m.ljust(self.width - 1))
249
#self.to_file.flush()
253
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
254
#self.to_file.flush()
118
if not self.suppressed:
119
clear_progress_bar(self.to_file)
123
def divide_timedelta(delt, divisor):
124
"""Divides a timedelta object"""
125
return datetime.timedelta(float(delt.days)/divisor,
126
float(delt.seconds)/divisor,
127
float(delt.microseconds)/divisor)
258
129
def str_tdelta(delt):
261
delt = int(round(delt))
262
return '%d:%02d:%02d' % (delt/3600,
267
def get_eta(start_time, current, total, enough_samples=3):
268
if start_time is None:
274
if current < enough_samples:
280
elapsed = time.time() - start_time
282
if elapsed < 2.0: # not enough time to estimate
285
total_duration = float(elapsed) * float(total) / float(current)
287
assert total_duration >= elapsed
289
return total_duration - elapsed
132
return str(datetime.timedelta(delt.days, delt.seconds))
135
def get_eta(start_time, progress, enough_samples=20):
136
if start_time is None or progress.current == 0:
138
elif progress.current < enough_samples:
140
elapsed = datetime.datetime.now() - start_time
141
total_duration = divide_timedelta((elapsed) * long(progress.total),
143
if elapsed < total_duration:
144
eta = total_duration - elapsed
146
eta = total_duration - total_duration
150
def draw_progress_bar(progress, start_time=None, to_file=sys.stderr):
151
eta = get_eta(start_time, progress)
152
if start_time is not None:
153
eta_str = " "+str_tdelta(eta)
157
fmt = " %i of %i %s (%.1f%%)"
158
f = fmt % (progress.total, progress.total, progress.units, 100.0)
159
cols = _width() - 3 - len(f)
160
if start_time is not None:
162
markers = int(round(float(cols) * progress.current / progress.total))
163
txt = fmt % (progress.current, progress.total, progress.units,
165
to_file.write("\r[%s%s]%s%s" % ('='*markers, ' '*(cols-markers), txt,
168
def clear_progress_bar(to_file=sys.stderr):
169
to_file.write('\r%s\r' % (' '*79))
172
def spinner_str(progress, show_text=False):
174
Produces the string for a textual "spinner" progress indicator
175
:param progress: an object represinting current progress
176
:param show_text: If true, show progress text as well
177
:return: The spinner string
179
>>> spinner_str(Progress("baloons", 0))
181
>>> spinner_str(Progress("baloons", 5))
183
>>> spinner_str(Progress("baloons", 6), show_text=True)
186
positions = ('|', '/', '-', '\\')
187
text = positions[progress.current % 4]
189
text+=" %i %s" % (progress.current, progress.units)
193
def spinner(progress, show_text=False, output=sys.stderr):
195
Update a spinner progress indicator on an output
196
:param progress: The progress to display
197
:param show_text: If true, show text as well as spinner
198
:param output: The output to write to
200
>>> spinner(Progress("baloons", 6), show_text=True, output=sys.stdout)
203
output.write('\r%s' % spinner_str(progress, show_text))
added
removed
bzrlib/progress.py
