Merge PR #81 Plugin uninstall

from perso/lpenet/plugin-uninstall

Author: instanceofme

dataikuapi/dss/plugin.py

@@ -1,11 +1,5 @@
-from .dataset import DSSDataset
-from .recipe import DSSRecipe
-from .managedfolder import DSSManagedFolder
-from .savedmodel import DSSSavedModel
-from .job import DSSJob
-from .scenario import DSSScenario
-from .apiservice import DSSAPIService
-import sys
+from dataikuapi.utils import DataikuException
+
 
 class DSSPluginSettings(object):
     """
@@ -30,6 +24,7 @@ def save(self):
         """Saves the settings to DSS"""
         self.client._perform_empty("POST", "/plugins/%s/settings" % (self.plugin_id), body=self.settings)
 
+
 class DSSPlugin(object):
     """
     A plugin on the DSS instance
@@ -116,6 +111,41 @@ def update_from_git(self, repository_url, checkout = "master", subpath=None):
         })
         return self.client.get_future(ret["jobId"])
 
+    ########################################################
+    # Plugin uninstall/delete
+    ########################################################
+
+    def list_usages(self, project_key=None):
+        """
+        Get the list of usages of the plugin.
+
+        :param str project_key: optional key of project where to look for usages. Default is None and looking in all projects.
+        :return: a :class:`DSSPluginUsages`
+        """
+        return DSSPluginUsages(
+            self.client._perform_json("GET", "/plugins/{pluginId}/actions/listUsages".format(pluginId=self.plugin_id),
+                                      params={"projectKey": project_key})
+        )
+
+    def delete(self, force=False):
+        """
+        Delete a plugin.
+
+        If not forced (default), pre-deletion checks will be run (as by :func:`prepare_delete` and the deletion will be
+        performed if and only if no usage of the plugin is detected and no error occurred during usages analysis.
+
+        :param bool force: if True, plugin will be deleted even if usages are found or errors occurred during usages
+        analysis. Default is False.
+        :return: a :class:`dataikuapi.dssfuture.DSSFuture`
+        """
+
+        params = {
+            "force": force
+        }
+        ret = self.client._perform_json("POST", "/plugins/{pluginId}/actions/delete".format(pluginId=self.plugin_id),
+                                        body=params)
+        return self.client.get_future(ret.get("jobId", None))
+
     ########################################################
     # Managing the dev plugin's contents
     ########################################################
@@ -147,4 +177,88 @@ def put_file(self, path, f):
         data = f.read() # eat it all, because making it work with a path variable and a MultifilePart in swing looks complicated
         return self.client._perform_empty("POST", "/plugins/%s/contents/%s" % (self.plugin_id, path), raw_body=data)
 
-        
+
+class DSSPluginUsage(object):
+    """
+    Information on a usage of an element of a plugin.
+
+    Has the following properties:
+    - element_kind: webapps, python-formats,...
+    - element_type: type name of the element
+    - object_id: id of the object using the plugin element. Can be None.
+    - object_type: type of the object using the plugin element. Can be None.
+    - project_key: project key of the object using the plugin element. Can be None.
+    """
+    def __init__(self, data):
+        """
+        Instantiate a DSSPluginUsage from the dict of its properties.
+        :param dict data: dict of properties
+        """
+        self.element_kind = data["elementKind"]
+        self.element_type = data["elementType"]
+        self.object_id = data.get("objectId", None)
+        self.object_type = data.get("objectType", None)
+        self.project_key = data.get("projectKey", None)
+
+
+class DSSMissingType(object):
+    """
+    Information on a type not found while analyzing usages of a plugin.
+
+    Has the following properties:
+    - missing type: the missing type
+    - object_id: id of the object depending on the missing type. Can be None.
+    - object_type: type of the object depending on the missing type. Can be None.
+    - project_key: project key of the object depending on the missing type. Can be None.
+    """
+    def __init__(self, data):
+        """
+        Instantiate a DSSMissingType from the dict of its properties
+        :param dict data: dictionary of properties
+        """
+        self.missing_type = data["missingType"]
+        self.object_id = data.get("objectId", None)
+        self.object_type = data.get("objectType", None)
+        self.project_key = data.get("projectKey", None)
+
+
+class DSSPluginUsages(object):
+    """
+    Information on the usages of a plugin.
+
+    Has the following properties:
+    - usages (list of :class:`DSSPluginUsage`)
+    - missing_types (a list of :class:`DSSMissingType`).
+
+    Some custom types may not be found during usage analysis, typically when a plugin was removed
+    but is still used. This prevents some detailed analysis and may hide some uses.
+    This information is provided in missing_types.
+    """
+    def __init__(self, data):
+        """
+        Initialize a DSSPluginUsages from a dict of its properties
+
+        :param dict data: the usages as json dict
+        """
+        self._data = data
+        self.usages = []
+        self.missing_types = []
+        for json_usage in data.get("usages", []):
+            self.usages.append(DSSPluginUsage(json_usage))
+        for json_missing_type in data.get("missingTypes"):
+            self.missing_types.append(DSSMissingType(json_missing_type))
+
+    def get_raw(self):
+        """
+        Get plugin usages as a dictionary.
+        :rtype: dict
+        """
+        return self._data
+
+    def maybe_used(self):
+        """
+        Returns true if the plugin maybe in use, as usages of the plugin were found, or errors
+        encountered during analysis.
+        :return:
+        """
+        return not (not self.usages and not self.missing_types)