← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

  • Committer: Martin Pool
  • Date: 2005-06-22 09:08:43 UTC
  • Revision ID: mbp@sourcefrog.net-20050622090843-78fe9c62da9ed167
- add john's changeset plugin

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
16
16
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
 
18
18
 
19
 
"""Simple text-mode progress indicator.
 
19
"""
 
20
Simple text-mode progress indicator.
 
21
 
 
22
Everyone loves ascii art!
20
23
 
21
24
To display an indicator, create a ProgressBar object.  Call it,
22
25
passing Progress objects indicating the current state.  When done,
26
29
not to clutter log files.
27
30
"""
28
31
 
 
32
# TODO: remove functions in favour of keeping everything in one class
 
33
 
29
34
# TODO: should be a global option e.g. --silent that disables progress
30
35
# indicators, preferably without needing to adjust all code that
31
36
# potentially calls them.
32
37
 
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
 
38
# TODO: Perhaps don't write updates faster than a certain rate, say
 
39
# 5/second.
37
40
 
38
41
 
39
42
import sys
40
43
import time
41
 
import os
42
 
from collections import deque
43
44
 
44
45
 
45
46
def _width():
50
51
    TODO: Is there anything that gets a better update when the window
51
52
          is resized while the program is running?
52
53
    """
 
54
    import os
53
55
    try:
54
56
        return int(os.environ['COLUMNS'])
55
57
    except (IndexError, KeyError, ValueError):
61
63
        return False
62
64
    if not f.isatty():
63
65
        return False
 
66
    import os
64
67
    if os.environ.get('TERM') == 'dumb':
65
68
        # e.g. emacs compile window
66
69
        return False
68
71
 
69
72
 
70
73
 
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)
75
 
    else:
76
 
        return DotsProgressBar(to_file=to_file, **kwargs)
77
 
    
78
 
    
79
 
class _BaseProgressBar(object):
80
 
    def __init__(self,
81
 
                 to_file=sys.stderr,
82
 
                 show_pct=False,
83
 
                 show_spinner=False,
84
 
                 show_eta=True,
85
 
                 show_bar=True,
86
 
                 show_count=True):
87
 
        object.__init__(self)
88
 
        self.to_file = to_file
89
 
 
90
 
        self.last_msg = None
91
 
        self.last_cnt = None
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
98
 
 
99
 
 
100
 
 
101
 
class DummyProgress(_BaseProgressBar):
102
 
    """Progress-bar standin that does nothing.
103
 
 
104
 
    This can be used as the default argument for methods that
105
 
    take an optional progress indicator."""
106
 
    def tick(self):
107
 
        pass
108
 
 
109
 
    def update(self, msg=None, current=None, total=None):
110
 
        pass
111
 
 
112
 
    def clear(self):
113
 
        pass
114
 
        
115
 
    
116
 
class DotsProgressBar(_BaseProgressBar):
117
 
    def __init__(self, **kwargs):
118
 
        _BaseProgressBar.__init__(self, **kwargs)
119
 
        self.last_msg = None
120
 
        self.need_nl = False
121
 
        
122
 
    def tick(self):
123
 
        self.update()
124
 
        
125
 
    def update(self, msg=None, current_cnt=None, total_cnt=None):
126
 
        if msg and msg != self.last_msg:
127
 
            if self.need_nl:
128
 
                self.to_file.write('\n')
129
 
            
130
 
            self.to_file.write(msg + ': ')
131
 
            self.last_msg = msg
132
 
        self.need_nl = True
133
 
        self.to_file.write('.')
134
 
        
135
 
    def clear(self):
136
 
        if self.need_nl:
137
 
            self.to_file.write('\n')
138
 
        
139
 
    
140
 
class TTYProgressBar(_BaseProgressBar):
 
