← 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-07-05 08:20:41 UTC
  • Revision ID: mbp@sourcefrog.net-20050705082041-6538a9ec26f7a59d
- Actually merge unsynchronized regions.  Woot!

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
44
 
43
45
 
44
46
def _width():
49
51
    TODO: Is there anything that gets a better update when the window
50
52
          is resized while the program is running?
51
53
    """
 
54
    import os
52
55
    try:
53
56
        return int(os.environ['COLUMNS'])
54
57
    except (IndexError, KeyError, ValueError):
60
63
        return False
61
64
    if not f.isatty():
62
65
        return False
 
66
    import os
63
67
    if os.environ.get('TERM') == 'dumb':
64
68
        # e.g. emacs compile window
65
69
        return False
67
71
 
68
72
 
69
73
 
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 DotsProgressBar(_BaseProgressBar):
101
 
    def __init__(self, **kwargs):
102
 
        _BaseProgressBar.__init__(self, **kwargs)
103
 
        self.last_msg = None
104
 
        self.need_nl = False
105
 
        
106
 
    def tick(self):
107
 
        self.update()
108
 
        
109
 
    def update(self, msg=None, current_cnt=None, total_cnt=None):
110
 
        if msg and msg != self.last_msg:
111
 
            if self.need_nl:
112
 
                self.to_file.write('\n')
113
 
            
114
 
            self.to_file.write(msg + ': ')
115
 
            self.last_msg = msg
116
 
        self.need_nl = True
117
 
        self.to_file.write('.')
118
 
        
119
 
    def clear(self):
120
 
        if self.need_nl:
121
 
            self.to_file.write('\n')
122
 
        
123
 
    
124
 
class TTYProgressBar(_BaseProgressBar):
 
74
class ProgressBar(object):
125
75
    """Progress bar display object.
126
76
 
127
77
    Several options are available to control the display.  These can
144
94
    SPIN_CHARS = r'/-\|'
145
95
    MIN_PAUSE = 0.1 # seconds
146
96
 
147
 
 
148
 
    def __init__(self, **kwargs):
149
 
        _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)
150
110
        self.spin_pos = 0
151
 
        self.width = _width()
152
 
        self.start_time = None
153
 
        self.last_update = None
154
 
    
155
 
 
156
 
    def throttle(self):
157
 
        """Return True if the bar was updated too recently"""
158
 
        now = time.time()
159
 
        if self.start_time is None:
160
 
            self.start_time = self.last_update = now
161
 
            return False
162
 
        else:
163
 
            interval = now - self.last_update
164
 
            if interval > 0 and interval < self.MIN_PAUSE:
165
 
                return True
166
 
 
167
 
        self.last_update = now
168
 
        return False
169
 
        
 
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
 
170
121
 
171
122
    def tick(self):
172
123
        self.update(self.last_msg, self.last_cnt, self.last_total)
175
126
 
176
127
    def update(self, msg, current_cnt=None, total_cnt=None):
177
128
        """Update and redraw progress bar."""
 
129
        if self.suppressed:
 
130
            return
178
131
 
179
132
        # save these for the tick() function
180
133
        self.last_msg = msg
181
134
        self.last_cnt = current_cnt
182
135
        self.last_total = total_cnt
183
136
            
184
 
        if self.throttle():
185
 
            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
186
146
        
 
147
        width = _width()
 
148
 
187
149
        if total_cnt:
188
150
            assert current_cnt <= total_cnt
189
151
        if current_cnt:
223
185
 
224
186
        if self.show_bar:
225
187
            # progress bar, if present, soaks up all remaining space
226
 
            cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
 
188
            cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
227
189
                   - len(eta_str) - len(count_str) - 3
228
190
 
229
191
            if total_cnt:
244
206
 
245
207
        m = spin_str + bar_str + msg + count_str + pct_str + eta_str
246
208
 
247
 
        assert len(m) < self.width
248
 
        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))
249
211
        #self.to_file.flush()
250
212
            
251
213
 
252
 
    def clear(self):        
253
 
        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)))
254
219
        #self.to_file.flush()        
255
220
    
256
221
 
300
265
 
301
266
 
302
267
def demo():
303
 
    sleep = time.sleep
304
 
    
305
 
    print 'dumb-terminal test:'
306
 
    pb = DotsProgressBar()
307
 
    for i in range(100):
308
 
        pb.update('Leoparden', i, 99)
309
 
        sleep(0.1)
310
 
    sleep(1.5)
311
 
    pb.clear()
312
 
    sleep(1.5)
313
 
    
314
 
    print 'smart-terminal test:'
 
268
    from time import sleep
315
269
    pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
316
270
    for i in range(100):
317
271
        pb.update('Elephanten', i, 99)
319
273
    sleep(2)
320
274
    pb.clear()
321
275
    sleep(1)
322
 
 
323
276
    print 'done!'
324
277
 
325
278
if __name__ == "__main__":