add wrapper for kubikles

Author: FChataigner

dataikuapi/dss/admin.py

@@ -1275,7 +1275,7 @@ def total_active_with_trigger_scenarios_count(self):
 
 
 class DSSKubikleTemplateListItem(object):
-    """An item in a list of datasets. Do not instantiate this class, use :meth:`dataikuapi.dss.project.DSSProject.list_datasets`"""
+    """An item in a list of kubikle templates. Do not instantiate this class, use :meth:`dataikuapi.DSSClient.list_kubikle_templates`"""
     def __init__(self, client, data):
         self.client = client
         self._data = data

dataikuapi/dss/kubikle.py

@@ -1,5 +1,37 @@
 from ..utils import DataikuException
 import json
+from datetime import datetime
+
+class DSSKubikleObjectListItem(object):
+    """An item in a list of kubikles. Do not instantiate this class, use :meth:`dataikuapi.dss.project.DSSProject.list_kubikle_objects`"""
+    def __init__(self, client, project_key, data):
+        self.client = client
+        self.project_key = project_key
+        self._data = data
+
+    def to_kubikle_object(self):
+        """Gets the :class:`DSSKubikleTemplate` corresponding to this kubikle object """
+        return DSSKubikleObject(self.client, self.project_key, self._data["id"])
+
+    @property
+    def name(self):
+        return self._data["name"]
+    @property
+    def id(self):
+        return self._data["id"]
+    @property
+    def owner(self):
+        return self._data["owner"]
+    @property
+    def template_id(self):
+        return self._data["templateId"]
+    @property
+    def template_label(self):
+        return self._data.get('desc', {}).get('label', self._data['id'])
+    @property
+    def template_description(self):
+        return self._data.get('desc', {}).get('shortDesc', '')
+
 
 class DSSKubikleObject(object):
     """
@@ -11,16 +43,57 @@ def __init__(self, client, project_key, kubikle_object_id):
         self.project_key = project_key
         self.kubikle_object_id = kubikle_object_id
 
+    def delete(self):
+        """
+        Delete the kubikle
+        """
+        self.client._perform_empty("DELETE", "/projects/%s/kubikles/%s" % (self.project_key, self.kubikle_object_id))
+
     def get_settings(self):
         """
         Get the kubikle object's settings
 
-        :returns: a handle to manage the wiki settings (taxonomy, home article)
+        :returns: a handle to manage the kubikle settings
         :rtype: :class:`dataikuapi.dss.kubikle.DSSKubikleObjectSettings`
         """
         settings = self.client._perform_json("GET", "/projects/%s/kubikles/%s" % (self.project_key, self.kubikle_object_id))
         return DSSKubikleObjectSettings(self.client, self.project_key, self.kubikle_object_id, settings)
 
+    def get_status(self):
+        """
+        Get the kubikle object's state
+
+        :returns: a handle to inspect the kubikle state
+        :rtype: :class:`dataikuapi.dss.kubikle.DSSKubikleObjectStatus`
+        """
+        status = self.client._perform_json("GET", "/projects/%s/kubikles/%s/status" % (self.project_key, self.kubikle_object_id))
+        return DSSKubikleObjectStatus(self.client, self.project_key, self.kubikle_object_id, status)
+
+    def stop(self):
+        """
+        Stop a running kubikle
+
+        :returns: a future to wait on the stop, or None if already stopped
+        :rtype: :class:`dataikuapi.dss.future.DSSFuture`
+        """
+        ret = self.client._perform_json("POST", "/projects/%s/kubikles/%s/stop" % (self.project_key, self.kubikle_object_id))
+        if 'jobId' in ret:
+            return self.client.get_future(ret["jobId"])
+        else:
+            return None
+
+    def restart(self):
+        """
+        Restart a kubikle
+
+        :returns: a future to wait on the start
+        :rtype: :class:`dataikuapi.dss.future.DSSFuture`
+        """
+        ret = self.client._perform_json("POST", "/projects/%s/kubikles/%s/restart" % (self.project_key, self.kubikle_object_id))
+        if 'jobId' in ret:
+            return self.client.get_future(ret["jobId"])
+        else:
+            return None
 
 class DSSKubikleObjectSettings(object):
     """
@@ -39,3 +112,30 @@ def get_raw(self):
         """
         return self.settings
 
+class DSSKubikleObjectStatus(object):
+    """
+    Status of a kubikle object
+    """
+    def __init__(self, client, project_key, kubikle_object_id, status):
+        """Do not call directly, use :meth:`dataikuapi.dss.kubikle.DSSKubikleObject.get_state`"""
+        self.client = client
+        self.project_key = project_key
+        self.kubikle_object_id = kubikle_object_id
+        self.status = status
+
+    def get_raw(self):
+        """
+        Gets the status as a raw dictionary. This returns a reference to the raw status, not a copy,
+        """
+        return self.status
+
+    @property
+    def state(self):
+        return self.status["state"]
+    @property
+    def last_built(self):
+        ts = self.status.get("lastStateChange", 0)
+        if ts > 0:
+            return datetime.fromtimestamp(ts / 1000)
+        else:
+            return None

dataikuapi/dss/project.py

@@ -25,7 +25,7 @@
 from .analysis import DSSAnalysis
 from .flow import DSSProjectFlow
 from .app import DSSAppManifest
-from .kubikle import DSSKubikleObject
+from .kubikle import DSSKubikleObject, DSSKubikleObjectListItem
 
 class DSSProject(object):
     """
@@ -1632,15 +1632,21 @@ def get_mlflow_extension(self):
     ########################################################
     # Kubikles
     ########################################################
-    def list_kubikle_objects(self):
+    def list_kubikle_objects(self, as_type="listitems"):
         """
         List the kubikle objects in this project
         
         Returns:
             the list of the kubikle objects, each one as a JSON object
         """
-        return self.client._perform_json(
+        items = self.client._perform_json(
             "GET", "/projects/%s/kubikles/" % self.project_key)
+        if as_type == "listitems" or as_type == "listitem":
+            return [DSSKubikleObjectListItem(self.client, self.project_key, item) for item in items]
+        elif as_type == "objects" or as_type == "object":
+            return [DSSKubikleObject(self.client, self.project_key, item["id"]) for item in items]
+        else:
+            raise ValueError("Unknown as_type") 
 
     def get_kubikle_object(self, kubikle_object_id):
         """