« back to all changes in this revision
Viewing changes to bzrlib/progress.py
- browse files at revision 950
- compare with another revision
- download diff
- download tarball
- view history from revision 950
- Committer: Martin Pool
- Date: 2005-07-21 11:57:44 UTC
- Revision ID: mbp@sourcefrog.net-20050721115744-e450602f7f11efa5
- fix up self reference in msvc lock object
- files removed:
- bzrlib/selftest/testinv.py
- files modified:
- README
added
removed
bzrlib/progress.py
30
30
# indicators, preferably without needing to adjust all code that
31
31
# potentially calls them.
32
32
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
34
# 5/second.
34
35
35
36
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
37
# when the rate is unpredictable
38
39
39
40
import sys
40
41
import time
41
import os
42
42
43
43
44
44
def _width():
49
49
TODO: Is there anything that gets a better update when the window
50
50
is resized while the program is running?
51
51
"""
52
import os
52
53
try:
53
54
return int(os.environ['COLUMNS'])
54
55
except (IndexError, KeyError, ValueError):
60
61
return False
61
62
if not f.isatty():
62
63
return False
64
import os
63
65
if os.environ.get('TERM') == 'dumb':
64
66
# e.g. emacs compile window
65
67
return False
67
69
68
70
69
71
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):
72
class ProgressBar(object):
125
73
"""Progress bar display object.
126
74
127
75
Several options are available to control the display. These can
144
92
SPIN_CHARS = r'/-\|'
145
93
MIN_PAUSE = 0.1 # seconds
146
94
147
148
def __init__(self, **kwargs):
149
_BaseProgressBar.__init__(self, **kwargs)
95
start_time = None
96
last_update = None
97
98
def __init__(self,
99
to_file=sys.stderr,
100
show_pct=False,
101
show_spinner=False,
102
show_eta=True,
103
show_bar=True,
104
show_count=True):
105
object.__init__(self)
106
self.to_file = to_file
107
self.suppressed = not _supports_progress(self.to_file)
150
108
self.spin_pos = 0
109
110
self.last_msg = None
111
self.last_cnt = None
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
118
151
119
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
120
170
121
171
122
def tick(self):
175
126
176
127
def update(self, msg, current_cnt=None, total_cnt=None):
177
128
"""Update and redraw progress bar."""
129
if self.suppressed:
130
return
178
131
179
132
# save these for the tick() function
180
133
self.last_msg = msg
181
134
self.last_cnt = current_cnt
182
135
self.last_total = total_cnt
183
136
184
if self.throttle():
185
return
137
now = time.time()
138
if self.start_time is None:
139
self.start_time = now
140
else:
141
interval = now - self.last_update
142
if interval > 0 and interval < self.MIN_PAUSE:
143
return
144
145
self.last_update = now
186
146
187
147
if total_cnt:
188
148
assert current_cnt <= total_cnt
249
209
#self.to_file.flush()
250
210
251
211
252
def clear(self):
212
def clear(self):
213
if self.suppressed:
214
return
215
253
216
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
254
217
#self.to_file.flush()
255
218
300
263
301
264
302
265
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:'
266
from time import sleep
315
267
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
316
268
for i in range(100):
317
269
pb.update('Elephanten', i, 99)
319
271
sleep(2)
320
272
pb.clear()
321
273
sleep(1)
322
323
274
print 'done!'
324
275
325
276
if __name__ == "__main__":
Loggerhead is a web-based interface for Breezy
Version: 2.0.1