feat(linux): address code review comments of #3278

keymanapp · Jun 25, 2020 · f6840a8 · f6840a8
1 parent 7c9b13d
commit f6840a8
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/linux/keyman-config/keyman_config/gnome_keyboards_util.py b/linux/keyman-config/keyman_config/gnome_keyboards_util.py
@@ -24,10 +24,10 @@ def _convert_variant_to_array(self, variant):
             return []
 
         values = []
-        # a(ss)
+        # Process variant of type "a(ss)" (array of tuples with two strings)
         nChildren = variant.n_children()
         for i in range(nChildren):
-            # (ss)
+            # Process variant of type "(ss)" (tuple with two strings)
             val = variant.get_child_value(i)
             typeVariant = val.get_child_value(0)
             type = typeVariant.get_string()
@@ -68,7 +68,7 @@ def _reset_gnome_shell():
     __is_gnome_shell = None
 
 
-def get_keyboard_id(keyboard, packageDir, ignore_language=False):
+def get_ibus_keyboard_id(keyboard, packageDir, ignore_language=False):
     kmx_file = os.path.join(packageDir, keyboard['id'] + ".kmx")
     if not ignore_language and "languages" in keyboard and len(keyboard["languages"]) > 0:
         logging.debug(keyboard["languages"][0])

diff --git a/linux/keyman-config/keyman_config/install_kmp.py b/linux/keyman-config/keyman_config/install_kmp.py
@@ -13,7 +13,7 @@
 from keyman_config.convertico import extractico, checkandsaveico
 from keyman_config.kvk2ldml import convert_kvk_to_ldml, output_ldml
 from keyman_config.ibus_util import install_to_ibus, restart_ibus, get_ibus_bus
-from keyman_config.gnome_keyboards_util import GnomeKeyboardsUtil, get_keyboard_id, is_gnome_shell
+from keyman_config.gnome_keyboards_util import GnomeKeyboardsUtil, get_ibus_keyboard_id, is_gnome_shell
 
 # TODO userdir install
 # special processing for kmn if needed
@@ -263,8 +263,8 @@ def install_keyboards_to_ibus(keyboards, packageDir):
     if bus:
         # install all kmx for first lang not just packageID
         for kb in keyboards:
-            keyboard_id = get_keyboard_id(kb, packageDir)
-            install_to_ibus(bus, keyboard_id)
+            ibus_keyboard_id = get_ibus_keyboard_id(kb, packageDir)
+            install_to_ibus(bus, ibus_keyboard_id)
         restart_ibus(bus)
         bus.destroy()
     else:
@@ -277,8 +277,8 @@ def install_keyboards_to_gnome(keyboards, packageDir):
 
     # install all kmx for first lang not just packageID
     for kb in keyboards:
-        keyboard_id = get_keyboard_id(kb, packageDir)
-        sources.append(('ibus', keyboard_id))
+        ibus_keyboard_id = get_ibus_keyboard_id(kb, packageDir)
+        sources.append(('ibus', ibus_keyboard_id))
 
     gnomeKeyboardsUtil.write_input_sources(sources)
 

diff --git a/linux/keyman-config/keyman_config/uninstall_kmp.py b/linux/keyman-config/keyman_config/uninstall_kmp.py
@@ -7,7 +7,7 @@
 from keyman_config.get_kmp import user_keyboard_dir, user_keyman_font_dir
 from keyman_config.kmpmetadata import get_metadata
 from keyman_config.ibus_util import uninstall_from_ibus, get_ibus_bus, restart_ibus
-from keyman_config.gnome_keyboards_util import GnomeKeyboardsUtil, get_keyboard_id, is_gnome_shell
+from keyman_config.gnome_keyboards_util import GnomeKeyboardsUtil, get_ibus_keyboard_id, is_gnome_shell
 
 
 def uninstall_kmp_shared(packageID):
@@ -69,8 +69,8 @@ def uninstall_keyboards_from_ibus(keyboards, packageDir):
     if bus:
         # install all kmx for first lang not just packageID
         for kb in keyboards:
-            keyboard_id = get_keyboard_id(kb, packageDir)
-            uninstall_from_ibus(bus, keyboard_id)
+            ibus_keyboard_id = get_ibus_keyboard_id(kb, packageDir)
+            uninstall_from_ibus(bus, ibus_keyboard_id)
         restart_ibus(bus)
     else:
         logging.warning("could not uninstall keyboards from IBus")
@@ -82,13 +82,13 @@ def uninstall_keyboards_from_gnome(keyboards, packageDir):
 
     # uninstall all kmx for all languages
     for kb in keyboards:
-        keyboard_id = get_keyboard_id(kb, packageDir)
-        tuple = ('ibus', keyboard_id)
+        ibus_keyboard_id = get_ibus_keyboard_id(kb, packageDir)
+        tuple = ('ibus', ibus_keyboard_id)
         if tuple in sources:
             sources.remove(tuple)
 
         toRemove = []
-        match_id = ":%s" % get_keyboard_id(kb, packageDir, True)
+        match_id = ":%s" % get_ibus_keyboard_id(kb, packageDir, True)
         for (type, id) in sources:
             if type == 'ibus' and id.endswith(match_id):
                 toRemove.append((type, id))