Merge pull request #596 from nicola-corbellini/feature/plugin_hooks

Add event on plugin de-/activation

core/cat/mad_hatter/core_plugin/settings.py

@@ -77,4 +77,28 @@ def save_settings(settings):
     """
 
     # In core_plugin we do nothing (for now).
-    return {}
+    return {}
+
+
+@plugin
+def activated(plugin):
+    """This method allows executing custom code right after a plugin is activated.
+
+    Parameters
+    ----------
+    plugin
+        Plugin: Cat object representing the plugin instance in memory.
+    """
+    return None
+
+
+@plugin
+def deactivated(plugin):
+    """This method allows executing custom code right after a plugin is deactivated.
+
+    Parameters
+    ----------
+    plugin
+        Plugin: Cat object representing the plugin instance in memory.
+    """
+    return None

core/cat/mad_hatter/mad_hatter.py

@@ -180,14 +180,31 @@ def toggle_plugin(self, plugin_id):
             # update list of active plugins
             if plugin_is_active:
                 log.warning(f"Toggle plugin {plugin_id}: Deactivate")
+
+                # Execute hook on plugin deactivation
+                # Deactivation hook must happen before actual deactivation,
+                # otherwise the hook will not be available in _plugin_overrides anymore
+                for hook in self.plugins[plugin_id]._plugin_overrides:
+                    if hook.name == "deactivated":
+                        hook.function(self.plugins[plugin_id])
+
                 # Deactivate the plugin
                 self.plugins[plugin_id].deactivate()
                 # Remove the plugin from the list of active plugins
                 self.active_plugins.remove(plugin_id)
             else:
                 log.warning(f"Toggle plugin {plugin_id}: Activate")
+
                 # Activate the plugin
                 self.plugins[plugin_id].activate()
+
+                # Execute hook on plugin activation
+                # Activation hook must happen before actual activation,
+                # otherwise the hook will still not be available in _plugin_overrides
+                for hook in self.plugins[plugin_id]._plugin_overrides:
+                    if hook.name == "activated":
+                        hook.function(self.plugins[plugin_id])
+
                 # Add the plugin in the list of active plugins
                 self.active_plugins.append(plugin_id)