« back to all changes in this revision
Viewing changes to bzrlib/progress.py
- browse files at revision 964
- compare with another revision
- download diff
- download tarball
- view history from revision 964
- Committer: Martin Pool
- Date: 2005-07-22 23:06:25 UTC
- Revision ID: mbp@sourcefrog.net-20050722230625-c634e162df1060c7
- show progress on dumb terminals by printing dots
- files modified:
- bzrlib/progress.py
added
removed
bzrlib/progress.py
38
38
39
39
import sys
40
40
import time
41
import os
41
42
42
43
43
44
def _width():
48
49
TODO: Is there anything that gets a better update when the window
49
50
is resized while the program is running?
50
51
"""
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
64
63
if os.environ.get('TERM') == 'dumb':
65
64
# e.g. emacs compile window
66
65
return False
68
67
69
68
70
69
71
class ProgressBar(object):
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
125
"""Progress bar display object.
73
126
74
127
Several options are available to control the display. These can
91
144
SPIN_CHARS = r'/-\|'
92
145
MIN_PAUSE = 0.1 # seconds
93
146
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)
147
148
def __init__(self, **kwargs):
149
_BaseProgressBar.__init__(self, **kwargs)
107
150
self.spin_pos = 0
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
118
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
119
169
120
170
121
171
def tick(self):
125
175
126
176
def update(self, msg, current_cnt=None, total_cnt=None):
127
177
"""Update and redraw progress bar."""
128
if self.suppressed:
129
return
130
178
131
179
# save these for the tick() function
132
180
self.last_msg = msg
133
181
self.last_cnt = current_cnt
134
182
self.last_total = total_cnt
135
183
136
now = time.time()
137
if self.start_time is None:
138
self.start_time = now
139
else:
140
interval = now - self.last_update
141
if interval > 0 and interval < self.MIN_PAUSE:
142
return
143
144
self.last_update = now
184
if self.throttle():
185
return
145
186
146
187
if total_cnt:
147
188
assert current_cnt <= total_cnt
208
249
#self.to_file.flush()
209
250
210
251
211
def clear(self):
212
if self.suppressed:
213
return
214
252
def clear(self):
215
253
self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
216
254
#self.to_file.flush()
217
255
262
300
263
301
264
302
def demo():
265
from time import sleep
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
315
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
267
316
for i in range(100):
268
317
pb.update('Elephanten', i, 99)
270
319
sleep(2)
271
320
pb.clear()
272
321
sleep(1)
322
273
323
print 'done!'
274
324
275
325
if __name__ == "__main__":
Loggerhead is a web-based interface for Breezy
Version: 2.0.1