« back to all changes in this revision
Viewing changes to bzrlib/progress.py
- browse files at revision 920
- compare with another revision
- download diff
- download tarball
- view history from revision 920
- Committer: Martin Pool
- Date: 2005-07-15 22:55:10 UTC
- Revision ID: mbp@sourcefrog.net-20050715225510-ebb2753f499f71e5
- add more test cases for weave_merge
- files removed:
- bzrlib/intset.py
- files modified:
- NEWS
added
removed
bzrlib/progress.py
26
26
not to clutter log files.
27
27
"""
28
28
29
# TODO: remove functions in favour of keeping everything in one class
30
29
31
# TODO: should be a global option e.g. --silent that disables progress
30
32
# indicators, preferably without needing to adjust all code that
31
33
# potentially calls them.
32
34
33
# TODO: If not on a tty perhaps just print '......' for the benefit of IDEs, etc
34
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
# when the rate is unpredictable
35
# TODO: Perhaps don't write updates faster than a certain rate, say
36
# 5/second.
37
37
38
38
39
39
import sys
40
40
import time
41
import os
42
41
43
42
44
43
def _width():
49
48
TODO: Is there anything that gets a better update when the window
50
49
is resized while the program is running?
51
50
"""
51
import os
52
52
try:
53
53
return int(os.environ['COLUMNS'])
54
54
except (IndexError, KeyError, ValueError):
60
60
return False
61
61
if not f.isatty():
62
62
return False
63
import os
63
64
if os.environ.get('TERM') == 'dumb':
64
65
# e.g. emacs compile window
65
66
return False
67
68
68
69
69
70
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)
74
else:
75
return DotsProgressBar(to_file=to_file, **kwargs)
76
77
78
class _BaseProgressBar(object):
79
def __init__(self,
80
to_file=sys.stderr,
81
show_pct=False,
82
show_spinner=False,
83
show_eta=True,
84
show_bar=True,
85
show_count=True):
86
object.__init__(self)
87
self.to_file = to_file
88
89
self.last_msg = None
90
self.last_cnt = None
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
97
98
99
100
class DotsProgressBar(_BaseProgressBar):
101
def __init__(self, **kwargs):
102
_BaseProgressBar.__init__(self, **kwargs)
103
self.last_msg = None
104
self.need_nl = False
105
106
def tick(self):
107
self.update()
108
109
def update(self, msg=None, current_cnt=None, total_cnt=None):
110
if msg and msg != self.last_msg:
111
if self.need_nl:
112
self.to_file.write('\n')
113
114
self.to_file.write(msg + ': ')
115
self.last_msg = msg
116
self.need_nl = True
117
self.to_file.write('.')
118
119
def clear(self):
120
if self.need_nl:
121
self.to_file.write('\n')
122
123
124
class TTYProgressBar(_BaseProgressBar):
71
class ProgressBar(object):
125
72
"""Progress bar display object.
126
73
127
74
Several options are available to control the display. These can
144
91
SPIN_CHARS = r'/-\|'
145
92
MIN_PAUSE = 0.1 # seconds
146
93
147
148
def __init__(self, **kwargs):
149
_BaseProgressBar.__init__(self, **kwargs)
94
start_time = None
95
last_update = None
96
97
def __init__(self,
98
to_file=sys.stderr,
99
show_pct=False,
100
show_spinner=False,
101
show_eta=True,
102
show_bar=True,
103
show_count=True):
104
object.__init__(self)
105
self.to_file = to_file
106
self.suppressed = not _supports_progress(self.to_file)
150
107
self.spin_pos = 0
151
self.width = _width()
152
self.start_time = None
153
self.last_update = None
154
155
156
def throttle(self):
157
"""Return True if the bar was updated too recently"""
158
now = time.time()
159
if self.start_time is None:
160
self.start_time = self.last_update = now
161
return False
162
else:
163
interval = now - self.last_update
164
if interval > 0 and interval < self.MIN_PAUSE:
165
return True
166
167
self.last_update = now
168
return False
169
108
109
self.last_msg = None
110
self.last_cnt = None
111
self.last_total = None
112
self.show_pct = show_pct
113
self.show_spinner = show_spinner
114
self.show_eta = show_eta
115
self.show_bar = show_bar
116
self.show_count = show_count
117
170
118
171
119
def tick(self):
172
120
self.update(self.last_msg, self.last_cnt, self.last_total)
175
123
176
124
def update(self, msg, current_cnt=None, total_cnt=None):
177
125
"""Update and redraw progress bar."""
126
if self.suppressed:
127
return
178
128
179
129
# save these for the tick() function
180
130
self.last_msg = msg
181
131
self.last_cnt = current_cnt
182
132
self.last_total = total_cnt
183
133
184
if self.throttle():
185
return
134
now = time.time()
135
if self.start_time is None:
136
self.start_time = now
137
else:
138
interval = now - self.last_update
139
if interval > 0 and interval < self.MIN_PAUSE:
140
return
141
142
self.last_update = now
186
143
144
width = _width()
145
187
146
if total_cnt:
188
147
assert current_cnt <= total_cnt
189
148
if current_cnt:
223
182
224
183
if self.show_bar:
225
184
# progress bar, if present, soaks up all remaining space
226
cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
185
cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
227
186
- len(eta_str) - len(count_str) - 3
228
187
229
188
if total_cnt:
244
203
245
204
m = spin_str + bar_str + msg + count_str + pct_str + eta_str
246
205
247
assert len(m) < self.width
248
self.to_file.write('\r' + m.ljust(self.width - 1))
206
assert len(m) < width
207
self.to_file.write('\r' + m.ljust(width - 1))
249
208
#self.to_file.flush()
250
209
251
210
252
def clear(self):
253
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
211
def clear(self):
212
if self.suppressed:
213
return
214
215
self.to_file.write('\r%s\r' % (' ' * (_width() - 1)))
254
216
#self.to_file.flush()
255
217
256
218
300
262
301
263
302
264
def demo():
303
sleep = time.sleep
304
305
print 'dumb-terminal test:'
306
pb = DotsProgressBar()
307
for i in range(100):
308
pb.update('Leoparden', i, 99)
309
sleep(0.1)
310
sleep(1.5)
311
pb.clear()
312
sleep(1.5)
313
314
print 'smart-terminal test:'
265
from time import sleep
315
266
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
316
267
for i in range(100):
317
268
pb.update('Elephanten', i, 99)
319
270
sleep(2)
320
271
pb.clear()
321
272
sleep(1)
322
323
273
print 'done!'
324
274
325
275
if __name__ == "__main__":
Loggerhead is a web-based interface for Breezy
Version: 2.0.1