Pylance Fixes (#178)

* Pylance: menulibre/util.py

* Pylance: menulibre/ActionEditor.py

* Pylance: menulibre/CategoryEditor.py

* Pylance: menulibre/CommandEditor.py

* Pylance: menulibre/FileHandler.py

* Pylance: menulibre/FilenameLabel.py

* Pylance: menulibre/Headerbar.py

* Pylance: menulibre/IconEntry.py

* Pylance: menulibre/LabelWithHidingButton.py

* Pylance: menulibre/MenuEditor.py

* Pylance: menulibre/MenulibreApplication.py

* Pylance: menulibre/MenulibreTreeview.py

* Pylance: menulibre/ParsingErrorsDialog.py

* Pylance: menulibre/StartupWmClassEntry.py

* Pylance: menulibre/XmlMenuElementTree.py

* Pylance: Remaining files

* Appropriately (un)escape Comment

* Better handling of required name/comment fields

Author: bluesabre

NEWS

@@ -4,6 +4,8 @@ MenuLibre                                                                  NEWS
 
 - All Glade and GtkBuilder usage has been replaced with native Python and GTK
   code. This simplifies future updates and enables porting to newer toolkits.
+- All code was processed with Pylance to identify and resolve various unknown
+  and potential bugs.
 - New Features:
   . Label tooltips have been replaced by a new, on-demand help button.
     Clicking this button will show a dialog with more information and links.

bin/menulibre

@@ -24,7 +24,7 @@ import signal
 
 import gi
 gi.require_version('Gtk', '3.0')
-from gi.repository import Gtk
+from gi.repository import Gtk  # type: ignore
 
 # Check GTK Version, minimum required is 3.10
 if Gtk.check_version(3,10,0):

bin/menulibre-menu-validate

@@ -33,7 +33,7 @@ gi.require_version('GMenu', '3.0')
 gi.require_version('Gtk', '3.0')  # This seems to be needed for imported
                                   # menulibre code
 
-from gi.repository import GMenu
+from gi.repository import GMenu  # type: ignore
 
 
 # As with the main script, need to mess with the path to access menulibre code

menulibre/ActionEditor.py

@@ -20,7 +20,7 @@
 
 import gi
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GObject
+from gi.repository import Gtk, GObject  # type: ignore
 
 
 COL_SHOW = 0
@@ -41,7 +41,7 @@ def __init__(self):
         scrolled.set_shadow_type(Gtk.ShadowType.IN)
         self.pack_start(scrolled, True, True, 0)
 
-        self._liststore = Gtk.ListStore.new([bool, str, str, str])
+        self._liststore = Gtk.ListStore.new([bool, str, str, str])  # type: ignore
 
         treeview = Gtk.TreeView.new_with_model(self._liststore)
         treeview.set_enable_search(False)
@@ -53,23 +53,23 @@ def __init__(self):
         renderer.connect("toggled", self._on_toggle_changed)
 
         # Translators: "Show" tree column header
-        col = Gtk.TreeViewColumn(_("Show"), renderer, active=COL_SHOW)
+        col = Gtk.TreeViewColumn(_("Show"), renderer, active=COL_SHOW)  # type: ignore
         treeview.append_column(col)
 
         renderer = Gtk.CellRendererText()
         renderer.set_property("editable", True)
         renderer.connect('edited', self._on_edited, COL_DISPLAYED)
 
         # Translators: "Name" tree column header
-        col = Gtk.TreeViewColumn(_("Name"), renderer, text=COL_DISPLAYED)
+        col = Gtk.TreeViewColumn(_("Name"), renderer, text=COL_DISPLAYED)  # type: ignore
         treeview.append_column(col)
 
         renderer = Gtk.CellRendererText()
         renderer.set_property("editable", True)
         renderer.connect('edited', self._on_edited, COL_COMMAND)
 
         # Translators: "Command" tree column header
-        col = Gtk.TreeViewColumn(_("Command"), renderer, text=COL_COMMAND)
+        col = Gtk.TreeViewColumn(_("Command"), renderer, text=COL_COMMAND)  # type: ignore
         treeview.append_column(col)
 
         toolbar = Gtk.Toolbar.new()
@@ -164,7 +164,7 @@ def _toggle_move_buttons(
         try:
             model, [path] = treeview.get_selection().get_selected_rows()
         except ValueError:
-            path = None
+            model = path = None
 
         can_up = False
         can_down = False

menulibre/AdvancedPage.py

@@ -23,7 +23,7 @@
 
 import gi
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GObject
+from gi.repository import Gtk, GObject  # type: ignore
 
 
 class AdvancedPage(Gtk.ScrolledWindow):
@@ -32,7 +32,7 @@ class AdvancedPage(Gtk.ScrolledWindow):
     }
 
     def __init__(self, use_headerbar):
-        super().__init__(hadjustment=None, vadjustment=None)
+        super().__init__(hadjustment=None, vadjustment=None)  # type: ignore
 
         self._row_index = 0
         self._widgets = {}

menulibre/ApplicationEditor.py

@@ -32,7 +32,7 @@
 
 import gi
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GObject
+from gi.repository import Gtk, GObject  # type: ignore
 
 
 class ApplicationEditor(Gtk.Box):
@@ -70,15 +70,15 @@ def __init__(self, use_headerbar):
         hbox.pack_start(namebox, True, True, 0)
 
         self._name_entry = TextEntryButton(
-            'Name',
+            property_name='Name',
             bold_font=True,
             required=True,
             placeholder_text=_('Add name'))
         self._name_entry.connect("value-changed", self._on_changed)
         namebox.pack_start(self._name_entry, True, True, 0)
 
         self._comment_entry = TextEntryButton(
-            'Comment', placeholder_text=_('Add comment'))
+            property_name='Comment', placeholder_text=_('Add comment'))
         self._comment_entry.connect("value-changed", self._on_changed)
         namebox.pack_start(self._comment_entry, True, True, 0)
 

