← 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-29 04:11:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050629041140-6b17e65a23ffdf47
Merge John's log patch:

implements bzr log --forward --verbose
optimizes so that only logs to be printed are read (rather than reading
all and filtering out unwanted).

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
 
44
 
 
45
 
 
46
def _width():
 
47
    """Return estimated terminal width.
 
48
 
 
49
    TODO: Do something smart on Windows?
 
50
 
 
51
    TODO: Is there anything that gets a better update when the window
 
52
          is resized while the program is running?
 
53
    """
 
54
    import os
 
55
    try:
 
56
        return int(os.environ['COLUMNS'])
 
57
    except (IndexError, KeyError, ValueError):
 
58
        return 80
43
59
 
44
60
 
45
61
def _supports_progress(f):
47
63
        return False
48
64
    if not f.isatty():
49
65
        return False
 
66
    import os
50
67
    if os.environ.get('TERM') == 'dumb':
51
68
        # e.g. emacs compile window
52
69
        return False
54
71
 
55
72
 
56
73
 
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):
 
74
class ProgressBar(object):
127
75
    """Progress bar display object.
128
76
 
129
77
    Several options are available to control the display.  These can
146
94
    SPIN_CHARS = r'/-\|'
147
95
    MIN_PAUSE = 0.1 # seconds
148
96
 
149
 
 
150
 
    def __init__(self, **kwargs):
151
 
        from bzrlib.osutils import terminal_width
152
 
        _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)
153
110
        self.spin_pos = 0
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
174
 
        
 
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
 
175
121
 
176
122
    def tick(self):
177
123
        self.update(self.last_msg, self.last_cnt, self.last_total)
180
126
 
181
127
    def update(self, msg, current_cnt=None, total_cnt=None):
182
128
        """Update and redraw progress bar."""
183
 
 
184
 
        if current_cnt < 0:
185
 
            current_cnt = 0
186
 
            
187
 
        if current_cnt > total_cnt:
188
 
            total_cnt = current_cnt
 
129
        if self.suppressed:
 
130
            return
189
131
 
190
132
        # save these for the tick() function
191
133
        self.last_msg = msg
192
134
        self.last_cnt = current_cnt
193
135
        self.last_total = total_cnt
194
136
            
195
 
        if self.throttle():
196
 
            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
197
153
        
198
154
        if self.show_eta and self.start_time and total_cnt:
199
 
            eta = get_eta(self.start_time, current_cnt, total_cnt,
200
 
                    last_updates = self.last_updates)
 
155
            eta = get_eta(self.start_time, current_cnt, total_cnt)
201
156
            eta_str = " " + str_tdelta(eta)
202
157
        else:
203
158
            eta_str = ""
230
185
 
231
186
        if self.show_bar:
232
187
            # progress bar, if present, soaks up all remaining space
233
 
            cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
 
188
            cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
234
189
                   - len(eta_str) - len(count_str) - 3
235
190
 
236
191
            if total_cnt:
251
206
 
252
207
        m = spin_str + bar_str + msg + count_str + pct_str + eta_str
253
208
 
254
 
        assert len(m) < self.width
255
 
        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))
256
211
        #self.to_file.flush()
257
212
            
258
213
 
259
 
    def clear(self):        
260
 
        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)))
261
219
        #self.to_file.flush()        
262
220
    
263
221
 
271
229
                             delt % 60)
272
230
 
273
231
 
274
 
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):
275
233
    if start_time is None:
276
234
        return None
277
235
 
293
251
 
294
252
    assert total_duration >= elapsed
295
253
 
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
 
 
307
254
    return total_duration - elapsed
308
255
 
309
256
 
318
265
 
319
266
 
320
267
def demo():
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:'
 
268
    from time import sleep
333
269
    pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
334
270
    for i in range(100):
335
271
        pb.update('Elephanten', i, 99)
337
273
    sleep(2)
338
274
    pb.clear()
339
275
    sleep(1)
340
 
 
341
276
    print 'done!'
342
277
 
343
278
if __name__ == "__main__":