Make DSSClient.get_global_variables return a DSSInstanceVariables handle

[ch64060]

Author: AFrancani

dataikuapi/dss/admin.py

@@ -946,3 +946,24 @@ def get_raw(self):
         Gets the whole status as a raw dictionary.
         """
         return self.status
+
+
+class DSSInstanceVariables(dict):
+    """
+    Dict containing the instance variables. The variables can be modified directly in the dict and persisted using its `save` method.
+
+    Do not create this directly, use :meth:`dataikuapi.dssclient.DSSClient.get_global_variables`
+    """
+
+    def __init__(self, client, variables):
+        super().__init__()
+        self.update(variables)
+        self.client = client
+
+    def save(self):
+        """
+        Save the changes made to the instance variables.
+
+        Note: this call requires an API key with admin rights.
+        """
+        return self.client._perform_empty("PUT", "/admin/variables/", body=self)

dataikuapi/dssclient.py

@@ -10,7 +10,7 @@
 from .dss.project import DSSProject
 from .dss.app import DSSApp
 from .dss.plugin import DSSPlugin
-from .dss.admin import DSSUser, DSSOwnUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv, DSSGlobalApiKey, DSSCluster
+from .dss.admin import DSSUser, DSSOwnUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv, DSSGlobalApiKey, DSSCluster, DSSInstanceVariables
 from .dss.meaning import DSSMeaning
 from .dss.sqlquery import DSSSQLQuery
 from .dss.discussion import DSSObjectDiscussions
@@ -772,10 +772,10 @@ def get_global_variables(self):
 
         This call requires an API key with admin rights
 
-        :returns: a Python dictionary of the instance-level variables
+        :returns: A :class:`dataikuapi.dss.admin.DSSInstanceVariables` handle
         """
-        return self._perform_json(
-            "GET", "/admin/variables/")
+        variables = self._perform_json("GET", "/admin/variables/")
+        return DSSInstanceVariables(self, variables)
 
     def get_resolved_variables(self, project_key=None, typed=False):
         """
@@ -797,6 +797,8 @@ def get_resolved_variables(self, project_key=None, typed=False):
 
     def set_variables(self, variables):
         """
+        Deprecated. Use get_global_variables().save()
+
         Updates the DSS instance's variables
 
         This call requires an API key with admin rights
@@ -807,6 +809,7 @@ def set_variables(self, variables):
         :param dict variables: the new dictionary of all variables of the instance
 
         """
+        warnings.warn("set_variables is deprecated, please use get_global_variables().save()", DeprecationWarning)
         return self._perform_empty(
             "PUT", "/admin/variables/", body=variables)