Start a generic base class for the settings of taggable objects, with properties for tags/descriptions/custom fields

Author: cstenac

dataikuapi/dss/dataset.py

@@ -3,7 +3,7 @@
 from ..utils import DataikuStreamedHttpUTF8CSVReader
 from .future import DSSFuture
 import json, warnings
-from .utils import DSSTaggableObjectListItem
+from .utils import DSSTaggableObjectListItem, DSSTaggableObjectSettings
 from .future import DSSFuture
 from .metrics import ComputedMetrics
 from .discussion import DSSObjectDiscussions
@@ -603,8 +603,9 @@ def new_recipe(self, type, recipe_name=None):
         builder.with_input(self.dataset_name)
         return builder
 
-class DSSDatasetSettings(object):
+class DSSDatasetSettings(DSSTaggableObjectSettings):
     def __init__(self, dataset, settings):
+        super(DSSDatasetSettings, self).__init__(settings)
         self.dataset = dataset
         self.settings = settings
 

dataikuapi/dss/recipe.py

@@ -1,4 +1,5 @@
 from ..utils import DataikuException
+from .utils import DSSTaggableObjectSettings
 from .discussion import DSSObjectDiscussions
 import json, logging, warnings
 
@@ -16,6 +17,10 @@ def __init__(self, client, project_key, recipe_name):
         self.project_key = project_key
         self.recipe_name = recipe_name
 
+    @property
+    def name(self):
+        return self.recipe_name
+
     def compute_schema_updates(self):
         """
         Computes which updates are required to the outputs of this recipe.
@@ -238,11 +243,12 @@ def get_status_messages(self):
         return self.data["allMessagesForFrontend"]["messages"]
 
 
-class DSSRecipeSettings(object):
+class DSSRecipeSettings(DSSTaggableObjectSettings):
     """
     Settings of a recipe. Do not create this directly, use :meth:`DSSRecipe.get_settings`
     """
     def __init__(self, recipe, data):
+        super(DSSRecipeSettings, self).__init__(data["recipe"])
         self.recipe = recipe
         self.data = data
         self.recipe_settings = self.data["recipe"]

dataikuapi/dss/utils.py

@@ -218,3 +218,43 @@ def __init__(self, data):
     @property
     def tags(self):
         return self._data["tags"]
+
+class DSSTaggableObjectSettings(object):
+    def __init__(self, taggable_object_data):
+        self._tod = taggable_object_data
+
+    @property
+    def tags(self):
+        """The tags of the object, as a list of strings"""
+        return self._tod["tags"]
+
+    @tags.setter
+    def tags(self, tags):
+        self._tod["tags"] = tags
+
+    @property
+    def description(self):
+        """The description of the object as a string"""
+        return self._tod.get("description", None)
+
+    @description.setter
+    def description(self, description):
+        self._tod["description"] = description
+
+    @property
+    def short_description(self):
+        """The short description of the object as a string"""
+        return self._tod.get("shortDesc", None)
+
+    @short_description.setter
+    def short_description(self, short_description):
+        self._tod["shortDesc"] = short_description
+
+    @property
+    def custom_fields(self):
+        """The custom fields of the object as a dict. Returns None if there are no custom fields"""
+        return self._tod.get("customFields", None)
+
+    @custom_fields.setter
+    def custom_fields(self, custom_fields):
+        self._tod["customFields"] = custom_fields