← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

- more error conversions

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
26
26
not to clutter log files.
27
27
"""
28
28
 
29
 
# TODO: remove functions in favour of keeping everything in one class
30
 
 
31
29
# TODO: should be a global option e.g. --silent that disables progress
32
30
# indicators, preferably without needing to adjust all code that
33
31
# potentially calls them.
34
32
 
35
 
# TODO: Perhaps don't write updates faster than a certain rate, say
36
 
# 5/second.
 
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
37
37
 
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 DummyProgress(_BaseProgressBar):
 
101
    """Progress-bar standin that does nothing.
 
102
 
 
103
    This can be used as the default argument for methods that
 
104
    take an optional progress indicator."""
 
105
    def tick(self):
 
106
        pass
 
107
 
 
108
    def update(self, msg=None, current=None, total=None):
 
109
        pass
 
110
 
 
111
    def clear(self):
 
112
        pass
 
113
        
 
114
    
 
115
class DotsProgressBar(_BaseProgressBar):
 
116
    def __init__(self, **kwargs):
 
117
        _BaseProgressBar.__init__(self, **kwargs)
 
118
        self.last_msg = None
 
119
        self.need_nl = False
 
120
        
 
121
    def tick(self):
 
122
        self.update()
 
123
        
 
124
    def update(self, msg=None, current_cnt=None, total_cnt=None):
 
125
        if msg and msg != self.last_msg:
 
126
            if self.need_nl:
 
127
                self.to_file.write('\n')
 
128
            
 
129
            self.to_file.write(msg + ': ')
 
130
            self.last_msg = msg
 
131
        self.need_nl = True
 
132
        self.to_file.write('.')
 
133
        
 
134
    def clear(self):
 
135
        if self.need_nl:
 
136
            self.to_file.write('\n')
 
137
        
 
138
    
 
139
class TTYProgressBar(_BaseProgressBar):
72
140
    """Progress bar display object.
73
141
 
74
142
    Several options are available to control the display.  These can
91
159
    SPIN_CHARS = r'/-\|'
92
160
    MIN_PAUSE = 0.1 # seconds
93
161
 
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)
 
162
 
 
163
    def __init__(self, **kwargs):
 
164
        _BaseProgressBar.__init__(self, **kwargs)
107
165
        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
 
 
 
166
        self.width = _width()
 
167
        self.start_time = None
 
168
        self.last_update = None
 
169
    
 
170
 
 
171
    def throttle(self):
 
172
        """Return True if the bar was updated too recently"""
 
173
        now = time.time()
 
174
        if self.start_time is None:
 
175
            self.start_time = self.last_update = now
 
176
            return False
 
177
        else:
 
178
            interval = now - self.last_update
 
179
            if interval > 0 and interval < self.MIN_PAUSE:
 
180
                return True
 
181
 
 
182
        self.last_update = now
 
183
        return False
 
184
        
118
185
 
119
186
    def tick(self):
120
187
        self.update(self.last_msg, self.last_cnt, self.last_total)
123
190
 
124
191
    def update(self, msg, current_cnt=None, total_cnt=None):
125
192
        """Update and redraw progress bar."""
126
 
        if self.suppressed:
127
 
            return
 
193
 
 
194
        if current_cnt < 0:
 
195
            current_cnt = 0
 
196
            
 
197
        if current_cnt > total_cnt:
 
198
            total_cnt = current_cnt
128
199
 
129
200
        # save these for the tick() function
130
201
        self.last_msg = msg
131
202
        self.last_cnt = current_cnt
132
203
        self.last_total = total_cnt
133
204
            
134
 
        now = time.time()
135
 
        if self.start_time is None:
136
 
            self.start_time = now
137
 
        else:
138
 
            interval = now - self.last_update
139
 
            if interval > 0 and interval < self.MIN_PAUSE:
140
 
                return
141
 
 
142
 
        self.last_update = now
143
 
        
144
 
        width = _width()
145
 
 
146
 
        if total_cnt:
147
 
            assert current_cnt <= total_cnt
148
 
        if current_cnt:
149
 
            assert current_cnt >= 0
 
205
        if self.throttle():
 
206
            return 
150
207
        
151
208
        if self.show_eta and self.start_time and total_cnt:
152
209
            eta = get_eta(self.start_time, current_cnt, total_cnt)
182
239
 
183
240
        if self.show_bar:
184
241
            # progress bar, if present, soaks up all remaining space
185
 
            cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
 
242
            cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
186
243
                   - len(eta_str) - len(count_str) - 3
187
244
 
188
245
            if total_cnt:
203
260
 
204
261
        m = spin_str + bar_str + msg + count_str + pct_str + eta_str
205
262
 
206
 
        assert len(m) < width
207
 
        self.to_file.write('\r' + m.ljust(width - 1))
 
263
        assert len(m) < self.width
 
264
        self.to_file.write('\r' + m.ljust(self.width - 1))
208
265
        #self.to_file.flush()
209
266
            
210
267
 
211
 
    def clear(self):
212
 
        if self.suppressed:
213
 
            return
214
 
        
215
 
        self.to_file.write('\r%s\r' % (' ' * (_width() - 1)))
 
268
    def clear(self):        
 
269
        self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
216
270
        #self.to_file.flush()        
217
271
    
218
272
 
262
316
 
263
317
 
264
318
def demo():
265
 
    from time import sleep
 
319
    sleep = time.sleep
 
320
    
 
321
    print 'dumb-terminal test:'
 
322
    pb = DotsProgressBar()
 
323
    for i in range(100):
 
324
        pb.update('Leoparden', i, 99)
 
325
        sleep(0.1)
 
326
    sleep(1.5)
 
327
    pb.clear()
 
328
    sleep(1.5)
 
329
    
 
330
    print 'smart-terminal test:'
266
331
    pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
267
332
    for i in range(100):
268
333
        pb.update('Elephanten', i, 99)
270
335
    sleep(2)
271
336
    pb.clear()
272
337
    sleep(1)
 
338
 
273
339
    print 'done!'
274
340
 
275
341
if __name__ == "__main__":