menulibre/CategoryEditor.py

@@ -21,7 +21,7 @@
 
 import gi
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GObject
+from gi.repository import Gtk, GObject  # type: ignore
 
 
 # Sourced from https://specifications.freedesktop.org/menu-spec/latest/apa.html
@@ -406,6 +406,8 @@ def lookup_vendor_category_description(spec_name):
         unvendored = spec_name[10:]
     elif spec_name.startswith("X-"):
         unvendored = "-".join(spec_name.split("-")[2:])
+    else:
+        unvendored = spec_name
 
     try:
         description = category_descriptions[unvendored]
@@ -463,9 +465,9 @@ def __init__(self):
         scrolled.set_shadow_type(Gtk.ShadowType.IN)
         self.pack_start(scrolled, True, True, 0)
 
-        self._options = Gtk.TreeStore.new([str, str, str, str])
+        self._options = Gtk.TreeStore.new([str, str, str, str])  # type: ignore
         self._options.set_sort_column_id(3, Gtk.SortType.ASCENDING)
-        self._treestore = Gtk.TreeStore.new([str, str, str])
+        self._treestore = Gtk.TreeStore.new([str, str, str])  # type: ignore
 
         self._section_lookup = {}
         self._category_lookup = {}
@@ -488,13 +490,13 @@ def __init__(self):
         renderer.connect("changed", self._on_combo_changed)
 
         # Translators: "Category Name" tree column header
-        col = Gtk.TreeViewColumn(_("Category Name"), renderer, text=COL_DESC)
+        col = Gtk.TreeViewColumn(_("Category Name"), renderer, text=COL_DESC)  # type: ignore
         treeview.append_column(col)
 
         renderer = Gtk.CellRendererText()
 
         # Translators: "Section" tree column header
-        col = Gtk.TreeViewColumn(_("Section"), renderer, text=COL_SECTION)
+        col = Gtk.TreeViewColumn(_("Section"), renderer, text=COL_SECTION)  # type: ignore
         treeview.append_column(col)
 
         toolbar = Gtk.Toolbar.new()

