PR feedback

Author: FChataigner

dataikuapi/dss/admin.py

@@ -1514,15 +1514,6 @@ def name(self):
     def id(self):
         return self._data["id"]
     @property
-    def type(self):
-        return self._data["type"]
-    @property
-    def type_label(self):
-        return self._data.get("desc", {}).get("label", self._data["type"])
-    @property
-    def type_description(self):
-        return self._data.get("desc", {}).get("description", self._data["type"])
-    @property
     def build_for_configs(self):
         return self._data.get("buildFor", [])
     @property

dataikuapi/dss/codestudio.py

@@ -51,9 +51,9 @@ def delete(self):
 
     def get_settings(self):
         """
-        Get the code studio object's settings
+        Get the code studio object's definition
 
-        :returns: a handle to manage the code studio settings
+        :returns: a handle to manage the code studio definition
         :rtype: :class:`dataikuapi.dss.codestudio.DSSCodeStudioObjectSettings`
         """
         settings = self.client._perform_json("GET", "/projects/%s/code-studios/%s" % (self.project_key, self.code_studio_object_id))
@@ -77,10 +77,7 @@ def stop(self):
         :rtype: :class:`dataikuapi.dss.future.DSSFuture`
         """
         ret = self.client._perform_json("POST", "/projects/%s/code-studios/%s/stop" % (self.project_key, self.code_studio_object_id))
-        if 'jobId' in ret:
-            return self.client.get_future(ret["jobId"])
-        else:
-            return None
+        return DSSFuture.from_resp(self.client, ret)
 
     def restart(self):
         """
@@ -90,10 +87,7 @@ def restart(self):
         :rtype: :class:`dataikuapi.dss.future.DSSFuture`
         """
         ret = self.client._perform_json("POST", "/projects/%s/code-studios/%s/restart" % (self.project_key, self.code_studio_object_id))
-        if 'jobId' in ret:
-            return self.client.get_future(ret["jobId"])
-        else:
-            return None
+        return DSSFuture.from_resp(self.client, ret)
 
 class DSSCodeStudioObjectSettings(object):
     """
@@ -112,6 +106,14 @@ def get_raw(self):
         """
         return self.settings
 
+    @property
+    def template_id(self):
+        return self.settings["templateId"]
+    @property
+    def lib_name(self):
+        return self.settings["libName"]
+
+
 class DSSCodeStudioObjectStatus(object):
     """
     Status of a code studio object
@@ -133,7 +135,7 @@ def get_raw(self):
     def state(self):
         return self.status["state"]
     @property
-    def last_built(self):
+    def last_state_change(self):
         ts = self.status.get("lastStateChange", 0)
         if ts > 0:
             return datetime.fromtimestamp(ts / 1000)

dataikuapi/dss/project.py

@@ -1634,12 +1634,11 @@ def get_mlflow_extension(self):
     ########################################################
     # Code studios
     ########################################################
-    def list_code_studio_objects(self, as_type="listitems"):
+    def list_code_studios(self, as_type="listitems"):
         """
         List the code studio objects in this project
         
-        Returns:
-            the list of the code studio objects, each one as a JSON object
+        :returns: the list of the code studio objects, each one as a JSON object
         """
         items = self.client._perform_json(
             "GET", "/projects/%s/code-studios/" % self.project_key)
@@ -1650,28 +1649,24 @@ def list_code_studio_objects(self, as_type="listitems"):
         else:
             raise ValueError("Unknown as_type") 
 
-    def get_code_studio_object(self, code_studio_object_id):
+    def get_code_studio(self, code_studio_object_id):
         """
         Get a handle to interact with a specific code studio object
        
-        Args:
-            code_studio_object_id: the identifier of the desired code studio object
+        :param str code_studio_object_id: the identifier of the desired code studio object
         
-        Returns:
-            A :class:`dataikuapi.dss.codestudio.DSSCodeStudioObject` code studio object handle
+        :returns: A :class:`dataikuapi.dss.codestudio.DSSCodeStudioObject` code studio object handle
         """
         return DSSCodeStudioObject(self.client, self.project_key, code_studio_object_id)
 
-    def create_code_studio_object(self, name, template_id):
+    def create_code_studio(self, name, template_id):
         """
         Create a new code studio object in the project, and return a handle to interact with it
         
-        Args:
-            name: the name of the code studio object
-            template_id: the identifier of a code studio template
+        :param str name: the name of the code studio object
+        :param str template_id: the identifier of a code studio template
         
-        Returns:
-            A :class:`dataikuapi.dss.codestudio.DSSCodeStudioObject` code studio object handle
+        :returns: A :class:`dataikuapi.dss.codestudio.DSSCodeStudioObject` code studio object handle
         """
         obj = {
             "name" : name,

dataikuapi/dssclient.py

@@ -627,8 +627,7 @@ def list_code_studio_templates(self, as_type='listitems'):
         """
         List all code studio templates on the DSS instance
 
-        Returns:
-            List of templates (name, type)
+        :returns: List of templates (name, type)
         """
         items = self._perform_json("GET", "/admin/code-studios/")
         if as_type == "listitems" or as_type == "listitem":
@@ -642,11 +641,9 @@ def get_code_studio_template(self, template_id):
         """
         Get a handle to interact with a specific code studio template
         
-        Args:
-            template_id: the template id of the desired code studio template
+        :param str template_id: the template id of the desired code studio template
         
-        Returns:
-            A :class:`dataikuapi.dss.admin.DSSCodeStudioTemplate` code studio template handle
+        :returns: A :class:`dataikuapi.dss.admin.DSSCodeStudioTemplate` code studio template handle
         """
         return DSSCodeStudioTemplate(self, template_id)