- Tweak progress output so it's hopefully less confusing

- Add dynamic resizing ability to progress bar
- Resolves: bug#437197
epel9
James Antill 17 years ago
parent 7dae824261
commit 314b2915d0

@ -3,7 +3,7 @@
Summary: A high-level cross-protocol url-grabber Summary: A high-level cross-protocol url-grabber
Name: python-urlgrabber Name: python-urlgrabber
Version: 3.0.0 Version: 3.0.0
Release: 7%{?dist} Release: 8%{?dist}
Source0: urlgrabber-%{version}.tar.gz Source0: urlgrabber-%{version}.tar.gz
Patch0: urlgrabber-keepalive.patch Patch0: urlgrabber-keepalive.patch
Patch1: urlgrabber-string-type.patch Patch1: urlgrabber-string-type.patch
@ -51,6 +51,11 @@ rm -rf $RPM_BUILD_ROOT
%{_bindir}/urlgrabber %{_bindir}/urlgrabber
%changelog %changelog
* Sat May 18 2008 James Antill <james@fedoraproject.org> 3.0.0-8
- Tweak progress output so it's hopefully less confusing
- Add dynamic resizing ability to progress bar
- Resolves: bug#437197
* Fri May 2 2008 James Antill <james@fedoraproject.org> 3.0.0-7 * Fri May 2 2008 James Antill <james@fedoraproject.org> 3.0.0-7
- Fix reget's against servers that don't allow Range requests, also tweaks - Fix reget's against servers that don't allow Range requests, also tweaks
- reget == check_timestamp, if anyone/thing uses that. - reget == check_timestamp, if anyone/thing uses that.

