Merge lp:~pitti/gtimelog/pygi into lp:~gtimelog-dev/gtimelog/trunk

[Martin Pitt]

This ports gtimelog from pygtk to gobject-introspection, so that this will also work with GTK3. (See http://live.gnome.org/GObjectIntrospection for details).

This mostly works fine, but the only thing that I can't get to work for the life of it is the detection whether to use the dark or bright icon. I played with get_style_context().lookup_color('base_color') and other methods, but I always get a bright background with a dark foreground, no matter which theme I set. Curiously the color values do change on theme changes, just not in the way that I need.

Do you know whether there is a cleaner way to ship icons for dark and bright themes?

[Marius Gedminas (mgedmin)]

Awesome!

But something seems to be wrong: the diff is empty. Have you pushed your changes to the launchpad branch?

Is it possible to have one codebase that uses either PyGtk or PyGI? I'd like GTimeLog to continue working with older distributions like Lucid.

The icon color detection is an ugly hack. I think the proper solution is to install different versions of gtimelog.png into /usr/share/icons/ubutu-mono-{dark,light}, and perhaps a colourful one into /usr/share/icons/hicolor.

The hack is there mostly because development is easier if I can run gtimelog (and see its icon) directly from a source checkout.

[Barry Warsaw (barry)]

BTW, note that the dark background icon has *never* worked for me. For example, I'll attach a screenshot from Natty with stock gtimelog.

[Barry Warsaw (barry)]

Er, okay, I forgot you can't add attachments to merge proposals. :(

http://barry.warsaw.us/gtimelog.png

[Martin Pitt (pitti)]

> But something seems to be wrong: the diff is empty.

Argh, sorry. Pushed.

> Is it possible to have one codebase that uses either PyGtk or PyGI?

That's a bit tricky in general. I can change the code to work with either, but that will inevitably result in a few more "if using pygi; then ... else pygtk way" constructs.

[Martin Pitt (pitti)]

I updated the branch now to work with PyGTK, GTK2-GI, and GTK3-GI. For using GTK3, comment out "gtk.require_version('2.0')" for now.

BTW, the pygtk "get theme color" hack doesn't seem to work under unity either.

So while the code looks a bit ugly now in some places due to the four "if pygtk:" checks, it's by and large still ok, I think. The pygtk bits can be dropped in a year or so when GTK3 and GI become the ubiquitous standard.

[lp:~pitti/gtimelog/pygi]

177. By Marius Gedminas on 2011-01-28

Bugfix: always preserve the order of entries, even when they have the same
timestamp (LP: #708825).

178. By Marius Gedminas on 2011-01-28

Application Indicator menu now has a CheckMenuItem "Show GTimelog".

Previously it used the old tray icon menu with separate Show/Hide items.

179. By Marius Gedminas on 2011-01-28

Prepare to release 0.5.0

180. By Marius Gedminas on 2011-01-28

Post-release version bump

[Marius Gedminas (mgedmin)]

Looks good to me.

At the moment I'm having intermittent connection problems (connection refused on port 22) that prevent me from merging your branch, so I'll do that a bit later. I barely managed to push out a bugfix (unrelated to GUI code) and a small change to the app indicator menu earlier today. Speaking of which, I hope working GtkCheckMenuItems hasn't changed in any significant way between PyGtk and PyGI?

Also, we're hosting a 48-hour Game Jam in our office, so I might be a bit busy.

I think I'd also like try a few more refactorings, e.g. those constructor calls can also be handled the same way as constants:

    try:
        # PyGI
        ...
        new_pango_tab_array = pango.TabArray.new
        ...
    except ImportError:
        # PyGTK
        ...
        new_pango_tab_array = pango.TabArray
        ...
    ...
            tabs = new_pango_tab_array(2, False)
            tabs.set_tab(0, PANGO_TAB_LEFT, 9 * em)
            tabs.set_tab(1, PANGO_TAB_LEFT, 12 * em)
    ...

and constants such as PANGO_TAB_LEFT would look a bit more conventional in upper case. But those are minor details.

review: Approve

[Martin Pitt (pitti)]

Good idea, I made those two changes.

[Marius Gedminas (mgedmin)]

Unfortunately the code doesn't work on Maverick:

Traceback (most recent call last):
  File "./gtimelog", line 11, in <module>
    from gtimelog.main import main
  File "./src/gtimelog/main.py", line 24, in <module>
    gtk.require_version('2.0')
  File "/usr/lib/pymodules/python2.6/gtk-2.0/gi/module.py", line 212, in __getattr__
    attribute = getattr(self._dynamic_module, name)
  File "/usr/lib/pymodules/python2.6/gtk-2.0/gi/module.py", line 88, in __getattr__
    self.__class__.__name__, name))
AttributeError: 'DynamicModule' object has no attribute 'require_version'

Some kind of feature/version check may be necessary. Or ir may be enough to swap the try/except parts and try PyGTK by default, falling back to PyGI when PyGTK is not available.

Also, could you add "Contributed by Martin Pitt <email address hidden>" to the changelog entry?

review: Needs Fixing

[Barry Warsaw (barry)]

