Refactored to reduce Glade dependency...

src/plugins/manifest.py

@@ -52,9 +52,9 @@ class ManifestProcessor:
         requests     = self._plugin.requests
         keys         = requests.keys()
 
-        if "pass_fm_events" in keys:
-            if requests["pass_fm_events"] in ["true"]:
-                loading_data["pass_fm_events"] = True
+        if "pass_events" in keys:
+            if requests["pass_events"] in ["true"]:
+                loading_data["pass_events"] = True
 
         if "bind_keys" in keys:
             if isinstance(requests["bind_keys"], list):

src/plugins/plugin_base.py

@@ -0,0 +1,60 @@
+# Python imports
+import os, time
+
+# Lib imports
+
+# Application imports
+
+
+class PluginBaseException(Exception):
+    ...
+
+
+class PluginBase:
+    def __init__(self):
+        self.name               = "Example Plugin"  # NOTE: Need to remove after establishing private bidirectional 1-1 message bus
+                                                    #       where self.name should not be needed for message comms
+
+        self._builder           = None
+        self._ui_objects        = None
+        self._event_system      = None
+
+
+    def run(self):
+        """
+            Must define regardless if needed and can 'pass' if plugin doesn't need it.
+            Is intended to be used to setup internal signals or custom Gtk Builders/UI logic.
+        """
+        raise PluginBaseException("Method hasn't been overriden...")
+
+    def generate_reference_ui_element(self):
+        """
+            Requests Key:  'ui_target': "plugin_control_list",
+            Must define regardless if needed and can 'pass' if plugin doesn't use it.
+            Must return a widget if "ui_target" is set.
+        """
+        raise PluginBaseException("Method hasn't been overriden...")
+
+    def set_event_system(self, event_system):
+        """
+            Requests Key:  'pass_events': "true"
+            Must define in plugin if "pass_events" is set to "true" string.
+        """
+        self._event_system = event_system
+
+    def set_ui_object_collection(self, ui_objects):
+        """
+            Requests Key:  "pass_ui_objects": [""]
+            Request reference to a UI component. Will be passed back as array to plugin.
+            Must define in plugin if set and an array of valid glade UI IDs is given.
+        """
+        self._ui_objects = ui_objects
+
+    def subscribe_to_events(self):
+        ...
+
+
+    def clear_children(self, widget: type) -> None:
+        """ Clear children of a gtk widget. """
+        for child in widget.get_children():
+            widget.remove(child)

src/plugins/plugins_controller.py

@@ -17,17 +17,15 @@ class InvalidPluginException(Exception):
     ...
 
 
-class Plugins:
-    """Plugins controller"""
+class PluginsController:
+    """PluginsController controller"""
 
-    def __init__(self, settings: type):
+    def __init__(self):
         path                      = os.path.dirname(os.path.realpath(__file__))
         sys.path.insert(0, path)  # NOTE: I think I'm not using this correctly...
 
-        self._settings            = settings
-        self._builder             = self._settings.get_builder()
-        self._plugins_path        = self._settings.get_plugins_path()
-        self._keybindings         = self._settings.get_keybindings()
+        self._builder             = settings.get_builder()
+        self._plugins_path        = settings.get_plugins_path()
 
         self._plugins_dir_watcher = None
         self._plugin_collection   = []
@@ -72,23 +70,41 @@ class Plugins:
 
     def load_plugin_module(self, path, folder, target):
         os.chdir(path)
-        spec   = importlib.util.spec_from_file_location(folder, target, submodule_search_locations=path)
+
+        locations = []
+        self.collect_search_locations(path, locations)
+
+        spec   = importlib.util.spec_from_file_location(folder, target, submodule_search_locations = locations)
         module = importlib.util.module_from_spec(spec)
         sys.modules[folder] = module
         spec.loader.exec_module(module)
 
         return module
 
+    def collect_search_locations(self, path, locations):
+        locations.append(path)
+        for file in os.listdir(path):
+            _path = os.path.join(path, file)
+            if os.path.isdir(_path):
+                self.collect_search_locations(_path, locations)
 
     def execute_plugin(self, module: type, plugin: Plugin, loading_data: []):
         plugin.reference = module.Plugin()
         keys             = loading_data.keys()
 
-        if "pass_fm_events" in keys:
+        if "ui_target" in keys:
+            loading_data["ui_target"].add( plugin.reference.generate_reference_ui_element() )
+            loading_data["ui_target"].show_all()
+
+        if "pass_ui_objects" in keys:
+            plugin.reference.set_ui_object_collection( loading_data["pass_ui_objects"] )
+
+        if "pass_events" in keys:
             plugin.reference.set_fm_event_system(event_system)
+            plugin.reference.subscribe_to_events()
 
         if "bind_keys" in keys:
-            self._keybindings.append_bindings( loading_data["bind_keys"] )
+            keybindings.append_bindings( loading_data["bind_keys"] )
 
         plugin.reference.run()
         self._plugin_collection.append(plugin)