add deprecation support to PluginDescription and Plugin classes

Author: robertisele

cmem_plugin_base/dataintegration/description.py

@@ -186,6 +186,8 @@ class PluginDescription:
     :param parameters: Available plugin parameters
     :param icon: An optional custom plugin icon.
     :param actions: Custom plugin actions.
+    :param deprecation: Optional deprecation message.
+        If set, the plugin will be marked as deprecated in the UI.
     """
 
     def __init__(  # noqa: PLR0913
@@ -199,6 +201,7 @@ def __init__(  # noqa: PLR0913
         parameters: list[PluginParameter] | None = None,
         icon: Icon | None = None,
         actions: list[PluginAction] | None = None,
+        deprecation: str | None = None,
     ) -> None:
         #  Set the type of the plugin. Same as the class name of the plugin
         #  base class, e.g., 'WorkflowPlugin'.
@@ -238,6 +241,7 @@ def __init__(  # noqa: PLR0913
             self.actions = []
         else:
             self.actions = actions
+        self.deprecation = deprecation
         for action in self.actions:
             action.validate(plugin_class)
 
@@ -321,6 +325,8 @@ class Plugin:
     :param parameters: Available plugin parameters.
     :param icon: Optional custom plugin icon.
     :param actions: Custom plugin actions
+    :param deprecation: Optional deprecation message.
+        If set, the plugin will be marked as deprecated in the UI.
     """
 
     plugins: ClassVar[list[PluginDescription]] = []
@@ -335,13 +341,15 @@ def __init__(  # noqa: PLR0913
         parameters: list[PluginParameter] | None = None,
         icon: Icon | None = None,
         actions: list[PluginAction] | None = None,
+        deprecation: str | None = None,
     ):
         self.label = label
         self.description = description
         self.documentation = documentation
         self.plugin_id = plugin_id
         self.icon = icon
         self.actions = actions
+        self.deprecation = deprecation
         if categories is None:
             self.categories = []
         else:
@@ -363,6 +371,7 @@ def __call__(self, func: type):
             parameters=self.retrieve_parameters(func),
             icon=self.icon,
             actions=self.actions,
+            deprecation=self.deprecation,
         )
         Plugin.plugins.append(plugin_desc)
         return func

tests/test_description.py

@@ -115,6 +115,29 @@ def get_project(self, context: PluginContext) -> str:
         assert action1.execute(plugin_instance, TestPluginContext()) == "My Name"
         assert action2.execute(plugin_instance, TestPluginContext(project_id="movies")) == "movies"
 
+    def test__deprecation(self) -> None:
+        """Test plugin deprecation message."""
+        Plugin.plugins = []  # Remove all previous plugins
+
+        @Plugin(label="My Plugin")
+        class MyPlugin(TransformPlugin):
+            """Test transform plugin without deprecation message."""
+
+            def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+                return []
+
+        @Plugin(label="My Deprecated Plugin", deprecation="Use new plugin instead.")
+        class MyDeprecatedPlugin(TransformPlugin):
+            """Test transform plugin with deprecation message."""
+
+            def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+                return []
+
+        plugin = Plugin.plugins[0]
+        deprecated_plugin = Plugin.plugins[1]
+        assert plugin.deprecation is None
+        assert deprecated_plugin.deprecation == "Use new plugin instead."
+
 
 if __name__ == "__main__":
     unittest.main()