Minor comments about the code:

the 'pygtk = True' in the ImportError clause looks odd because you're clobbering the name binding given by the 'import pygtk'. It would probably read easier if you changed that to 'has_pygtk = True'.

OTOH, the way it's often done in other places is to set 'pygtk = None' in the try: clause. You're 'if pygtk' tests will still work that way because the import statement will bind pygtk to the module object, which is not false.

Can you tighten up the bare except on line 130? If not, *please* add a comment explaining why the bare except is necessary.

Other than that, it's encouraging that it wasn't really that much code to add support for the three different regimes. Very nice!

[Martin Pitt (pitti)]

Ah, if we get an AttributeError after the "Gtk" repository is already imported, we can't import pygtk afterwards, so due to that we actually have to test for pygtk first. That will cause pygtk to be preferred, and the GI code to get much less exposure, but we can still locally patch that in Ubuntu, so it's not a biggie.

I added the bare "except:" on the indicator because ImportError is not the only probable exception here. gi.RepositoryError also can happen if the installed AppIndicator gir wasn't built against the version of GTK that gtimelog uses. There might be other causes I haven't thought about as well, but I guess those two are the main ones, so I tightened up the except statement.

I addressed the other things as well.

review: Needs Resubmitting

[Marius Gedminas (mgedmin)]

Thanks, merged!

[lp:~pitti/gtimelog/pygi]

181. By Marius Gedminas on 2011-01-31

Support PyGI/PyGObject when PyGtk is not available.

=== modified file 'HACKING.txt'
--- HACKING.txt	2011-01-08 14:38:47 +0000
+++ HACKING.txt	2011-01-29 10:43:14 +0000
@@ -26,7 +26,8 @@
 Here's how you can create and send me a a patch.  You'll need the `Bazaar
 <http://bazaar.canonical.com/en/>`_ version control system installed on your
 computer, as well as the usual stuff needed to run GTimeLog (`Python
-<http://python.org/>`_, `PyGtk <http://pygtk.org/>`_).
+<http://python.org/>`_, and `PyGtk <http://pygtk.org/>`_ or the GTK and Pango
+gobject-introspection typelibs).
 
 First, get a copy of the source code::
 

=== modified file 'NEWS.txt'
--- NEWS.txt	2011-01-28 13:58:01 +0000
+++ NEWS.txt	2011-01-29 10:43:14 +0000
@@ -12,6 +12,16 @@
   src/gtimelog/gtimelog.ui.  It needs to be installed into
   /usr/share/gtimelog/.
 
+* Ported from PyGTK to GI. This supports GTK 2 and GTK 3 with GI now, but still
+  works with PyGTK.
+
+  Packager's note: If you want to use GI, you need to change the package's
+  dependencies from pygtk to the package that provides the GTK and Pango
+  typelibs (e. g. gir1.2-gtk-2.0 and gir1.2-pango-1.0 on Debian/Ubuntu). It
+  also requires pygobject >= 2.27.1.
+
+  Contributed by Martin Pitt <[e-mail]>.
+
 * GTimeLog now supports Ubuntu's application indicators.  There's a new
   configuration option, ``prefer_app_indicator``, defaulting to true.
   Fixes LP: #523461.

=== modified file 'src/gtimelog/main.py'
--- src/gtimelog/main.py	2011-01-28 13:53:34 +0000
+++ src/gtimelog/main.py	2011-01-29 10:43:14 +0000
@@ -15,11 +15,34 @@
 import ConfigParser
 from operator import itemgetter
 
-import pygtk
-pygtk.require('2.0')
 import gobject
-import gtk
-import pango
+
+# we have to try pygtk first, then fall back to GI; if we have a too old GI
+# (without require_version()), we can't import pygtk on top of gi.repo.Gtk.
+try:
+    import pygtk
+    pygtk.require('2.0')
+    import gtk
+    from gtk import gdk as gdk
+    import pango
+
+    PANGO_ALIGN_LEFT = pango.TAB_LEFT
+    GTK_RESPONSE_OK = gtk.RESPONSE_OK
+    gtk_status_icon_new = gtk.status_icon_new_from_file
+    pango_tabarray_new = pango.TabArray
+except ImportError:
+    import gi
+    from gi.repository import Gdk as gdk
+    from gi.repository import Gtk as gtk
+    gtk.require_version('2.0')
+    from gi.repository import Pango as pango
+    pygtk = None
+
+    # these are hacks until we fully switch to GI
+    PANGO_ALIGN_LEFT = pango.TabAlign.LEFT
+    GTK_RESPONSE_OK = gtk.ResponseType.OK
+    gtk_status_icon_new = gtk.StatusIcon.new_from_file
+    pango_tabarray_new = pango.TabArray.new
 
 try:
     import dbus
@@ -995,6 +1018,10 @@
         # XXX assumes the panel's color matches a menu bar's color, which is
         # not necessarily the case!  this logic works for, say,
         # Ambiance/Radiance, but it gets New Wave and Dark Room wrong.
