Merge lp:~mvo/click/progressmeter into lp:~mvo/click/acquire

[Michael Vogt]

Unmerged revisions

551. By Michael Vogt on 2014-12-03

cherry pick r570,r571 of lp:~snappy-dev/click/progressmeter (thanks to Barry Warsaw)

=== modified file 'click/acquire.py'
--- click/acquire.py	2014-10-14 12:52:49 +0000
+++ click/acquire.py	2014-12-03 08:34:01 +0000
@@ -25,15 +25,19 @@
     'ClickAcquireMethodPycurl',
     'ClickAcquireMethodUbuntuDownloadManager',
     'ClickAcquireStatus',
+    'ClickAcquireStatusMeter',
     'ClickAcquireStatusText',
     ]
 
 import os
+import math
 import select
 import subprocess
 import sys
 from textwrap import dedent
 
+from progressbar import ProgressBar, Bar, Widget
+
 import apt_pkg
 from debian.deb822 import Deb822
 import dbus
@@ -123,6 +127,71 @@
         sys.stdout.write("Done fetching %s\n" % self.uri)
 
 
+class FileSize(Widget):
+    def update(self, pbar):
+        value = pbar.maxval                         # or .currval?
+        if value < 1000:
+            return '{:3d} B '.format(int(value))
+        scale = int(math.log(value, 1000))          # or binary? e.g. MiB
+        try:
+            suffix = ' kMGTPEZY'[scale]
+        except IndexError:
+            # Should never happen, but still.
+            suffix = '!'
+        scaled_value = value // 1000 ** scale
+        return '{:3d} {:1s}B '.format(scaled_value, suffix)
+
+
+class OK(Widget):
+    def update(self, pbar):
+        if pbar.currval >= pbar.maxval:
+            return 'OK'
+        else:
+            return '  '
+
+SPACER = '    '
+
+class ClickAcquireStatusMeter(ClickAcquireStatus):
+    """Progress meter reporting for the acquire progress"""
+
+    # We have to defer creating the actual progress bar until its first use
+    # because the constructor doesn't get called with essential information
+    # (e.g. the uri and the total bytes).  These get set after the fact but
+    # before the first call to .pulse(), so initialize the object there.
+    _progress = None
+
+    def pulse(self):
+        if self.total_bytes <= 1:
+            return
+        if self._progress is None:
+            # Massage the uri.  Use the part to the right of the .click
+            # suffix, minus any version number.
+            base = os.path.basename(self.uri)
+            if base.startswith('com.ubuntu.snappy.'):
+                base = base[18:]
+            snap, _, extra = base.partition('_')
+            self._progress = ProgressBar(widgets=[
+                snap,
+                SPACER,
+                # XXX in the examples, it's unclear whether the size field
+                # should be the total size or the fetched size.  Also, decimal
+                # (MB) or binary (MiB)?  For now, we go with total size in
+                # decimal.
+                FileSize(),
+                SPACER,
+                Bar(marker='=', left='[', right=']'),
+                SPACER,
+                OK(),
+                SPACER,
+                ],
+                maxval=self.total_bytes)
+            self._progress.start()
+        self._progress.update(self.fetched_bytes)
+
+    def done(self):
+        self._progress.finish()
+
+
 # similar to Acquire/AcquireWorker
 class ClickAcquire:
     """Acquire from remote locations"""
 
=== modified file 'click/commands/install.py'
--- click/commands/install.py	2014-09-15 14:02:27 +0000
+++ click/commands/install.py	2014-12-03 08:34:01 +0000
@@ -28,7 +28,7 @@
 
 from click.acquire import (
     ClickAcquire,
-    ClickAcquireStatusText,
+    ClickAcquireStatusMeter,
 )
 from click.install import ClickInstaller, ClickInstallerError
 
@@ -68,7 +68,7 @@
     if parsed_uri.scheme != "":
         t = tempfile.NamedTemporaryFile()
         package_path = t.name
-        log = ClickAcquireStatusText()
+        log = ClickAcquireStatusMeter()
         acq = ClickAcquire(log)
         acq.fetch(package_uri, package_path)
     else:
 
=== modified file 'debian/changelog'
--- debian/changelog	2014-10-14 09:47:10 +0000
+++ debian/changelog	2014-12-03 08:34:01 +0000
@@ -1,3 +1,10 @@
+click (0.4.35+ppa17) UNRELEASED; urgency=medium
+
+  * click/acquire.py:
+    - progress meter
+
+ -- Barry Warsaw <[e-mail]>  Tue, 02 Dec 2014 18:20:19 -0500
+
 click (0.4.34) UNRELEASED; urgency=medium
 
   [ Michael Vogt ]
 
=== modified file 'debian/control'
--- debian/control	2014-10-14 13:55:38 +0000
+++ debian/control	2014-12-03 08:34:01 +0000
@@ -3,7 +3,7 @@
 Priority: optional
 Maintainer: Colin Watson <[e-mail]>
 Standards-Version: 3.9.5
-Build-Depends: debhelper (>= 9~), dh-autoreconf, intltool, python3:any (>= 3.2), python3-all:any, python3-setuptools, python3-apt, python3-debian, python3-gi, python3:any (>= 3.3) | python3-mock, pep8, python3-pep8, pyflakes, python3-sphinx, pkg-config, valac, gobject-introspection (>= 0.6.7), libgirepository1.0-dev (>= 0.6.7), libglib2.0-dev (>= 2.34), gir1.2-glib-2.0, libjson-glib-dev (>= 0.10), libgee-0.8-dev, libpackagekit-glib2-dev (>= 0.7.2), python3-coverage, python3-six, dh-systemd (>= 1.3), python3-pycurl, python3-dbus
+Build-Depends: debhelper (>= 9~), dh-autoreconf, intltool, python3:any (>= 3.2), python3-all:any, python3-setuptools, python3-apt, python3-debian, python3-gi, python3:any (>= 3.3) | python3-mock, pep8, python3-pep8, pyflakes, python3-sphinx, pkg-config, valac, gobject-introspection (>= 0.6.7), libgirepository1.0-dev (>= 0.6.7), libglib2.0-dev (>= 2.34), gir1.2-glib-2.0, libjson-glib-dev (>= 0.10), libgee-0.8-dev, libpackagekit-glib2-dev (>= 0.7.2), python3-coverage, python3-six, dh-systemd (>= 1.3), python3-pycurl, python3-dbus, python3-progressbar
 Vcs-Bzr: https://code.launchpad.net/~ubuntu-managed-branches/click/click
 Vcs-Browser: http://bazaar.launchpad.net/~ubuntu-managed-branches/click/click/files
 X-Auto-Uploader: no-rewrite-version
@@ -14,7 +14,7 @@
 Package: click
 Architecture: any
 Pre-Depends: ${misc:Pre-Depends}
-Depends: ${shlibs:Depends}, ${misc:Depends}, ${python3:Depends}, python3-click (= ${binary:Version}), adduser, python3-pycurl, python3-dbus
+Depends: ${shlibs:Depends}, ${misc:Depends}, ${python3:Depends}, python3-click (= ${binary:Version}), adduser, python3-pycurl, python3-dbus, python3-progressbar
 Recommends: click-apparmor
 Suggests: click-reviewers-tools (>= 0.9), ubuntu-app-launch-tools | upstart-app-launch-tools
 Conflicts: click-package