← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

[merge] John, sftp and others

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
38
38
 
39
39
import sys
40
40
import time
41
 
 
42
 
 
43
 
def _width():
44
 
    """Return estimated terminal width.
45
 
 
46
 
    TODO: Do something smart on Windows?
47
 
 
48
 
    TODO: Is there anything that gets a better update when the window
49
 
          is resized while the program is running?
50
 
    """
51
 
    import os
52
 
    try:
53
 
        return int(os.environ['COLUMNS'])
54
 
    except (IndexError, KeyError, ValueError):
55
 
        return 80
 
41
import os
 
42
from collections import deque
56
43
 
57
44
 
58
45
def _supports_progress(f):
60
47
        return False
61
48
    if not f.isatty():
62
49
        return False
63
 
    import os
64
50
    if os.environ.get('TERM') == 'dumb':
65
51
        # e.g. emacs compile window
66
52
        return False
68
54
 
69
55
 
70
56
 
71
 
class ProgressBar(object):
 
57
def ProgressBar(to_file=sys.stderr, **kwargs):
 
58
    """Abstract factory"""
 
59
    if _supports_progress(to_file):
 
60
        return TTYProgressBar(to_file=to_file, **kwargs)
 
61
    else:
 
62
        return DotsProgressBar(to_file=to_file, **kwargs)
 
63
    
 
64
    
 
65
class _BaseProgressBar(object):
 
66
    def __init__(self,
 
67
                 to_file=sys.stderr,
 
68
                 show_pct=False,
 
69
                 show_spinner=False,
 
70
                 show_eta=True,
 
71
                 show_bar=True,
 
72
                 show_count=True):
 
73
        object.__init__(self)
 
74
        self.to_file = to_file
 
75
 
 
76
        self.last_msg = None
 
77
        self.last_cnt = None
 
78
        self.last_total = None
 
79
        self.show_pct = show_pct
 
80
        self.show_spinner = show_spinner
 
81
        self.show_eta = show_eta
 
82
        self.show_bar = show_bar
 
83
        self.show_count = show_count
 
84
 
 
85
 
 
86
 
 
87
class DummyProgress(_BaseProgressBar):
 
88
    """Progress-bar standin that does nothing.
 
89
 
 
90
    This can be used as the default argument for methods that
 
91
    take an optional progress indicator."""
 
92
    def tick(self):
 
93
        pass
 
94
 
 
95
    def update(self, msg=None, current=None, total=None):
 
96
        pass
 
97
 
 
98
    def clear(self):
 
99
        pass
 
100
        
 
101
    
 
102
class DotsProgressBar(_BaseProgressBar):
 
103
    def __init__(self, **kwargs):
 
104
        _BaseProgressBar.__init__(self, **kwargs)
 
105
        self.last_msg = None
 
106
        self.need_nl = False
 
107
        
 
108
    def tick(self):
 
109
        self.update()
 
110
        
 
111
    def update(self, msg=None, current_cnt=None, total_cnt=None):
 
112
        if msg and msg != self.last_msg:
 
113
            if self.need_nl:
 
114
                self.to_file.write('\n')
 
115
            
 
116
            self.to_file.write(msg + ': ')
 
117
            self.last_msg = msg
 
118
        self.need_nl = True
 
119
        self.to_file.write('.')
 
120
        
 
121
    def clear(self):
 
122
        if self.need_nl:
 
123
            self.to_file.write('\n')
 
