← 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: 2006-03-02 03:12:34 UTC
  • mto: (1594.2.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1596.
  • Revision ID: robertc@robertcollins.net-20060302031234-cf6b75961f27c5df
InterVersionedFile implemented.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/progress.py
39
39
import sys
40
40
import time
41
41
import os
42
 
 
43
 
 
44
 
def _width():
45
 
    """Return estimated terminal width.
46
 
 
47
 
    TODO: Do something smart on Windows?
48
 
 
49
 
    TODO: Is there anything that gets a better update when the window
50
 
          is resized while the program is running?
51
 
    """
52
 
    try:
53
 
        return int(os.environ['COLUMNS'])
54
 
    except (IndexError, KeyError, ValueError):
55
 
        return 80
 
42
from collections import deque
56
43
 
57
44
 
58
45
def _supports_progress(f):
82
69
                 show_spinner=False,
83
70
                 show_eta=True,
84
71
                 show_bar=True,
85
 
                 show_count=True):
 
72
                 show_count=True,
 
73
                 to_messages_file=sys.stdout):
86
74
        object.__init__(self)
87
75
        self.to_file = to_file
88
 
 
 
76
        self.to_messages_file = to_messages_file
89
77
        self.last_msg = None
90
78
        self.last_cnt = None
91
79
        self.last_total = None
94
82
        self.show_eta = show_eta
95
83
        self.show_bar = show_bar
96
84
        self.show_count = show_count
97
 
        
98
 
        
99
 
    
 
85
 
 
86
    def note(self, fmt_string, *args, **kwargs):
 
87
        """Record a note without disrupting the progress bar."""
 
88
        self.clear()
 
89
        self.to_messages_file.write(fmt_string % args)
 
90
        self.to_messages_file.write('\n')
 
91
 
 
92
 
 
93
class DummyProgress(_BaseProgressBar):
 
94
    """Progress-bar standin that does nothing.
 
95
 
 
96
    This can be used as the default argument for methods that
 
97
    take an optional progress indicator."""
 
98
    def tick(self):
 
99
        pass
 
100
 
 
101
    def update(self, msg=None, current=None, total=None):
 
102
        pass
 
103
 
 
104
    def clear(self):
 
105
        pass
 
106
        
 
107
    def note(self, fmt_string, *args, **kwargs):
 
108
        """See _BaseProgressBar.note()."""
 
109
 
 
110
 
100
111
class DotsProgressBar(_BaseProgressBar):
101
112
    def __init__(self, **kwargs):
102
113
        _BaseProgressBar.__init__(self, **kwargs)
146
157
 
147
158
 
148
159
    def __init__(self, **kwargs):
 
160
        from bzrlib.osutils import terminal_width
149
161
        _BaseProgressBar.__init__(self, **kwargs)
150
162
        self.spin_pos = 0
151
 
        self.width = _width()
 
163
        self.width = terminal_width()
152
164
        self.start_time = None
153
165
        self.last_update = None
 
166
        self.last_updates = deque()
154
167
    
155
168
 
156
169
    def throttle(self):
164
177
            if interval > 0 and interval < self.MIN_PAUSE:
165
178
                return True
166
179
 
 
180
        self.last_updates.append(now - self.last_update)
167
181
        self.last_update = now
168
182
        return False
169
183
        
176
190
    def update(self, msg, current_cnt=None, total_cnt=None):
177
191
        """Update and redraw progress bar."""
178
192
 
 
193
        if current_cnt < 0:
 
194
            current_cnt = 0
 
195
            
 
196
        if current_cnt > total_cnt:
 
197
            total_cnt = current_cnt
 
198
 
179
199
        # save these for the tick() function
180
200
        self.last_msg = msg
181
201
        self.last_cnt = current_cnt
184
204
        if self.throttle():
185
205
            return 
186
206
        
187
 
        if total_cnt:
188
 
            assert current_cnt <= total_cnt
189
 
        if current_cnt:
190
 
            assert current_cnt >= 0
191
 
        
192
207
        if self.show_eta and self.start_time and total_cnt:
193
 
            eta = get_eta(self.start_time, current_cnt, total_cnt)
 
208
            eta = get_eta(self.start_time, current_cnt, total_cnt,
 
209
                    last_updates = self.last_updates)
194
210
            eta_str = " " + str_tdelta(eta)
195
211
        else:
196
212
            eta_str = ""
248
264
        self.to_file.write('\r' + m.ljust(self.width - 1))
249
265
        #self.to_file.flush()
250
266
            
251
 
 
252
267
    def clear(self):        
253
268
        self.to_file.write('\r%s\r' % (' ' * (self.width - 1)))
254
269
        #self.to_file.flush()        
255
 
    
256
270
 
257
271
        
258
272
def str_tdelta(delt):
264
278
                             delt % 60)
265
279
 
266
280
 
267
 
def get_eta(start_time, current, total, enough_samples=3):
 
281
def get_eta(start_time, current, total, enough_samples=3, last_updates=None, n_recent=10):
268
282
    if start_time is None:
269
283
        return None
270
284
 
286
300
 
287
301
    assert total_duration >= elapsed
288
302
 
 
303
    if last_updates and len(last_updates) >= n_recent:
 
304
        while len(last_updates) > n_recent:
 
305
            last_updates.popleft()
 
306
        avg = sum(last_updates) / float(len(last_updates))
 
307
        time_left = avg * (total - current)
 
308
 
 
309
        old_time_left = total_duration - elapsed
 
310
 
 
311
        # We could return the average, or some other value here
 
312
        return (time_left + old_time_left) / 2
 
313
 
289
314
    return total_duration - elapsed
290
315
 
291
316