Pligins refactor with new context and controller integration

src/plugins/plugin_base.py

@@ -1,92 +1,49 @@
 # Python imports
-import os
-import time
-import inspect
 
 # Lib imports
 
 # Application imports
+from libs.dto.base_event import BaseEvent
+
+from .plugin_context import PluginContext
+
 
 
 class PluginBaseException(Exception):
     ...
 
 
+
 class PluginBase:
-    def __init__(self, **kwargs):
-        super().__init__(**kwargs)
-        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
+    def __init__(self, *args, **kwargs):
+        super(PluginBase, self).__init__(*args, **kwargs)
 
-        self._builder      = None
-        self._ui_objects   = None
-        self._event_system = None
+        self.plugin_context: PluginContext = None
 
 
+    def _controller_message(self):
+        raise PluginBaseException("Plugin Base '_controller_message' must be overriden by Plugin")
+
+    def load(self):
+        raise PluginBaseException("Plugin Base 'load' must be overriden by Plugin")
+
     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...")
+        raise PluginBaseException("Plugin Base 'run' must be overriden by Plugin")
 
-    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 requests_ui_element(self, element_id: str):
+        return self.plugin_context.requests_ui_element(element_id)
 
-    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 message(self, event: BaseEvent):
+        return self.plugin_context.message(event)
 
-    def set_event_system(self, event_system):
-        """
-            Requests Key:  'pass_events': true
-            Must define in plugin if "pass_events" is set to true.
-        """
-        self._event_system = event_system
+    def message_to(self, name: str, event: BaseEvent):
+        return self.plugin_context.message_to(name, event)
 
-    def subscribe_to_events(self):
-        ...
+    def message_to_selected(self, names: list[str], event: BaseEvent):
+        return self.plugin_context.message_to_selected(names, event)
 
-    def _connect_builder_signals(self, caller_class, builder):
-        classes  = [caller_class]
-        handlers = {}
-        for c in classes:
-            methods = None
-            try:
-                methods = inspect.getmembers(c, predicate=inspect.ismethod)
-                handlers.update(methods)
-            except Exception as e:
-                logger.debug(repr(e))
+    def emit(self, event_type: str, data: tuple = ()):
+        self.plugin_context.emit(event_type, data)
 
-        builder.connect_signals(handlers)
-
-    def reload_package(self, plugin_path, module_dict_main=locals()):
-        import importlib
-        from pathlib import Path
-
-        def reload_package_recursive(current_dir, module_dict):
-            for path in current_dir.iterdir():
-                if "__init__" in str(path) or path.stem not in module_dict:
-                    continue
-
-                if path.is_file() and path.suffix == ".py":
-                    importlib.reload(module_dict[path.stem])
-                elif path.is_dir():
-                    reload_package_recursive(path, module_dict[path.stem].__dict__)
-
-        reload_package_recursive(Path(plugin_path).parent, module_dict_main["module_dict_main"])
-
-
-    def clear_children(self, widget: type) -> None:
-        """ Clear children of a gtk widget. """
-        for child in widget.get_children():
-            widget.remove(child)
+    def emit_and_await(self, event_type: str, data: tuple = ()):
+        self.plugin_context.emit_and_await(event_type, data)