124
        
 
125
    
 
126
class TTYProgressBar(_BaseProgressBar):
72
127
    """Progress bar display object.
73
128
 
74
129
    Several options are available to control the display.  These can
91
146
    SPIN_CHARS = r'/-\|'
92
147
    MIN_PAUSE = 0.1 # seconds
93
148
 
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)
 
149
 
 
150
    def __init__(self, **kwargs):
 
151
        from bzrlib.osutils import terminal_width
 
152
        _BaseProgressBar.__init__(self, **kwargs)
107
153
        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
 
        self.width = _width()
 
154
        self.width = terminal_width()
 
155
        self.start_time = None
 
156
        self.last_update = None
 
157
        self.last_updates = deque()
 
158
    
 
159
 
 
160
    def throttle(self):
 
161
        """Return True if the bar was updated too recently"""
 
162
        now = time.time()
 
163
        if self.start_time is None:
 
164
            self.start_time = self.last_update = now
 
165
            return False
 
166
        else:
 
167
            interval = now - self.last_update
 
168
            if interval > 0 and interval < self.MIN_PAUSE:
 
169
                return True
 
170
 
 
171
        self.last_updates.append(now - self.last_update)
 
172
        self.last_update = now
 
173
        return False
119
174
        
120
175
 
121
176
    def tick(self):
125
180
 
126
181
    def update(self, msg, current_cnt=None, total_cnt=None):
127
182
        """Update and redraw progress bar."""
128
 
        if self.suppressed:
129
 
            return
 
183
 
 
184
        if current_cnt < 0:
 
185
            current_cnt = 0
 
186
            
 
187
        if current_cnt > total_cnt:
 
188
            total_cnt = current_cnt
130
189
 
131
190
        # save these for the tick() function
132
191
        self.last_msg = msg
133
192
        self.last_cnt = current_cnt
134
193
        self.last_total = total_cnt
135
194
            
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
145
 
        
146
 
        if total_cnt:
147
 
            assert current_cnt <= total_cnt
148
 
        if current_cnt:
149
 
            assert current_cnt >= 0
 
195
        if self.throttle():
 
196
            return 
150
197
        
151
198
        if self.show_eta and self.start_time and total_cnt:
152
 
            eta = get_eta(self.start_time, current_cnt, total_cnt)
 
199
            eta = get_eta(self.start_time, current_cnt, total_cnt,
 
200
                    last_updates = self.last_updates)
153
201
            eta_str = " " + str_tdelta(eta)
154
202
        else:
155
203
            eta_str = ""
208
256
        #self.to_file.flush()
209
257
            
210
258
 
211
 
    def clear(self):
212
 
        if self.suppressed:
213
 
            return
214
 
        
 
259
    def clear(self):        
215
260
        self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
216
261
        #self.to_file.flush()        
217
262
    
226
271
                             delt % 60)
227
272
 
228
273
 
229
 
def get_eta(start_time, current, total, enough_samples=3):
 
274
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
230
275
    if start_time is None:
231
276
        return None
232
277
 
248
293
 
249
294
    assert total_duration >= elapsed
250
295
 
 
296
    if last_updates and len(last_updates) >= n_recent:
 
297
        while len(last_updates) > n_recent:
 
298
            last_updates.popleft()
 
299
        avg = sum(last_updates) / float(len(last_updates))
 
300
        time_left = avg * (total - current)
 
301
 
 
302
        old_time_left = total_duration - elapsed
 
303
 
 
304
        # We could return the average, or some other value here
 
305
        return (time_left + old_time_left) / 2
 
306
 
251
307
    return total_duration - elapsed
252
308
 
253
309
 
262
318
 
263
319
 
264
320
def demo():
265
 
    from time import sleep
 
321
    sleep = time.sleep
 
322
    
 
323
    print 'dumb-terminal test:'
 
324
    pb = DotsProgressBar()
 
325
    for i in range(100):
 
326
        pb.update('Leoparden', i, 99)
 
327
        sleep(0.1)
 
328
    sleep(1.5)
 
329
    pb.clear()
 
330
    sleep(1.5)
 
331
    
 
332
    print 'smart-terminal test:'
266
333
    pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
267
334
    for i in range(100):
268
335
        pb.update('Elephanten', i, 99)
270
337
    sleep(2)
271
338
    pb.clear()
272
339
    sleep(1)
 
340
 
273
341
    print 'done!'
274
342
 
275
343
if __name__ == "__main__":