Merge pull request #961 from annie-xd-wang/945-pip-installable-plugins

945 pip installable plugins

Author: AdvancedImagingUTSW

src/navigate/config/config.py

@@ -38,14 +38,12 @@
 from pathlib import Path
 from os.path import isfile
 from multiprocessing.managers import ListProxy, DictProxy
-import inspect
 
 # Third Party Imports
 import yaml
 
 # Local Imports
-from navigate.tools.common_functions import build_ref_name, load_module_from_file
-from navigate.model.features import feature_related_functions
+from navigate.tools.common_functions import build_ref_name
 
 
 def get_navigate_path():
@@ -56,11 +54,6 @@ def get_navigate_path():
     -------
     str
         Path to Navigate home directory.
-
-    Examples
-    --------
-    >>> get_navigate_path()
-    'C:\\Users\\username\\AppData\\Local\\.navigate'
     """
     if platform.system() == "Windows":
         base_directory = os.getenv("LOCALAPPDATA")
@@ -172,14 +165,6 @@ def build_nested_dict(manager, parent_dict, key_name, dict_data):
         Name of dictionary to insert
     dict_data : dict
         Dictionary to insert
-
-    Returns
-    -------
-    None
-
-    Examples
-    --------
-    >>> build_nested_dict(manager, parent_dict, key_name, dict_data)
     """
     if type(dict_data) != dict and type(dict_data) != list:
         parent_dict[key_name] = dict_data
@@ -215,10 +200,6 @@ def update_config_dict(manager, parent_dict, config_name, new_config) -> bool:
     -------
     bool
         True or False
