improvements to public api for code envs

Author: FChataigner

dataikuapi/dss/admin.py

@@ -444,7 +444,8 @@ def delete(self):
             raise Exception('Env deletion returned no data')
         if resp.get('messages', {}).get('error', False):
             raise Exception('Env deletion failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
-    
+        return resp
+
 
     ########################################################
     # Code env description
@@ -461,42 +462,69 @@ def get_definition(self):
         """
         return self.client._perform_json(
             "GET", "/admin/code-envs/%s/%s" % (self.env_lang, self.env_name))
+
+    def set_definition(self, env):
+        """
+        Set the code env's definition. The definition should come from a call to the get_definition()
+        method. 
+
+        Fields that can be updated in design node:
+
+        * env.permissions, env.usableByAll, env.desc.owner
+        * env.specCondaEnvironment, env.specPackageList, env.externalCondaEnvName, env.desc.installCorePackages,
+          env.desc.installJupyterSupport, env.desc.yarnPythonBin
+
+        Fields that can be updated in automation node (where {version} is the updated version):
+
+        * env.permissions, env.usableByAll, env.owner
+        * env.{version}.specCondaEnvironment, env.{version}.specPackageList, env.{version}.externalCondaEnvName, 
+          env.{version}.desc.installCorePackages, env.{version}.desc.installJupyterSupport, env.{version}.desc.yarnPythonBin
+
+
+
+        Note: this call requires an API key with admin rights
+        
+        :param data: a code env definition
+
+        Returns:
+            the updated code env definition, as a JSON object
+        """
+        return self.client._perform_json(
+            "PUT", "/admin/code-envs/%s/%s" % (self.env_lang, self.env_name), body=env)
+
 
     ########################################################
-    # Code env modification
+    # Code env actions
     ########################################################
-    def update(self, external_conda_name=None, conda_spec=None, spec=None):
+
+    def set_jupyter_support(self, active):
         """
-        Update the code env definition and apply the changes
+        Update the code env jupyter support
         
         Note: this call requires an API key with admin rights
         
-        :param external_conda_name: name of an external conda env
-        :param conda_spec: spec of the conda env
-        :param spec: list of pip or R packages
+        :param active: True to activate jupyter support, False to deactivate
         """
-        modifications = {'externalCondaEnvName':external_conda_name,'condaSpec':conda_spec,'spec':spec}
         resp = self.client._perform_json(
-            "PUT", "/admin/code-envs/%s/%s" % (self.env_lang, self.env_name),
-            body = modifications)
+            "POST", "/admin/code-envs/%s/%s/jupyter" % (self.env_lang, self.env_name),
+            params = {'active':active})
         if resp is None:
             raise Exception('Env update returned no data')
         if resp.get('messages', {}).get('error', False):
             raise Exception('Env update failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
+        return resp
 
-    def set_jupyter_support(self, active):
+    def update_packages(self):
         """
-        Update the code env jupyter support
+        Update the code env packages so that it matches its spec
         
         Note: this call requires an API key with admin rights
-        
-        :param active: True to activate jupyter support, False to deactivate
         """
         resp = self.client._perform_json(
-            "POST", "/admin/code-envs/%s/%s/jupyter" % (self.env_lang, self.env_name),
-            params = {'active':active})
+            "POST", "/admin/code-envs/%s/%s/packages" % (self.env_lang, self.env_name))
         if resp is None:
             raise Exception('Env update returned no data')
         if resp.get('messages', {}).get('error', False):
             raise Exception('Env update failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
+        return resp
 

dataikuapi/dssclient.py

@@ -397,7 +397,7 @@ def create_code_env(self, env_lang, env_name, deployment_mode, params=None):
         :param env_lang: the language (Python, R) of the new code env
         :param env_name: the name of the new code env
         :param deployment_mode: the type of the new code env
-        :param params: the parameters of the new connection, as a JSON object
+        :param params: the parameters of the new code env, as a JSON object
         
         :returns: A :class:`dataikuapi.dss.admin.DSSCodeEnv` code env handle