74
class ProgressBar(object):
141
75
    """Progress bar display object.
142
76
 
143
77
    Several options are available to control the display.  These can
160
94
    SPIN_CHARS = r'/-\|'
161
95
    MIN_PAUSE = 0.1 # seconds
162
96
 
163
 
 
164
 
    def __init__(self, **kwargs):
165
 
        _BaseProgressBar.__init__(self, **kwargs)
 
97
    start_time = None
 
98
    last_update = None
 
99
    
 
100
    def __init__(self,
 
101
                 to_file=sys.stderr,
 
102
                 show_pct=False,
 
103
                 show_spinner=False,
 
104
                 show_eta=True,
 
105
                 show_bar=True,
 
106
                 show_count=True):
 
107
        object.__init__(self)
 
108
        self.to_file = to_file
 
109
        self.suppressed = not _supports_progress(self.to_file)
166
110
        self.spin_pos = 0
167
 
        self.width = _width()
168
 
        self.start_time = None
169
 
        self.last_update = None
170
 
        self.last_updates = deque()
171
 
    
172
 
 
173
 
    def throttle(self):
174
 
        """Return True if the bar was updated too recently"""
175
 
        now = time.time()
176
 
        if self.start_time is None:
177
 
            self.start_time = self.last_update = now
178
 
            return False
179
 
        else:
180
 
            interval = now - self.last_update
181
 
            if interval > 0 and interval < self.MIN_PAUSE:
182
 
                return True
183
 
 
184
 
        self.last_updates.append(now - self.last_update)
185
 
        self.last_update = now
186
 
        return False
187
 
        
 
111
 
 
112
        self.last_msg = None
 
113
        self.last_cnt = None
 
114
        self.last_total = None
 
115
        self.show_pct = show_pct
 
116
        self.show_spinner = show_spinner
 
117
        self.show_eta = show_eta
 
118
        self.show_bar = show_bar
 
119
        self.show_count = show_count
 
120
 
188
121
 
189
122
    def tick(self):
190
123
        self.update(self.last_msg, self.last_cnt, self.last_total)
193
126
 
194
127
    def update(self, msg, current_cnt=None, total_cnt=None):
195
128
        """Update and redraw progress bar."""
196
 
 
197
 
        if current_cnt < 0:
198
 
            current_cnt = 0
199
 
            
200
 
        if current_cnt > total_cnt:
201
 
            total_cnt = current_cnt
 
129
        if self.suppressed:
 
130
            return
202
131
 
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
207
136
            
208
 
        if self.throttle():
209
 
            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
 
146
        
 
147
        width = _width()
 
148
 
 
149
        if total_cnt:
 
150
            assert current_cnt <= total_cnt
 
151
        if current_cnt:
 
152
            assert current_cnt >= 0
210
153
        
211
154
        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)
 
155
            eta = get_eta(self.start_time, current_cnt, total_cnt)
214
156
            eta_str = " " + str_tdelta(eta)
215
157
        else:
216
158
            eta_str = ""
243
185
 
244
186
        if self.show_bar:
245
187
            # progress bar, if present, soaks up all remaining space
246
 
            cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
 
188
            cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
247
189
                   - len(eta_str) - len(count_str) - 3
248
190
 
249
191
            if total_cnt:
264
206
 
265
207
        m = spin_str + bar_str + msg + count_str + pct_str + eta_str
266
208
 
267
 
        assert len(m) < self.width
268
 
        self.to_file.write('\r' + m.ljust(self.width - 1))
 
209
        assert len(m) < width
 
210
        self.to_file.write('\r' + m.ljust(width - 1))
269
211
        #self.to_file.flush()
270
212
            
271
213
 
272
 
    def clear(self):        
273
 
        self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
 
214
    def clear(self):
 
215
        if self.suppressed:
 
216
            return
 
217
        
 
218
        self.to_file.write('\r%s\r' % (' ' * (_width() - 1)))
274
219
        #self.to_file.flush()        
275
220
    
276
221
 
284
229
                             delt % 60)
285
230
 
286
231
 
287
 
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
 
232
def get_eta(start_time, current, total, enough_samples=3):
288
233
    if start_time is None:
289
234
        return None
290
235
 
306
251
 
307
252
    assert total_duration >= elapsed
308
253
 
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)
314
 
 
315
 
        old_time_left = total_duration - elapsed
316
 
 
317
 
        # We could return the average, or some other value here
318
 
        return (time_left + old_time_left) / 2
319
 
 
320
254
    return total_duration - elapsed
321
255
 
322
256
 
331
265
 
332
266
 
333
267
def demo():
334
 
    sleep = time.sleep
335
 
    
336
 
    print 'dumb-terminal test:'
337
 
    pb = DotsProgressBar()
338
 
    for i in range(100):
339
 
        pb.update('Leoparden', i, 99)
340
 
        sleep(0.1)
341
 
    sleep(1.5)
342
 
    pb.clear()
343
 
    sleep(1.5)
344
 
    
345
 
    print 'smart-terminal test:'
 
268
    from time import sleep
346
269
    pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
347
270
    for i in range(100):
348
271
        pb.update('Elephanten', i, 99)
350
273
    sleep(2)
351
274
    pb.clear()
352
275
    sleep(1)
353
 
 
354
276
    print 'done!'
355
277
 
356
278
if __name__ == "__main__":