1
1
# Copyright (C) 2005 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2
# Copyright (C) 2005, 2006 Canonical <canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
19
"""Simple text-mode progress indicator.
35
35
# TODO: Optionally show elapsed time instead/as well as ETA; nicer
36
36
# when the rate is unpredictable
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
43
import bzrlib.errors as errors
49
44
from bzrlib.trace import mutter
52
47
def _supports_progress(f):
53
"""Detect if we can use pretty progress bars on the output stream f.
55
If this returns true we expect that a human may be looking at that
56
output, and that we can repaint a line to update it.
58
48
isatty = getattr(f, 'isatty', None)
79
69
if _supports_progress(to_file):
80
70
return TTYProgressBar(to_file=to_file, **kwargs)
82
return DummyProgress(to_file=to_file, **kwargs)
72
return DotsProgressBar(to_file=to_file, **kwargs)
84
74
# Minor sanitation to prevent spurious errors
85
75
requested_bar_type = requested_bar_type.lower().strip()
302
292
def throttle(self, old_msg):
303
293
"""Return True if the bar was updated too recently"""
304
294
# time.time consistently takes 40/4000 ms = 0.01 ms.
305
# time.clock() is faster, but gives us CPU time, not wall-clock time
295
# but every single update to the pb invokes it.
296
# so we use time.clock which takes 20/4000 ms = 0.005ms
297
# on the downside, time.clock() appears to have approximately
298
# 10ms granularity, so we treat a zero-time change as 'throttled.'
307
300
if self.start_time is not None and (now - self.start_time) < 1:
309
302
if old_msg != self.last_msg:
436
429
m = spin_str + bar_str + self.last_msg + count_str + pct_str + eta_str
437
self.to_file.write('\r%-*.*s' % (self.width - 1, self.width - 1, m))
431
assert len(m) < self.width
432
self.to_file.write('\r' + m.ljust(self.width - 1))
438
433
self._have_output = True
439
434
#self.to_file.flush()