diff options
| -rw-r--r-- | apt/progress/__init__.py | 4 | ||||
| -rw-r--r-- | apt/progress/gtk2.py | 438 | ||||
| -rw-r--r-- | debian/control | 2 | ||||
| -rwxr-xr-x | doc/examples/gui-inst.py | 27 | ||||
| -rw-r--r-- | doc/source/examples/apt-gtk.py | 29 | ||||
| -rw-r--r-- | doc/source/library/apt.progress.gtk2.rst | 131 | ||||
| -rw-r--r-- | doc/source/library/apt_pkg.rst | 3 | ||||
| -rw-r--r-- | doc/source/library/index.rst | 3 | ||||
| -rw-r--r-- | doc/source/whatsnew/1.0.rst | 10 |
9 files changed, 15 insertions, 632 deletions
diff --git a/apt/progress/__init__.py b/apt/progress/__init__.py index c689de5c..1ae94d06 100644 --- a/apt/progress/__init__.py +++ b/apt/progress/__init__.py @@ -19,8 +19,8 @@ """Progress reporting. This package provides progress reporting for the python-apt package. The module -'base' provides classes with no output, the module 'gtk2' provides classes for -GTK+ applications, and the module 'text' provides classes for terminals, etc. +'base' provides classes with no output, and the module 'text' provides classes +for terminals, etc. """ from __future__ import print_function diff --git a/apt/progress/gtk2.py b/apt/progress/gtk2.py deleted file mode 100644 index 7d142399..00000000 --- a/apt/progress/gtk2.py +++ /dev/null @@ -1,438 +0,0 @@ -#!/usr/bin/env python -# -# Copyright (c) 2004-2009 Canonical -# -# Authors: Michael Vogt <michael.vogt@ubuntu.com> -# Sebastian Heinlein <glatzor@ubuntu.com> -# Julian Andres Klode <jak@debian.org> -# -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License as -# published by the Free Software Foundation; either version 2 of the -# License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -# USA -"""GObject-powered progress classes and a GTK+ status widget.""" - -from __future__ import print_function - -import pygtk -pygtk.require('2.0') -import gtk -try: - import glib - glib # pyflakes -except ImportError: - import gobject as glib -import gobject -import pango -import time -import vte - -import apt_pkg -from apt_pkg import gettext as _ -from apt.progress import base - - -__all__ = ['GAcquireProgress', 'GInstallProgress', 'GOpProgress', - 'GtkAptProgress'] - - -def mksig(params=(), run=gobject.SIGNAL_RUN_FIRST, rettype=gobject.TYPE_NONE): - """Simplified Create a gobject signal. - - This allows us to write signals easier, because we just need to define the - type of the parameters (in most cases). - - ``params`` is a tuple which defines the types of the arguments. - """ - return (run, rettype, params) - - -class GOpProgress(gobject.GObject, base.OpProgress): - """Operation progress with GObject signals. - - Signals: - - * status-changed(str: operation, int: percent) - * status-started() - Not Implemented yet - * status-finished() - - """ - - __gsignals__ = {"status-changed": mksig((str, int)), - "status-started": mksig(), - "status-finished": mksig()} - - def __init__(self): - base.OpProgress.__init__(self) - gobject.GObject.__init__(self) - self._context = glib.main_context_default() - - def update(self, percent=None): - """Called to update the percentage done""" - base.OpProgress.update(self, percent) - self.emit("status-changed", self.op, self.percent) - while self._context.pending(): - self._context.iteration() - - def done(self): - """Called when all operation have finished.""" - base.OpProgress.done(self) - self.emit("status-finished") - - -class GInstallProgress(gobject.GObject, base.InstallProgress): - """Installation progress with GObject signals. - - Signals: - - * status-changed(str: status, int: percent) - * status-started() - * status-finished() - * status-timeout() - * status-error() - * status-conffile() - - """ - # Seconds until a maintainer script will be regarded as hanging - INSTALL_TIMEOUT = 5 * 60 - - __gsignals__ = {"status-changed": mksig((str, int)), - "status-started": mksig(), - "status-timeout": mksig(), - "status-error": mksig(), - "status-conffile": mksig(), - "status-finished": mksig()} - - def __init__(self, term): - base.InstallProgress.__init__(self) - gobject.GObject.__init__(self) - self.finished = False - self.apt_status = -1 - self.time_last_update = time.time() - self.term = term - self.term.connect("child-exited", self.child_exited) - self.env = ["VTE_PTY_KEEP_FD=%s" % self.writefd, - "DEBIAN_FRONTEND=gnome", - "APT_LISTCHANGES_FRONTEND=gtk"] - self._context = glib.main_context_default() - - def child_exited(self, term): - """Called when a child process exits""" - self.apt_status = term.get_child_exit_status() - self.finished = True - - def error(self, pkg, errormsg): - """Called when an error happens. - - Emits: status-error() - """ - self.emit("status-error") - - def conffile(self, current, new): - """Called during conffile. - - Emits: status-conffile() - """ - self.emit("status-conffile") - - def start_update(self): - """Called when the update starts. - - Emits: status-started() - """ - self.emit("status-started") - - def run(self, obj): - """Run.""" - self.finished = False - return base.InstallProgress.run(self, obj) - - def finish_update(self): - """Called when the update finished. - - Emits: status-finished() - """ - self.emit("status-finished") - - def processing(self, pkg, stage): - """Called when entering a new stage in dpkg.""" - # We have no percentage or alike, send -1 to let the bar pulse. - self.emit("status-changed", ("Installing %s...") % pkg, -1) - - def status_change(self, pkg, percent, status): - """Called when the status changed. - - Emits: status-changed(status, percent) - """ - self.time_last_update = time.time() - self.emit("status-changed", status, percent) - - def update_interface(self): - """Called periodically to update the interface. - - Emits: status-timeout() [When a timeout happens] - """ - base.InstallProgress.update_interface(self) - while self._context.pending(): - self._context.iteration() - if self.time_last_update + self.INSTALL_TIMEOUT < time.time(): - self.emit("status-timeout") - - def fork(self): - """Fork the process.""" - return self.term.forkpty(envv=self.env) - - def wait_child(self): - """Wait for the child process to exit.""" - while not self.finished: - self.update_interface() - time.sleep(0.02) - return self.apt_status - - -GDpkgInstallProgress = GInstallProgress - - -class GAcquireProgress(gobject.GObject, base.AcquireProgress): - """A Fetch Progress with GObject signals. - - Signals: - - * status-changed(str: description, int: percent) - * status-started() - * status-finished() - - DEPRECATED. - """ - - __gsignals__ = {"status-changed": mksig((str, int)), - "status-started": mksig(), - "status-finished": mksig()} - - def __init__(self): - base.AcquireProgress.__init__(self) - gobject.GObject.__init__(self) - self._continue = True - self._context = glib.main_context_default() - - def start(self): - base.AcquireProgress.start(self) - self.emit("status-started") - - def stop(self): - base.AcquireProgress.stop(self) - self.emit("status-finished") - - def cancel(self): - self._continue = False - - def pulse(self, owner): - base.AcquireProgress.pulse(self, owner) - current_item = self.current_items + 1 - if current_item > self.total_items: - current_item = self.total_items - if self.current_cps > 0: - text = (_("Downloading file %(current)li of %(total)li with " - "%(speed)s/s") % - {"current": current_item, - "total": self.total_items, - "speed": apt_pkg.size_to_str(self.current_cps)}) - else: - text = (_("Downloading file %(current)li of %(total)li") % - {"current": current_item, - "total": self.total_items}) - - percent = (((self.current_bytes + self.current_items) * 100.0) / - float(self.total_bytes + self.total_items)) - self.emit("status-changed", text, percent) - while self._context.pending(): - self._context.iteration() - return self._continue - - -class GtkAptProgress(gtk.VBox): - """Graphical progress for installation/fetch/operations. - - This widget provides a progress bar, a terminal and a status bar for - showing the progress of package manipulation tasks. - """ - - def __init__(self): - gtk.VBox.__init__(self) - self.set_spacing(6) - # Setup some child widgets - self._expander = gtk.Expander(_("Details")) - self._terminal = vte.Terminal() - #self._terminal.set_font_from_string("monospace 10") - self._expander.add(self._terminal) - self._progressbar = gtk.ProgressBar() - # Setup the always italic status label - self._label = gtk.Label() - attr_list = pango.AttrList() - attr_list.insert(pango.AttrStyle(pango.STYLE_ITALIC, 0, -1)) - self._label.set_attributes(attr_list) - self._label.set_ellipsize(pango.ELLIPSIZE_END) - self._label.set_alignment(0, 0) - # add child widgets - self.pack_start(self._progressbar, False) - self.pack_start(self._label, False) - self.pack_start(self._expander, False) - # Setup the internal progress handlers - self._progress_open = GOpProgress() - self._progress_open.connect("status-changed", self._on_status_changed) - self._progress_open.connect("status-started", self._on_status_started) - self._progress_open.connect("status-finished", - self._on_status_finished) - self._progress_acquire = GAcquireProgress() - self._progress_acquire.connect("status-changed", - self._on_status_changed) - self._progress_acquire.connect("status-started", - self._on_status_started) - self._progress_acquire.connect("status-finished", - self._on_status_finished) - - self._progress_fetch = None - self._progress_install = GInstallProgress(self._terminal) - self._progress_install.connect("status-changed", - self._on_status_changed) - self._progress_install.connect("status-started", - self._on_status_started) - self._progress_install.connect("status-finished", - self._on_status_finished) - self._progress_install.connect("status-timeout", - self._on_status_timeout) - self._progress_install.connect("status-error", - self._on_status_timeout) - self._progress_install.connect("status-conffile", - self._on_status_timeout) - - def clear(self): - """Reset all status information.""" - self._label.set_label("") - self._progressbar.set_fraction(0) - self._expander.set_expanded(False) - - @property - def open(self): - """Return the cache opening progress handler.""" - return self._progress_open - - @property - def install(self): - """Return the install progress handler.""" - return self._progress_install - - @property - def dpkg_install(self): - """Return the install progress handler for dpkg.""" - return self._progress_install - - @property - def acquire(self): - """Return the acquire progress handler.""" - return self._progress_acquire - - def _on_status_started(self, progress): - """Called when something starts.""" - self._on_status_changed(progress, _("Starting..."), 0) - while gtk.events_pending(): - gtk.main_iteration() - - def _on_status_finished(self, progress): - """Called when something finished.""" - self._on_status_changed(progress, _("Complete"), 100) - while gtk.events_pending(): - gtk.main_iteration() - - def _on_status_changed(self, progress, status, percent): - """Called when the status changed.""" - self._label.set_text(status) - if percent is None or percent == -1: - self._progressbar.pulse() - else: - self._progressbar.set_fraction(percent / 100.0) - while gtk.events_pending(): - gtk.main_iteration() - - def _on_status_timeout(self, progress): - """Called when timeout happens.""" - self._expander.set_expanded(True) - while gtk.events_pending(): - gtk.main_iteration() - - def cancel_download(self): - """Cancel a currently running download.""" - self._progress_fetch.cancel() - - def show_terminal(self, expanded=False): - """Show the expander for the terminal. - - Show an expander with a terminal widget which provides a way - to interact with dpkg - """ - self._expander.show() - self._terminal.show() - self._expander.set_expanded(expanded) - while gtk.events_pending(): - gtk.main_iteration() - - def hide_terminal(self): - """Hide the expander with the terminal widget.""" - self._expander.hide() - while gtk.events_pending(): - gtk.main_iteration() - - def show(self): - """Show the Box""" - gtk.HBox.show(self) - self._label.show() - self._progressbar.show() - while gtk.events_pending(): - gtk.main_iteration() - - -def _test(): - """Test function""" - import sys - - import apt - from apt.debfile import DebPackage - - win = gtk.Window() - apt_progress = GtkAptProgress() - win.set_title("GtkAptProgress Demo") - win.add(apt_progress) - apt_progress.show() - win.show() - cache = apt.cache.Cache(apt_progress.open) - pkg = cache["xterm"] - if pkg.is_installed: - pkg.mark_delete() - else: - pkg.mark_install() - apt_progress.show_terminal(True) - try: - cache.commit(apt_progress.acquire, apt_progress.install) - except Exception as exc: - print("Exception happened:", exc, file=sys.stderr) - if len(sys.argv) > 1: - deb = DebPackage(sys.argv[1], cache) - deb.install(apt_progress.dpkg_install) - win.connect("destroy", gtk.main_quit) - gtk.main() - - -if __name__ == "__main__": - _test() - -# vim: ts=4 et sts=4 diff --git a/debian/control b/debian/control index 6d8a71ac..13e487fb 100644 --- a/debian/control +++ b/debian/control @@ -58,7 +58,7 @@ Breaks: packagekit-backend-apt (<= 0.4.8-0ubuntu4), update-notifier (<< 0.99.3debian9), wajig (<< 2.0.46) Provides: ${python:Provides} -Suggests: python-apt-dbg, python-gtk2, python-vte, python-apt-doc +Suggests: python-apt-dbg, python-apt-doc Description: Python interface to libapt-pkg The apt_pkg Python interface will provide full access to the internal libapt-pkg structures allowing Python programs to easily perform a diff --git a/doc/examples/gui-inst.py b/doc/examples/gui-inst.py deleted file mode 100755 index 654f3794..00000000 --- a/doc/examples/gui-inst.py +++ /dev/null @@ -1,27 +0,0 @@ -#!/usr/bin/python -# example how to install in a custom terminal widget -# see also gnome bug: #169201 -import pygtk -pygtk.require('2.0') -import gtk - -import apt.progress.gtk2 - - -if __name__ == "__main__": - - win = gtk.Window() - progress = apt.progress.gtk2.GtkAptProgress() - win.set_title("GtkAptProgress Demo") - win.add(progress) - progress.show() - win.show() - - cache = apt.cache.Cache(progress.open) - if cache["2vcard"].is_installed: - cache["2vcard"].mark_delete() - else: - cache["2vcard"].mark_install() - progress.show_terminal(expanded=True) - cache.commit(progress.fetch, progress.install) - gtk.main() diff --git a/doc/source/examples/apt-gtk.py b/doc/source/examples/apt-gtk.py deleted file mode 100644 index ad46454e..00000000 --- a/doc/source/examples/apt-gtk.py +++ /dev/null @@ -1,29 +0,0 @@ -#!/usr/bin/python -"""Example for gtk widgets""" -import pygtk -pygtk.require("2.0") -import gtk - -import apt.progress.gtk2 - - -def main(): - """Main function.""" - win = gtk.Window() - win.connect("destroy", gtk.main_quit) - progress = apt.progress.gtk2.GtkAptProgress() - win.set_title("GtkAptProgress Demo") - win.add(progress) - progress.show() - win.show() - cache = apt.cache.Cache(progress.open) - if cache["xterm"].is_installed: - cache["xterm"].mark_delete() - else: - cache["xterm"].mark_install() - progress.show_terminal(expanded=True) - cache.commit(progress.fetch, progress.install) - gtk.main() - -if __name__ == "__main__": - main() diff --git a/doc/source/library/apt.progress.gtk2.rst b/doc/source/library/apt.progress.gtk2.rst deleted file mode 100644 index 0d53ad41..00000000 --- a/doc/source/library/apt.progress.gtk2.rst +++ /dev/null @@ -1,131 +0,0 @@ -:mod:`apt.progress.gtk2` --- Progress reporting for GTK+ interfaces -=================================================================== -.. module:: apt.progress.gtk2 - -The :mod:`apt.progress.gtk2` module provides classes with GObject signals and -a class with a GTK+ widget for progress handling. - - -GObject progress classes -------------------------- -.. class:: GInstallProgress - - An implementation of :class:`apt.progress.base.InstallProgress` supporting - GObject signals. The class emits the following signals: - - .. describe:: status-changed(status: str, percent: int) - - Emitted when the status of an operation changed. - - .. describe:: status-started() - - Emitted when the installation started. - - .. describe:: status-finished() - - Emitted when the installation finished. - - .. describe:: status-timeout() - - Emitted when a timeout happens - - .. describe:: status-error() - - Emitted in case of an error. - - .. describe:: status-conffile() - - Emitted when a conffile update is happening. - - -.. class:: GAcquireProgress - - An implementation of :class:`apt.progress.base.AcquireProgress` supporting - GObject signals. The class emits the following signals: - - .. describe:: status-changed(description: str, percent: int) - - Emitted when the status of the fetcher changed, e.g. when the - percentage increased. - - .. describe:: status-started() - - Emitted when the fetcher starts to fetch. - - .. describe:: status-finished() - - Emitted when the fetcher finished. - - -.. class:: GDpkgInstallProgress - - An implementation of :class:`apt.progress.base.InstallProgress` supporting - GObject signals. This is the same as :class:`GInstallProgress` and is thus - completely deprecated. - -.. class:: GOpProgress - - An implementation of :class:`apt.progress.old.FetchProgress` supporting - GObject signals. The class emits the following signals: - - .. describe:: status-changed(operation: str, percent: int) - - Emitted when the status of an operation changed. - - .. describe:: status-started() - - Emitted when it starts - Not implemented yet. - - .. describe:: status-finished() - - Emitted when all operations have finished. - -GTK+ Widget ------------ -.. class:: GtkAptProgress - - Graphical progress for installation/fetch/operations, providing - a progress bar, a terminal and a status bar for showing the progress - of package manipulation tasks. - - .. method:: cancel_download() - - Cancel a currently running download. - - .. method:: clear() - - Reset all status information. - - .. attribute:: dpkg_install - - Return the install progress handler for dpkg. - - .. attribute:: fetch - - Return the fetch progress handler. - - .. method:: hide_terminal() - - Hide the expander with the terminal widget. - - .. attribute:: install - - Return the install progress handler. - - .. attribute:: open - - Return the cache opening progress handler. - - .. method:: show() - - Show the Box - - .. method:: show_terminal(expanded=False) - - Show an expander with a terminal widget which provides a way to - interact with dpkg. - - -Example -------- -.. literalinclude:: ../examples/apt-gtk.py diff --git a/doc/source/library/apt_pkg.rst b/doc/source/library/apt_pkg.rst index 15316eea..bdf096a4 100644 --- a/doc/source/library/apt_pkg.rst +++ b/doc/source/library/apt_pkg.rst @@ -1541,8 +1541,7 @@ installation. The constructor takes an optional parameter *progress* which takes an :class:`apt.progress.base.AcquireProgress` object. This object may then report progress information (see :mod:`apt.progress.text` for reporting - progress to a I/O stream and :mod:`apt.progress.gtk2` for GTK+ progress - reporting). + progress to a I/O stream). Acquire items have two methods to start and stop the fetching: diff --git a/doc/source/library/index.rst b/doc/source/library/index.rst index dbd58375..0b048c80 100644 --- a/doc/source/library/index.rst +++ b/doc/source/library/index.rst @@ -12,7 +12,7 @@ apt-pkg and apt-inst libraries and the base for the rest of python-apt. Going forward, the :mod:`apt` package appears. This package is using :mod:`apt_pkg` and :mod:`apt_inst` to provide easy to use ways to manipulate the cache, fetch packages, or install new packages. It also provides useful -progress classes, for text and GTK+ interfaces. The last package is +progress classes, currently only for text interfaces. The last package is :mod:`aptsources`. The aptsources package provides classes and functions to read files like :file:`/etc/apt/sources.list` and to modify them. @@ -28,7 +28,6 @@ read files like :file:`/etc/apt/sources.list` and to modify them. apt.package apt.progress.base apt.progress.text - apt.progress.gtk2 aptsources.distinfo aptsources.distro diff --git a/doc/source/whatsnew/1.0.rst b/doc/source/whatsnew/1.0.rst index 7c5951fe..bc022463 100644 --- a/doc/source/whatsnew/1.0.rst +++ b/doc/source/whatsnew/1.0.rst @@ -20,6 +20,16 @@ The following features are deprecated, starting with this release: * The `md5` argument to :class:`apt_pkg.AcquireFile`, it is replaced by the `hash` argument. +Removed +------- +* The module :mod:`apt.progress.gtk2' has been removed. There were no + users in the Debian archive, its last update was in 2013, and it was buggy + already. Apart from that, it suggested that it is OK to run a graphical + application as root, and used the unmaintained GTK+ 2 version. + + Therefore, there is no replacement, please use PackageKit or aptdaemon + for installation in graphical environments. + Maintenance ----------- |