30
30
# indicators, preferably without needing to adjust all code that
31
31
# potentially calls them.
33
# TODO: If not on a tty perhaps just print '......' for the benefit of IDEs, etc
33
# TODO: Perhaps don't write updates faster than a certain rate, say
35
36
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
37
# when the rate is unpredictable
49
49
TODO: Is there anything that gets a better update when the window
50
50
is resized while the program is running?
53
54
return int(os.environ['COLUMNS'])
54
55
except (IndexError, KeyError, ValueError):
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)
75
return DotsProgressBar(to_file=to_file, **kwargs)
78
class _BaseProgressBar(object):
87
self.to_file = to_file
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
100
class DummyProgress(_BaseProgressBar):
101
"""Progress-bar standin that does nothing.
103
This can be used as the default argument for methods that
104
take an optional progress indicator."""
108
def update(self, msg=None, current=None, total=None):
115
class DotsProgressBar(_BaseProgressBar):
116
def __init__(self, **kwargs):
117
_BaseProgressBar.__init__(self, **kwargs)
124
def update(self, msg=None, current_cnt=None, total_cnt=None):
125
if msg and msg != self.last_msg:
127
self.to_file.write('\n')
129
self.to_file.write(msg + ': ')
132
self.to_file.write('.')
136
self.to_file.write('\n')
139
class TTYProgressBar(_BaseProgressBar):
72
class ProgressBar(object):
140
73
"""Progress bar display object.
142
75
Several options are available to control the display. These can
159
92
SPIN_CHARS = r'/-\|'
160
93
MIN_PAUSE = 0.1 # seconds
163
def __init__(self, **kwargs):
164
_BaseProgressBar.__init__(self, **kwargs)
105
object.__init__(self)
106
self.to_file = to_file
107
self.suppressed = not _supports_progress(self.to_file)
165
108
self.spin_pos = 0
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
166
119
self.width = _width()
167
self.start_time = None
168
self.last_update = None
172
"""Return True if the bar was updated too recently"""
174
if self.start_time is None:
175
self.start_time = self.last_update = now
178
interval = now - self.last_update
179
if interval > 0 and interval < self.MIN_PAUSE:
182
self.last_update = now
191
127
def update(self, msg, current_cnt=None, total_cnt=None):
192
128
"""Update and redraw progress bar."""
194
132
# save these for the tick() function
195
133
self.last_msg = msg
196
134
self.last_cnt = current_cnt
197
135
self.last_total = total_cnt
138
if self.start_time is None:
139
self.start_time = now
141
interval = now - self.last_update
142
if interval > 0 and interval < self.MIN_PAUSE:
145
self.last_update = now
203
148
assert current_cnt <= total_cnt
320
print 'dumb-terminal test:'
321
pb = DotsProgressBar()
323
pb.update('Leoparden', i, 99)
329
print 'smart-terminal test:'
266
from time import sleep
330
267
pb = ProgressBar(show_pct=True, show_bar=True, show_spinner=False)
331
268
for i in range(100):
332
269
pb.update('Elephanten', i, 99)
added
removed
bzrlib/progress.py
