more PR feedback

Author: FChataigner

dataikuapi/dss/admin.py

@@ -1576,3 +1576,33 @@ def get_raw(self):
         """
         return self.settings
 
+    def get_built_for_all_container_confs(self):
+        """
+        Return whether the template an image for each container config
+        """
+        return self.settings.get("allContainerConfs", False)
+
+    def get_built_container_confs(self):
+        """
+        Return the list of container configs for which the template builds an image (if not all)
+        """
+        return self.settings.get("containerConfs", [])
+
+    def set_built_container_confs(self, *configs, **kwargs):
+        """
+        Set the list of container configs for which the template builds an image
+
+        :param boolean all: if True, an image is built for each config
+        :param list configs: list of configuration names to build images for
+        """
+        all = kwargs.get("all", False)
+        self.settings['allContainerConfs'] = all
+        if not all:
+            self.settings['containerConfs'] = configs
+
+    def save(self):
+        """
+        Saves the settings of the code studio template
+        """
+        self.client._perform_empty("PUT", "/admin/code-studios/%s" % (self.template_id), body=self.settings)
+

dataikuapi/dss/codestudio.py

@@ -3,13 +3,13 @@
 from datetime import datetime
 
 class DSSCodeStudioObjectListItem(object):
-    """An item in a list of code studios. Do not instantiate this class, use :meth:`dataikuapi.dss.project.DSSProject.list_code_studio_objects`"""
+    """An item in a list of code studios. Do not instantiate this class, use :meth:`dataikuapi.dss.project.DSSProject.list_code_studios`"""
     def __init__(self, client, project_key, data):
         self.client = client
         self.project_key = project_key
         self._data = data
 
-    def to_code_studio_object(self):
+    def to_code_studio(self):
         """Gets the :class:`DSSCodeStudioObject` corresponding to this code studio object """
         return DSSCodeStudioObject(self.client, self.project_key, self._data["id"])
 
@@ -37,17 +37,17 @@ class DSSCodeStudioObject(object):
     """
     A handle to manage a code studio object of a project
     """
-    def __init__(self, client, project_key, code_studio_object_id):
-        """Do not call directly, use :meth:`dataikuapi.dss.project.DSSProject.get_code_studio_object`"""
+    def __init__(self, client, project_key, code_studio_id):
+        """Do not call directly, use :meth:`dataikuapi.dss.project.DSSProject.get_code_studio`"""
         self.client = client
         self.project_key = project_key
-        self.code_studio_object_id = code_studio_object_id
+        self.code_studio_id = code_studio_id
 
     def delete(self):
         """
         Delete the code studio
         """
-        self.client._perform_empty("DELETE", "/projects/%s/code-studios/%s" % (self.project_key, self.code_studio_object_id))
+        self.client._perform_empty("DELETE", "/projects/%s/code-studios/%s" % (self.project_key, self.code_studio_id))
 
     def get_settings(self):
         """
@@ -56,8 +56,8 @@ def get_settings(self):
         :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))
-        return DSSCodeStudioObjectSettings(self.client, self.project_key, self.code_studio_object_id, settings)
+        settings = self.client._perform_json("GET", "/projects/%s/code-studios/%s" % (self.project_key, self.code_studio_id))
+        return DSSCodeStudioObjectSettings(self.client, self.project_key, self.code_studio_id, settings)
 
     def get_status(self):
         """
@@ -66,8 +66,8 @@ def get_status(self):
         :returns: a handle to inspect the code studio state
         :rtype: :class:`dataikuapi.dss.codestudio.DSSCodeStudioObjectStatus`
         """
-        status = self.client._perform_json("GET", "/projects/%s/code-studios/%s/status" % (self.project_key, self.code_studio_object_id))
-        return DSSCodeStudioObjectStatus(self.client, self.project_key, self.code_studio_object_id, status)
+        status = self.client._perform_json("GET", "/projects/%s/code-studios/%s/status" % (self.project_key, self.code_studio_id))
+        return DSSCodeStudioObjectStatus(self.client, self.project_key, self.code_studio_id, status)
 
     def stop(self):
         """
@@ -76,7 +76,7 @@ def stop(self):
         :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/code-studios/%s/stop" % (self.project_key, self.code_studio_object_id))
+        ret = self.client._perform_json("POST", "/projects/%s/code-studios/%s/stop" % (self.project_key, self.code_studio_id))
         return DSSFuture.from_resp(self.client, ret)
 
     def restart(self):
@@ -86,18 +86,18 @@ def restart(self):
         :returns: a future to wait on the start
         :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))
+        ret = self.client._perform_json("POST", "/projects/%s/code-studios/%s/restart" % (self.project_key, self.code_studio_id))
         return DSSFuture.from_resp(self.client, ret)
 
 class DSSCodeStudioObjectSettings(object):
     """
     Settings for the code studio object
     """
-    def __init__(self, client, project_key, code_studio_object_id, settings):
+    def __init__(self, client, project_key, code_studio_id, settings):
         """Do not call directly, use :meth:`dataikuapi.dss.codestudio.DSSCodeStudioObject.get_settings`"""
         self.client = client
         self.project_key = project_key
-        self.code_studio_object_id = code_studio_object_id
+        self.code_studio_id = code_studio_id
         self.settings = settings
 
     def get_raw(self):
@@ -118,11 +118,11 @@ class DSSCodeStudioObjectStatus(object):
     """
     Status of a code studio object
     """
-    def __init__(self, client, project_key, code_studio_object_id, status):
+    def __init__(self, client, project_key, code_studio_id, status):
         """Do not call directly, use :meth:`dataikuapi.dss.codestudio.DSSCodeStudioObject.get_state`"""
         self.client = client
         self.project_key = project_key
-        self.code_studio_object_id = code_studio_object_id
+        self.code_studio_id = code_studio_id
         self.status = status
 
     def get_raw(self):

dataikuapi/dss/project.py

@@ -1649,15 +1649,15 @@ def list_code_studios(self, as_type="listitems"):
         else:
             raise ValueError("Unknown as_type") 
 
-    def get_code_studio(self, code_studio_object_id):
+    def get_code_studio(self, code_studio_id):
         """
         Get a handle to interact with a specific code studio object
        
-        :param str code_studio_object_id: the identifier of the desired code studio object
+        :param str code_studio_id: the identifier of the desired code studio object
         
         :returns: A :class:`dataikuapi.dss.codestudio.DSSCodeStudioObject` code studio object handle
         """
-        return DSSCodeStudioObject(self.client, self.project_key, code_studio_object_id)
+        return DSSCodeStudioObject(self.client, self.project_key, code_studio_id)
 
     def create_code_studio(self, name, template_id):
         """
@@ -1673,8 +1673,8 @@ def create_code_studio(self, name, template_id):
             "templateId" : template_id
         }
         res = self.client._perform_json("POST", "/projects/%s/code-studios/" % self.project_key, body = obj)
-        code_studio_object_id = res['codeStudio']['id']
-        return DSSCodeStudioObject(self.client, self.project_key, code_studio_object_id)
+        code_studio_id = res['codeStudio']['id']
+        return DSSCodeStudioObject(self.client, self.project_key, code_studio_id)