← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/progress.py

  • Committer: Aaron Bentley
  • Date: 2005-08-10 21:43:27 UTC
  • mto: (1092.1.41) (1185.3.4) (974.1.47)
  • mto: This revision was merged to the branch mainline in revision 1110.
  • Revision ID: abentley@panoramicfeedback.com-20050810214327-4e8c22e4cba24527
Eliminated ThreeWayInventory

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
30
30
# indicators, preferably without needing to adjust all code that
31
31
# potentially calls them.
32
32
 
33
 
# TODO: Perhaps don't write updates faster than a certain rate, say
34
 
# 5/second.
 
33
# TODO: If not on a tty perhaps just print '......' for the benefit of IDEs, etc
35
34
 
36
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
37
36
# when the rate is unpredictable
39
38
 
40
39
import sys
41
40
import time
 
41
import os
42
42
 
43
43
 
44
44
def _width():
49
49
    TODO: Is there anything that gets a better update when the window
50
50
          is resized while the program is running?
51
51
    """
52
 
    import os
53
52
    try:
54
53
        return int(os.environ['COLUMNS'])
55
54
    except (IndexError, KeyError, ValueError):
61
60
        return False
62
61
    if not f.isatty():
63
62
        return False
64
 
    import os
65
63
    if os.environ.get('TERM') == 'dumb':
66
64
        # e.g. emacs compile window
67
65
        return False
69
67
 
70
68
 
71
69
 
72
 
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):
73
125
    """Progress bar display object.
74
126
 
75
127
    Several options are available to control the display.  These can
92
144
    SPIN_CHARS = r'/-\|'
93
145
    MIN_PAUSE = 0.1 # seconds
94
146
 
95
 
    start_time = None
96
 
    last_update = None
97
 
    
98
 
    def __init__(self,
99
 
                 to_file=sys.stderr,
100
 
                 show_pct=False,
101
 
                 show_spinner=False,
102
 
                 show_eta=True,
103
 
                 show_bar=True,
104
 
                 show_count=True):
105
 
        object.__init__(self)
106
 
        self.to_file = to_file
107
 
        self.suppressed = not _supports_progress(self.to_file)
 
147
 
 
148
    def __init__(self, **kwargs):
 
149
        _BaseProgressBar.__init__(self, **kwargs)
108
150
        self.spin_pos = 0
109
 
 
110
 
        self.last_msg = None
111
 
        self.last_cnt = None
112
 
        self.last_total = None
113
 
        self.show_pct = show_pct
114
 
        self.show_spinner = show_spinner
115
 
        self.show_eta = show_eta
116
 
        self.show_bar = show_bar
117
 
        self.show_count = show_count
118
 
 
119
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
120
169
        
121
170
 
122
171
    def tick(self):
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
187
        if total_cnt:
148
188
            assert current_cnt <= total_cnt
209
249
        #self.to_file.flush()
210
250
            
211
251
 
212
 
    def clear(self):
213
 
        if self.suppressed:
214
 
            return
215
 
        
 
252
    def clear(self):        
216
253
        self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
217
254
        #self.to_file.flush()        
218
255
    
263
300
 
264
301
 
265
302
def demo():
266
 
    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:'
267
315
    pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
268
316
    for i in range(100):
269
317
        pb.update('Elephanten', i, 99)
271
319
    sleep(2)
272
320
    pb.clear()
273
321
    sleep(1)
 
322
 
274
323
    print 'done!'
275
324
 
276
325
if __name__ == "__main__":