@ -2,10 +2,87 @@ Index: urlgrabber/progress.py
=================================================================== ===================================================================
RCS file: /home/groups/urlgrabber/cvs-root/urlgrabber/urlgrabber/progress.py,v RCS file: /home/groups/urlgrabber/cvs-root/urlgrabber/urlgrabber/progress.py,v
retrieving revision 1.7 retrieving revision 1.7
diff -u -r1.7 urlgrabber/progress.py diff -u -r1.7 progress.py
--- urlgrabber/progress.py 19 Aug 2005 21:59:07 -0000 1.7 --- urlgrabber/progress.py 19 Aug 2005 21:59:07 -0000 1.7
+++ urlgrabber/progress.py 7 Apr 2008 16:33:30 -0000 +++ urlgrabber/progress.py 17 May 2008 17:33:32 -0000
@@ -83,6 +83,17 @@ @@ -23,8 +23,75 @@
import time
import math
import thread
import types
-
+import fcntl
+import struct
+import termios
+
+# Code from http://mail.python.org/pipermail/python-list/2000-May/033365.html
+def terminal_width(fd=1):
+ """ Get the real terminal width """
+ try:
+ buf = 'abcdefgh'
+ buf = fcntl.ioctl(fd, termios.TIOCGWINSZ, buf)
+ return struct.unpack('hhhh', buf)[1]
+ except: # IOError
+ return 80
+
+_term_width_val = None
+_term_width_last = None
+def terminal_width_cached(fd=1, cache_timeout=1.000):
+ """ Get the real terminal width, but cache it for a bit. """
+ global _term_width_val
+ global _term_width_last
+
+ now = time.time()
+ if _term_width_val is None or (now - _term_width_last) > cache_timeout:
+ _term_width_val = terminal_width(fd)
+ _term_width_last = now
+ return _term_width_val
+
+class TerminalLine:
+ """ Help create dynamic progress bars, uses terminal_width_cached(). """
+
+ def __init__(self, min_rest=0, beg_len=None, fd=1, cache_timeout=1.000):
+ if beg_len is None:
+ beg_len = min_rest
+ self._min_len = min_rest
+ self._llen = terminal_width_cached(fd, cache_timeout)
+ if self._llen < beg_len:
+ self._llen = beg_len
+ self._fin = False
+
+ def __len__(self):
+ """ Usable length for elements. """
+ return self._llen - self._min_len
+
+ def rest_split(self, fixed, elements=2):
+ """ After a fixed length, split the rest of the line length among
+ a number of different elements (default=2). """
+ if self._llen < fixed:
+ return 0
+ return (self._llen - fixed) / elements
+
+ def add(self, element, full_len=None):
+ """ If there is room left in the line, above min_len, add element.
+ Note that as soon as one add fails all the rest will fail too. """
+
+ if full_len is None:
+ full_len = len(element)
+ if len(self) < full_len:
+ self._fin = True
+ if self._fin:
+ return ''
+
+ self._llen -= len(element)
+ return element
+
+ def rest(self):
+ """ Current rest of line, same as .rest_split(fixed=0, elements=1). """
+ return self._llen
+
class BaseMeter:
def __init__(self):
self.update_period = 0.3 # seconds
@@ -83,6 +150,64 @@
def _do_end(self, amount_read, now=None): def _do_end(self, amount_read, now=None):
pass pass
@ -19,24 +96,80 @@ diff -u -r1.7 urlgrabber/progress.py
+ global _text_meter_sofar_size + global _text_meter_sofar_size
+ _text_meter_total_size = size + _text_meter_total_size = size
+ _text_meter_sofar_size = downloaded + _text_meter_sofar_size = downloaded
+
+#
+# update: No size (minimal: 17 chars)
+# -----------------------------------
+# <text> <rate> | <current size> <elapsed time>
+# 8-48 1 8 3 6 1 9 5
+#
+# Order: 1. <text>+<current size> (17)
+# 2. +<elapsed time> (10, total: 27)
+# 3. + ( 5, total: 32)
+# 4. +<rate> ( 9, total: 41)
+#
+# update: Size, Single file
+# -------------------------
+# <text> <pc> <bar> <rate> | <current size> <eta time> ETA
+# 8-25 1 3-4 1 6-16 1 8 3 6 1 9 1 3 1
+#
+# Order: 1. <text>+<current size> (17)
+# 2. +<eta time> (10, total: 27)
+# 3. +ETA ( 5, total: 32)
+# 4. +<pc> ( 4, total: 36)
+# 5. +<rate> ( 9, total: 45)
+# 6. +<bar> ( 7, total: 52)
+#
+# update: Size, All files
+# -----------------------
+# <text> <total pc> <pc> <bar> <rate> | <current size> <eta time> ETA
+# 8-22 1 5-7 1 3-4 1 6-12 1 8 3 6 1 9 1 3 1
+#
+# Order: 1. <text>+<current size> (17)
+# 2. +<eta time> (10, total: 27)
+# 3. +ETA ( 5, total: 32)
+# 4. +<total pc> ( 5, total: 37)
+# 4. +<pc> ( 4, total: 41)
+# 5. +<rate> ( 9, total: 50)
+# 6. +<bar> ( 7, total: 57)
+#
+# end
+# ---
+# <text> | <current size> <elapsed time>
+# 8-56 3 6 1 9 5
+#
+# Order: 1. <text> ( 8)
+# 2. +<current size> ( 9, total: 17)
+# 3. +<elapsed time> (10, total: 27)
+# 4. + ( 5, total: 32)
+#
+ +
class TextMeter(BaseMeter): class TextMeter(BaseMeter):
def __init__(self, fo=sys.stderr): def __init__(self, fo=sys.stderr):
BaseMeter.__init__(self) BaseMeter.__init__(self)
@@ -97,6 +108,12 @@ @@ -97,37 +222,73 @@
text = self.text text = self.text
else: else:
text = self.basename text = self.basename
+ +
+ ave_dl = format_number(self.re.average_rate())
+ sofar_size = None + sofar_size = None
+ if _text_meter_total_size: + if _text_meter_total_size:
+ sofar_size = _text_meter_sofar_size + amount_read + sofar_size = _text_meter_sofar_size + amount_read
+ sofar_pc = (sofar_size * 100) / _text_meter_total_size + sofar_pc = (sofar_size * 100) / _text_meter_total_size
+ +
+ # Include text + ui_rate in minimal
+ tl = TerminalLine(8, 8+1+8)
+ ui_size = tl.add(' | %5sB' % fread)
if self.size is None: if self.size is None:
out = '\r%-60.60s %5sB %s ' % \ - out = '\r%-60.60s %5sB %s ' % \
(text, fread, fetime) - (text, fread, fetime)
@@ -104,15 +121,23 @@ + ui_time = tl.add(' %9s' % fetime)
+ ui_end = tl.add(' ' * 5)
+ ui_rate = tl.add(' %5sB/s' % ave_dl)
+ out = '\r%-*.*s%s%s%s%s' % (tl.rest(), tl.rest(), text,
+ ui_rate, ui_size, ui_time, ui_end)
else:
rtime = self.re.remaining_time() rtime = self.re.remaining_time()
frtime = format_time(rtime) frtime = format_time(rtime)
frac = self.re.fraction_read() frac = self.re.fraction_read()
@ -44,14 +177,24 @@ diff -u -r1.7 urlgrabber/progress.py
- out = '\r%-25.25s %3i%% |%-25.25s| %5sB %8s ETA ' % \ - out = '\r%-25.25s %3i%% |%-25.25s| %5sB %8s ETA ' % \
- (text, frac*100, bar, fread, frtime) - (text, frac*100, bar, fread, frtime)
+ bar = '='*int(10 * frac) + ui_time = tl.add(' %9s' % frtime)
+ ave_dl = format_number(self.re.average_rate()) + ui_end = tl.add(' ETA ')
+
+ if sofar_size is None: + if sofar_size is None:
+ out = '\r%-29.29s %3i%% |%-10.10s| %5sB/s | %5sB %9s ETA ' % \ + ui_sofar_pc = ''
+ (text, frac*100, bar, ave_dl, fread, frtime)
+ else: + else:
+ fmt ='\r%-22.22s %3i%% |%4i%% |%-10.10s| %5sB/s | %5sB %9s ETA ' + ui_sofar_pc = tl.add(' (%i%%)' % sofar_pc,
+ out = fmt % (text, sofar_pc,frac*100,bar,ave_dl, fread,frtime) + full_len=len(" (100%)"))
+
+ ui_pc = tl.add(' %2i%%' % (frac*100))
+ ui_rate = tl.add(' %5sB/s' % ave_dl)
+ # Make text grow a bit before we start growing the bar too
+ blen = 4 + tl.rest_split(8 + 8 + 4)
+ bar = '='*int(blen * frac)
+ ui_bar = tl.add(' [%-*.*s]' % (blen, blen, bar))
+ out = '\r%-*.*s%s%s%s%s%s%s%s' % (tl.rest(), tl.rest(), text,
+ ui_sofar_pc, ui_pc, ui_bar,
+ ui_rate, ui_size, ui_time, ui_end)
self.fo.write(out) self.fo.write(out)
self.fo.flush() self.fo.flush()
@ -63,17 +206,25 @@ diff -u -r1.7 urlgrabber/progress.py
total_time = format_time(self.re.elapsed_time()) total_time = format_time(self.re.elapsed_time())
total_size = format_number(amount_read) total_size = format_number(amount_read)
if self.text is not None: if self.text is not None:
@@ -123,11 +148,16 @@ text = self.text
out = '\r%-60.60s %5sB %s ' % \
(text, total_size, total_time)
else: else:
text = self.basename
- if self.size is None:
- out = '\r%-60.60s %5sB %s ' % \
- (text, total_size, total_time)
- else:
- bar = '='*25 - bar = '='*25
- out = '\r%-25.25s %3i%% |%-25.25s| %5sB %8s ' % \ - out = '\r%-25.25s %3i%% |%-25.25s| %5sB %8s ' % \
- (text, 100, bar, total_size, total_time) - (text, 100, bar, total_size, total_time)
+ out = '\r%-56.56s | %5sB %9s ' % \ - self.fo.write(out + '\n')
+ (text, total_size, total_time)
+ +
self.fo.write(out + '\n') + tl = TerminalLine(8)
+ ui_size = tl.add(' | %5sB' % total_size)
+ ui_time = tl.add(' %9s' % total_time)
+ ui_end = tl.add(' ' * 5)
+ out = '\r%-*.*s%s%s%s\n' % (tl.rest(), tl.rest(), text,
+ ui_size, ui_time, ui_end)
+ self.fo.write(out)
self.fo.flush() self.fo.flush()
+ if _text_meter_total_size: + if _text_meter_total_size:
+ _text_meter_sofar_size += amount_read + _text_meter_sofar_size += amount_read
@ -83,7 +234,7 @@ diff -u -r1.7 urlgrabber/progress.py
text_progress_meter = TextMeter text_progress_meter = TextMeter
@@ -396,10 +426,12 @@ @@ -396,10 +557,12 @@
#print 'times', now, self.last_update_time #print 'times', now, self.last_update_time
time_diff = now - self.last_update_time time_diff = now - self.last_update_time
read_diff = amount_read - self.last_amount_read read_diff = amount_read - self.last_amount_read
@ -99,7 +250,7 @@ diff -u -r1.7 urlgrabber/progress.py
#print 'results', time_diff, read_diff, self.ave_rate #print 'results', time_diff, read_diff, self.ave_rate
##################################################################### #####################################################################
@@ -528,3 +560,49 @@ @@ -528,3 +691,49 @@
format = '%.0f%s%s' format = '%.0f%s%s'
return(format % (float(number or 0), space, symbols[depth])) return(format % (float(number or 0), space, symbols[depth]))
@ -121,7 +272,7 @@ diff -u -r1.7 urlgrabber/progress.py
+if __name__ == "__main__": +if __name__ == "__main__":
+ # (1/2): subversion-1.4.4-7.x86_64.rpm 2.4 MB / 85 kB/s 00:28 + # (1/2): subversion-1.4.4-7.x86_64.rpm 2.4 MB / 85 kB/s 00:28
+ # (2/2): mercurial-0.9.5-6.fc8.x86_64.rpm 924 kB / 106 kB/s 00:08 + # (2/2): mercurial-0.9.5-6.fc8.x86_64.rpm 924 kB / 106 kB/s 00:08
+ if True: + if len(sys.argv) >= 2 and sys.argv[1] == 'total':
+ text_meter_total_size(1000 + 10000 + 10000 + 1000000 + 1000000 + + text_meter_total_size(1000 + 10000 + 10000 + 1000000 + 1000000 +
+ 1000000 + 10000 + 10000 + 10000 + 1000000) + 1000000 + 10000 + 10000 + 10000 + 1000000)
+ _tst("sm-1.0.0-1.fc8.i386.rpm", 1, 10, 0, 1000, + _tst("sm-1.0.0-1.fc8.i386.rpm", 1, 10, 0, 1000,
@ -141,11 +292,11 @@ diff -u -r1.7 urlgrabber/progress.py
+ _tst("large-file-name-Foo5-10.8.7-4.5.6.2.fc8.x86_64.rpm", 8, 10, + _tst("large-file-name-Foo5-10.8.7-4.5.6.2.fc8.x86_64.rpm", 8, 10,
+ 5001, 10000, (100, 0.1)) + 5001, 10000, (100, 0.1))
+ _tst("large-file-name-Foo6-10.8.7-4.5.6.3.fc8.x86_64.rpm", 9, 10, + _tst("large-file-name-Foo6-10.8.7-4.5.6.3.fc8.x86_64.rpm", 9, 10,
+ 7502, 10000, (100, 0.1)) + 7502, 10000, (1, 0.1))
+ _tst("large-file-name-Foox-9.8.7-4.5.6.1.fc8.x86_64.rpm", 10, 10, + _tst("large-file-name-Foox-9.8.7-4.5.6.1.fc8.x86_64.rpm", 10, 10,
+ 0, 1000000, (10, 0.5), + 0, 1000000, (10, 0.5),
+ (10000, 0.1), (10000, 0.1), (10000, 0.1), (10000, 0.1), + (100000, 0.1), (10000, 0.1), (10000, 0.1), (10000, 0.1),
+ (10000, 0.1), (10000, 0.1), (10000, 0.1), (10000, 0.1), + (100000, 0.1), (10000, 0.1), (10000, 0.1), (10000, 0.1),
+ (10000, 0.1), (10000, 0.1), (10000, 0.1), (10000, 0.1), + (100000, 0.1), (10000, 0.1), (10000, 0.1), (10000, 0.1),
+ (10000, 0.1), (10000, 0.1), (10000, 0.1), (10000, 0.1), + (100000, 0.1), (10000, 0.1), (10000, 0.1), (10000, 0.1),
+ (10000, 0.1), (10000, 0.25)) + (100000, 0.1), (1, 0.1))

Loading…
Cancel
Save