menulibre/CommandEditor.py

@@ -22,14 +22,14 @@
 
 import gi
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gio, GObject, GLib, Pango, Gdk
+from gi.repository import Gtk, Gio, GObject, GLib, Pango, Gdk  # type: ignore
 
 
 class CommandEditorDialog(Gtk.Dialog):
 
     def __init__(self, parent, initial_text, use_header_bar):
         super().__init__(title=_("Command Editor"), transient_for=parent,
-                         use_header_bar=use_header_bar, flags=0)
+                         use_header_bar=use_header_bar, flags=0)  # type: ignore
         self.add_buttons(
             _('Cancel'), Gtk.ResponseType.CANCEL,
             _('Apply'), Gtk.ResponseType.OK
@@ -129,16 +129,7 @@ def __init__(self, uri, label):
         super().__init__(uri=uri)
 
         self.set_label(label)
-
-        screen = Gdk.Screen.get_default()
-        provider = Gtk.CssProvider()
-        style_context = Gtk.StyleContext()
-        style_context.add_provider_for_screen(
-            screen, provider, Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION)
-        provider.load_from_data("#helpbutton {padding: 0;}".encode())
-
         self.set_name('helpbutton')
-
         self.set_halign(Gtk.Align.START)
 
 
@@ -408,15 +399,15 @@ def on_entry_changed(self, widget, revert_button, clear_button):
             field = (True, _('No invalid field codes'))
 
         if env != self.state['env']:
-            self.state['env'] = env
+            self.state['env'] = env  # type: ignore
             self.emit('env-state-changed', env[0], env[1])
 
         if cmd != self.state['cmd']:
-            self.state['cmd'] = cmd
+            self.state['cmd'] = cmd  # type: ignore
             self.emit('cmd-state-changed', cmd[0], cmd[1])
 
         if field != self.state['field']:
-            self.state['field'] = field
+            self.state['field'] = field  # type: ignore
             self.emit('field-state-changed', field[0], field[1])
 
 
@@ -693,7 +684,7 @@ class AppChooserMenu(Gtk.ComboBox):
     def __init__(self):
         super().__init__()
 
-        store = Gtk.ListStore.new([str, str, Gio.Icon])
+        store = Gtk.ListStore.new([str, str, Gio.Icon])  # type: ignore
         store.append([_("Select an application"), None, None])
 
         app_list = []
@@ -736,7 +727,7 @@ def get_executable(self):
         treeiter = self.get_active_iter()
         if treeiter is None:
             return None
-        row = treemodel[treeiter][:]
+        row = treemodel[treeiter][:]  # type: ignore
         return row[1]
 
 

menulibre/Dialogs.py

@@ -19,7 +19,7 @@
 
 from locale import gettext as _
 
-from gi.repository import Gtk
+from gi.repository import Gtk  # type: ignore
 
 import menulibre_lib
 

menulibre/FieldLabel.py

@@ -22,7 +22,7 @@
 
 import gi
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Pango, GObject
+from gi.repository import Gtk, Pango, GObject  # type: ignore
 
 
 class FieldLabel(LabelWithHidingButton):
@@ -76,13 +76,13 @@ def __init__(self, parent, key_name, description, help_text, help_url):
         self.format_secondary_markup(secondary)
 
         message_area = self.get_content_area().get_children()[0]
-        if isinstance(message_area.get_children()[0], Gtk.Image):
-            message_area.get_children()[0].destroy()
+        if isinstance(message_area.get_children()[0], Gtk.Image):  # type: ignore
+            message_area.get_children()[0].destroy()  # type: ignore
 
         if help_text:
             button = self.add_button(help_text, Gtk.ResponseType.HELP)
             bbox = self.get_action_area()
-            bbox.set_child_secondary(button, True)
+            bbox.set_child_secondary(button, True)  # type: ignore
 
         self.connect("response", self.response_cb, help_url)