← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

  • Committer: Robert Collins
  • Date: 2005-08-23 06:52:09 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050823065209-81cd5962c401751b
move io redirection into each test case from the global runner

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
 
"""
20
 
Simple text-mode progress indicator.
21
 
 
22
 
Everyone loves ascii art!
 
19
"""Simple text-mode progress indicator.
23
20
 
24
21
To display an indicator, create a ProgressBar object.  Call it,
25
22
passing Progress objects indicating the current state.  When done,
29
26
not to clutter log files.
30
27
"""
31
28
 
32
 
# TODO: remove functions in favour of keeping everything in one class
33
 
 
34
29
# TODO: should be a global option e.g. --silent that disables progress
35
30
# indicators, preferably without needing to adjust all code that
36
31
# potentially calls them.
37
32
 
38
 
# TODO: Perhaps don't write updates faster than a certain rate, say
39
 
# 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
40
37
 
41
38
 
42
39
import sys
43
40
import time
 
41
import os
44
42
 
45
43
 
46
44
def _width():
51
49
    TODO: Is there anything that gets a better update when the window
52
50
          is resized while the program is running?
53
51
    """
54
 
    import os
55
52
    try:
56
53
        return int(os.environ['COLUMNS'])
57
54
    except (IndexError, KeyError, ValueError):
63
60
        return False
64
61
    if not f.isatty():
65
62
        return False
66
 
    import os
67
63
    if os.environ.get('TERM') == 'dumb':
68
64
        # e.g. emacs compile window
69
65
        return False
71
67
 
72
68
 
73
69
 
74
 
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 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):
75
125
    """Progress bar display object.
76
126
 
77
127
    Several options are available to control the display.  These can
94
144
    SPIN_CHARS = r'/-\|'
95
145
    MIN_PAUSE = 0.1 # seconds
96
146
 
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)
 
147
 
 
148
    def __init__(self, **kwargs):
 
149
        _BaseProgressBar.__init__(self, **kwargs)
110
150
        self.spin_pos = 0
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
 
 
 
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
        
121
170
 
122
171
    def tick(self):
123
172
        self.update(self.last_msg, self.last_cnt, self.last_total)
126
175
 
127
176
    def update(self, msg, current_cnt=None, total_cnt=None):
128
177
        """Update and redraw progress bar."""
129
 
        if self.suppressed:
130
 
            return
131
178
 
132
179
        # save these for the tick() function
133
180
        self.last_msg = msg
134
181
        self.last_cnt = current_cnt
135
182
        self.last_total = total_cnt
136
183
            
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
 
184
        if self.throttle():
 
185
            return 
146
186
        
147
 
        width = _width()
148
 
 
149
187
        if total_cnt:
150
188
            assert current_cnt <= total_cnt
151
189
        if current_cnt:
185
223
 
186
224
        if self.show_bar:
187
225
            # progress bar, if present, soaks up all remaining space
188
 
            cols = width - 1 - len(msg) - len(spin_str) - len(pct_str) \
 
226
            cols = self.width - 1 - len(msg) - len(spin_str) - len(pct_str) \
189
227
                   - len(eta_str) - len(count_str) - 3
190
228
 
191
229
            if total_cnt:
206
244
 
207
245
        m = spin_str + bar_str + msg + count_str + pct_str + eta_str
208
246
 
209
 
        assert len(m) < width
210
 
        self.to_file.write('\r' + m.ljust(width - 1))
 
247
        assert len(m) < self.width
 
248
        self.to_file.write('\r' + m.ljust(self.width - 1))
211
249
        #self.to_file.flush()
212
250
            
213
251
 
214
 
    def clear(self):
215
 
        if self.suppressed:
216
 
            return
217
 
        
218
 
        self.to_file.write('\r%s\r' % (' ' * (_width() - 1)))
 
252
    def clear(self):        
 
253
        self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
219
254
        #self.to_file.flush()        
220
255
    
221
256
 
265
300
 
266
301
 
267
302
def demo():
268
 
    from time import sleep
 
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:'
269
315
    pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
270
316
    for i in range(100):
271
317
        pb.update('Elephanten', i, 99)
273
319
    sleep(2)
274
320
    pb.clear()
275
321
    sleep(1)
 
322
 
276
323
    print 'done!'
277
324
 
278
325
if __name__ == "__main__":