← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

Exclude more files from dumb-rsync upload

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
import os
 
42
from collections import deque
41
43
 
42
44
 
43
45
def _width():
48
50
    TODO: Is there anything that gets a better update when the window
49
51
          is resized while the program is running?
50
52
    """
51
 
    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
63
 
    import os
64
64
    if os.environ.get('TERM') == 'dumb':
65
65
        # e.g. emacs compile window
66
66
        return False
68
68
 
69
69
 
70
70
 
71
 
class ProgressBar(object):
 
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):
72
141
    """Progress bar display object.
73
142
 
74
143
    Several options are available to control the display.  These can
91
160
    SPIN_CHARS = r'/-\|'
92
161
    MIN_PAUSE = 0.1 # seconds
93
162
 
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)
 
163
 
 
164
    def __init__(self, **kwargs):
 
165
        _BaseProgressBar.__init__(self, **kwargs)
107
166
        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
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
119
187
        
120
188
 
121
189
    def tick(self):
125
193
 
126
194
    def update(self, msg, current_cnt=None, total_cnt=None):
127
195
        """Update and redraw progress bar."""
128
 
        if self.suppressed:
129
 
            return
 
196
 
 
197
        if current_cnt < 0:
 
198
            current_cnt = 0
 
199
            
 
200
        if current_cnt > total_cnt:
 
201
            total_cnt = current_cnt
130
202
 
131
203
        # save these for the tick() function
132
204
        self.last_msg = msg
133
205
        self.last_cnt = current_cnt
134
206
        self.last_total = total_cnt
135
207
            
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
 
208
        if self.throttle():
 
209
            return 
150
210
        
151
211
        if self.show_eta and self.start_time and total_cnt:
152
 
            eta = get_eta(self.start_time, current_cnt, total_cnt)
 
212
            eta = get_eta(self.start_time, current_cnt, total_cnt,
 
213
                    last_updates = self.last_updates)
153
214
            eta_str = " " + str_tdelta(eta)
154
215
        else:
155
216
            eta_str = ""
208
269
        #self.to_file.flush()
209
270
            
210
271
 
211
 
    def clear(self):
212
 
        if self.suppressed:
213
 
            return
214
 
        
 
272
    def clear(self):        
215
273
        self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
216
274
        #self.to_file.flush()        
217
275
    
226
284
                             delt % 60)
227
285
 
228
286
 
229
 
def get_eta(start_time, current, total, enough_samples=3):
 
287
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
230
288
    if start_time is None:
231
289
        return None
232
290
 
248
306
 
249
307
    assert total_duration >= elapsed
250
308
 
 
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
 
251
320
    return total_duration - elapsed
252
321
 
253
322
 
262
331
 
263
332
 
264
333
def demo():
265
 
    from time import sleep
 
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:'
266
346
    pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
267
347
    for i in range(100):
268
348
        pb.update('Elephanten', i, 99)
270
350
    sleep(2)
271
351
    pb.clear()
272
352
    sleep(1)
 
353
 
273
354
    print 'done!'
274
355
 
275
356
if __name__ == "__main__":