-
-    Examples
-    --------
-    >>> update_config_dict(manager, parent_dict, config_name, new_config)
     """
     if type(new_config) != dict and type(new_config) != list:
         file_path = str(new_config)
@@ -1098,23 +1079,3 @@ def verify_configuration(manager, configuration):
         "gui",
         {"channels": {"count": channel_count}},
     )
-
-
-def set_feature_attributes(plugin_path):
-    """Load feature module and set function attributes.
-
-    Parameters
-    ----------
-    plugin_path : str
-        The path to the plugins folder.
-    """
-    features_dir = os.path.join(plugin_path, "model", "features")
-    if os.path.exists(features_dir):
-        features = os.listdir(features_dir)
-        for feature in features:
-            feature_file = os.path.join(features_dir, feature)
-            if os.path.isfile(feature_file):
-                temp = load_module_from_file(feature, feature_file)
-                for c in dir(temp):
-                    if inspect.isclass(getattr(temp, c)):
-                        setattr(feature_related_functions, c, getattr(temp, c))

src/navigate/controller/sub_controllers/plugins.py

@@ -42,12 +42,12 @@
 from navigate.config.config import get_navigate_path
 from navigate.view.custom_widgets.popup import PopUp
 from navigate.tools.file_functions import load_yaml_file, save_yaml_file
-from navigate.tools.common_functions import combine_funcs, load_module_from_file
+from navigate.tools.common_functions import combine_funcs
 from navigate.tools.decorators import AcquisitionMode
-from navigate.model.features import feature_related_functions
 from navigate.controller.sub_controllers.gui import GUIController
 from navigate.view.popups.plugins_popup import PluginsPopup
-from navigate.config import set_feature_attributes
+
+from navigate.plugins.plugin_manager import PluginFileManager, PluginPackageManager
 
 
 class PluginsController:
@@ -69,11 +69,6 @@ def __init__(self, view, parent_controller):
         #: object: navigate controller.
         self.parent_controller = parent_controller
 
-        #: str: plugins default path.
-        self.plugins_path = os.path.join(
-            Path(__file__).resolve().parent.parent.parent, "plugins"
-        )
-
         #: dict: installed plugins with GUI
         self.plugins_dict = {}
 
@@ -87,115 +82,61 @@ def populate_experiment_setting(self):
 
     def load_plugins(self):
         """Load plugins"""
-        plugins = os.listdir(self.plugins_path)
-        installed_plugins = dict(
-            [(f, os.path.join(self.plugins_path, f)) for f in plugins]
+        # load through files
+        plugins_path = os.path.join(
+            Path(__file__).resolve().parent.parent.parent, "plugins"
         )
-        # load plugins from plugins_config
         plugins_config_path = os.path.join(
             get_navigate_path(), "config", "plugins_config.yml"
         )
-        plugins_config = load_yaml_file(plugins_config_path)
-        if plugins_config is None:
-            plugins_config = {}
-            save_yaml_file(get_navigate_path(), {}, "plugins_config.yml")
-        else:
-            for plugin_name, plugin_path in plugins_config.items():
-                if plugin_path and os.path.exists(plugin_path):
-                    installed_plugins[plugin_name] = plugin_path
-        for _, plugin_path in installed_plugins.items():
-            if not os.path.isdir(plugin_path):
-                continue
+        plugin_file_manager = PluginFileManager(plugins_path, plugins_config_path)
+        self.load_plugins_through_manager(plugin_file_manager)
+        self.load_plugins_through_manager(PluginPackageManager)
+
+    def load_plugins_through_manager(self, plugin_manager):
+        """Load plugins through plugin manager
+
+        Parameters
+        ----------
+        plugin_manager : object
+            PluginManager object
+        """
+        plugins = plugin_manager.get_plugins()
+
+        for plugin_name, plugin_ref in plugins.items():
 
             # read "plugin_config.yml"
-            plugin_config = load_yaml_file(
-                os.path.join(plugin_path, "plugin_config.yml")
-            )
+            plugin_config = plugin_manager.load_config(plugin_ref)
             if plugin_config is None:
                 continue
-            plugin_name = plugin_config.get("name", _)
-            plugin_file_name = "_".join(plugin_name.lower().split())
-            plugin_class_name = "".join(plugin_name.title().split())
-            if "view" in plugin_config:
-                # verify if "frame_name" and "file_name" are given and correct
-                view_file = os.path.join(
-                    plugin_path, "view", f"{plugin_file_name}_frame.py"
-                )
-                controller_file = os.path.join(
-                    plugin_path,
-                    "controller",
-                    f"{plugin_file_name}_controller.py",
-                )
-                if (
-                    os.path.exists(view_file)
-                    and os.path.isfile(view_file)
-                    and os.path.exists(controller_file)
-                    and os.path.isfile(controller_file)
-                ):
-                    plugin_frame_module = load_module_from_file(
-                        f"{plugin_class_name}Frame", view_file
-                    )
-                    if plugin_frame_module is None:
-                        print(
-                            f"Make sure that the plugin frame name "
-                            f"{plugin_class_name} is correct! "
-                            f"Plugin {plugin_name} needs to be uninstalled from "
-                            f"navigate or reinstalled!"
-                        )
-                        continue
-                    plugin_frame = getattr(
-                        plugin_frame_module, f"{plugin_class_name}Frame"
-                    )
-                    plugin_controller_module = load_module_from_file(
-                        f"{plugin_class_name}Controller", controller_file
-                    )
-                    if plugin_controller_module is None:
-                        print(
-                            f"Make sure that the plugin controller "
-                            f"{plugin_class_name} is correct! "
-                            f"Plugin {plugin_name} needs to be uninstalled from "
-                            f"navigate or reinstalled!"
-                        )
-                        continue
-                    plugin_controller = getattr(
-                        plugin_controller_module, f"{plugin_class_name}Controller"
-                    )
+            plugin_display_name = plugin_config.get("name", plugin_name)
+
+            plugin_frame = plugin_manager.load_view(plugin_ref, plugin_display_name)
+            plugin_controller = plugin_manager.load_controller(
+                plugin_ref, plugin_display_name
+            )
 
-                    if plugin_config["view"] == "Popup":
-                        # menu
-                        self.parent_controller.view.menubar.menu_plugins.add_command(
-                            label=plugin_name,
-                            command=self.build_popup_window(
-                                plugin_name, plugin_frame, plugin_controller
-                            ),
-                        )
-                    else:
-                        self.build_tab_window(
+            if plugin_frame and plugin_controller:
+                if plugin_config["view"] == "Popup":
+                    # menu
+                    self.parent_controller.view.menubar.menu_plugins.add_command(
+                        label=plugin_name,
+                        command=self.build_popup_window(
                             plugin_name, plugin_frame, plugin_controller
-                        )
+                        ),
+                    )
+                else:
+                    self.build_tab_window(plugin_name, plugin_frame, plugin_controller)
             # feature
-            set_feature_attributes(plugin_path)
+            plugin_manager.load_features(plugin_ref)
 
             # acquisition mode
             acquisition_modes = plugin_config.get("acquisition_modes", [])
-            for acquisition_mode_config in acquisition_modes:
-                acquisition_file = os.path.join(
-                    plugin_path, acquisition_mode_config["file_name"]
-                )
-                if os.path.exists(acquisition_file):
-                    module = load_module_from_file(
-                        acquisition_mode_config["file_name"][:-3], acquisition_file
-                    )
-                    acquisition_mode = [
-                        m
-                        for m in dir(module)
-                        if isinstance(getattr(module, m), AcquisitionMode)
-                    ]
-                    if acquisition_mode:
-                        self.parent_controller.add_acquisition_mode(
-                            acquisition_mode_config["name"],
-                            getattr(module, acquisition_mode[0]),
-                        )
+            plugin_manager.load_acquisition_modes(
+                plugin_ref,
+                acquisition_modes,
+                self.register_acquisition_mode,
+            )
 
     def build_tab_window(self, plugin_name, frame, controller):
         """Build tab for a plugin
@@ -220,11 +161,12 @@ def build_tab_window(self, plugin_name, frame, controller):
                 "__plugin" + "_".join(plugin_name.lower().split()) + "_controller"
             )
             self.plugins_dict[controller_name] = plugin_controller
-        except Exception:
+        except Exception as e:
             messagebox.showwarning(
                 title="Warning",
                 message=(
                     f"Plugin {plugin_name} has something went wrong."
+                    f"Error: {e}"
                     f"Please make sure the plugin works correctly or uninstall it!"
                 ),
             )
@@ -295,6 +237,27 @@ def func_with_wrapper(*args, **kwargs):
 
         return func_with_wrapper
 
+    def register_acquisition_mode(self, acquisition_mode_name, module):
+        """Register acquisition mode
+
+        Parameters
+        ----------
+        acquisition_mode_name : str
+            The name of an acquisition mode
+        module : module
+            acquisition mode module
+        """
+        if not module:
+            return
+        acquisition_mode = [
+            m for m in dir(module) if isinstance(getattr(module, m), AcquisitionMode)
+        ]
+        if acquisition_mode:
+            self.parent_controller.add_acquisition_mode(
+                acquisition_mode_name,
+                getattr(module, acquisition_mode[0]),
+            )
+
 
 class UninstallPluginController(GUIController):
     """Uninstall plugin controller"""