+        if not pygtk:
+            # XXX: need to figure out how to do that with gi
+            return icon_file_bright
+
         menu_text_color = gtk.MenuBar().rc_get_style().text[gtk.STATE_NORMAL]
         if menu_text_color.value >= 0.5:
             return icon_file_bright
@@ -1012,7 +1039,7 @@
         if not hasattr(gtk, 'StatusIcon'):
             # you must be using a very old PyGtk
             return
-        self.icon = gtk.status_icon_new_from_file(self.icon_name)
+        self.icon = gtk_status_icon_new(self.icon_name)
         self.last_tick = False
         self.tick()
         self.icon.connect("activate", self.on_activate)
@@ -1049,7 +1076,7 @@
 
     def tick(self):
         """Tick every second."""
-        self.icon.set_tooltip(self.tip())
+        self.icon.set_tooltip_text(self.tip())
         return True
 
     def tip(self):
@@ -1075,14 +1102,24 @@
         self.gtimelog_window = gtimelog_window
         self.timelog = gtimelog_window.timelog
         self.indicator = None
-        try:
-            import appindicator
-        except ImportError:
-            return # nothing to do here, move along
+        if pygtk:
+            try:
+                import appindicator
+                self.indicator = appindicator.Indicator("gtimelog", self.icon_name,
+                                            appindicator.CATEGORY_APPLICATION_STATUS)
+                self.indicator.set_status(appindicator.STATUS_ACTIVE)
+            except ImportError:
+                return # nothing to do here, move along
                    # or install python-appindicator
-        self.indicator = appindicator.Indicator("gtimelog", self.icon_name,
-                                    appindicator.CATEGORY_APPLICATION_STATUS)
-        self.indicator.set_status(appindicator.STATUS_ACTIVE)
+        else:
+            try:
+                from gi.repository import AppIndicator
+                self.indicator = AppIndicator.Indicator.new("gtimelog", self.icon_name,
+                AppIndicator.IndicatorCategory.APPLICATION_STATUS)
+                self.indicator.set_status(AppIndicator.IndicatorStatus.ACTIVE)
+            except (ImportError, gi._gi.RepositoryError):
+                return
+
         self.indicator.set_menu(gtimelog_window.app_indicator_menu)
         self.gtimelog_window.tray_icon = self
         self.gtimelog_window.main_window.connect("style-set", self.on_style_set)
@@ -1304,9 +1341,9 @@
         """Set up tab stops in the log view."""
         pango_context = self.log_view.get_pango_context()
         em = pango_context.get_font_description().get_size()
-        tabs = pango.TabArray(2, False)
-        tabs.set_tab(0, pango.TAB_LEFT, 9 * em)
-        tabs.set_tab(1, pango.TAB_LEFT, 12 * em)
+        tabs = pango_tabarray_new(2, False)
+        tabs.set_tab(0, PANGO_ALIGN_LEFT, 9 * em)
+        tabs.set_tab(1, PANGO_ALIGN_LEFT, 12 * em)
         self.log_view.set_tabs(tabs)
 
     def w(self, text, tag=None):
@@ -1442,7 +1479,7 @@
     def scroll_to_end(self):
         buffer = self.log_view.get_buffer()
         end_mark = buffer.create_mark('end', buffer.get_end_iter())
-        self.log_view.scroll_to_mark(end_mark, 0)
+        self.log_view.scroll_to_mark(end_mark, 0, False, 0, 0)
         buffer.delete_mark(end_mark)
 
     def set_up_task_list(self):
@@ -1593,7 +1630,7 @@
 
         Returns either a datetime.date, or one.
         """
-        if self.calendar_dialog.run() == gtk.RESPONSE_OK:
+        if self.calendar_dialog.run() == GTK_RESPONSE_OK:
             y, m1, d = self.calendar.get_date()
             day = datetime.date(y, m1+1, d)
         else:
@@ -1603,7 +1640,7 @@
 
     def on_calendar_day_selected_double_click(self, widget):
         """Double-click on a calendar day: close the dialog."""
-        self.calendar_dialog.response(gtk.RESPONSE_OK)
+        self.calendar_dialog.response(GTK_RESPONSE_OK)
 
     def weekly_window(self, day=None):
         if not day:
@@ -1808,20 +1845,20 @@
 
     def task_entry_key_press(self, widget, event):
         """Handle key presses in task entry."""
-        if event.keyval == gtk.gdk.keyval_from_name('Prior'):
+        if event.keyval == gdk.keyval_from_name('Prior'):
             self._do_history(1)
             return True
-        if event.keyval == gtk.gdk.keyval_from_name('Next'):
+        if event.keyval == gdk.keyval_from_name('Next'):
             self._do_history(-1)
             return True
         # XXX This interferes with the completion box.  How do I determine
         # whether the completion box is visible or not?
         if self.have_completion:
             return False
-        if event.keyval == gtk.gdk.keyval_from_name('Up'):
+        if event.keyval == gdk.keyval_from_name('Up'):
             self._do_history(1)
             return True
-        if event.keyval == gtk.gdk.keyval_from_name('Down'):
+        if event.keyval == gdk.keyval_from_name('Down'):
             self._do_history(-1)
             return True
         return False