Structured listing of recipes

Author: cstenac

dataikuapi/dss/project.py

@@ -1,7 +1,7 @@
 import time, warnings, sys, os.path as osp
 from .dataset import DSSDataset, DSSDatasetListItem, DSSManagedDatasetCreationHelper
 from .streaming_endpoint import DSSStreamingEndpoint, DSSStreamingEndpointListItem, DSSManagedStreamingEndpointCreationHelper
-from .recipe import DSSRecipe
+from .recipe import DSSRecipeListItem, DSSRecipe
 from . import recipe
 from .managedfolder import DSSManagedFolder
 from .savedmodel import DSSSavedModel
@@ -990,15 +990,23 @@ def create_scenario(self, scenario_name, type, definition=None):
     # Recipes
     ########################################################
 
-    def list_recipes(self):
+    def list_recipes(self, as_type="listitems"):
         """
         List the recipes in this project
-        
-        Returns:
-            the list of the recipes, each one as a JSON object
+
+        :param str as_type: How to return the list. Supported values are "listitems" and "objects".
+        :returns: The list of the recipes. If "as_type" is "listitems", each one as a :class:`recipe.DSSRecipeListItem`.
+                  If "as_type" is "objects", each one as a :class:`recipe.DSSRecipe`
+        :rtype: list
         """
-        return self.client._perform_json(
-            "GET", "/projects/%s/recipes/" % self.project_key)
+        items = self.client._perform_json("GET", "/projects/%s/recipes/" % self.project_key)
+        if as_type == "listitems" or as_type == "listitem":
+            return [DSSRecipeListItem(self.client, item) for item in items]
+        elif as_type == "objects" or as_type == "object":
+            return [DSSRecipe(self.client, self.project_key, item["name"]) for item in items]
+        else:
+            raise ValueError("Unknown as_type")
+
 
     def get_recipe(self, recipe_name):
         """

dataikuapi/dss/recipe.py

@@ -2,10 +2,27 @@
 from .utils import DSSTaggableObjectSettings
 from .discussion import DSSObjectDiscussions
 import json, logging, warnings
+from .utils import DSSTaggableObjectListItem, DSSTaggableObjectSettings
 
-#####################################################
-# Base classes
-#####################################################
+class DSSRecipeListItem(DSSTaggableObjectListItem):
+    """An item in a list of recipes. Do not instantiate this class, use :meth:`dataikuapi.dss.project.DSSProject.list_recipes`"""
+    def __init__(self, client, data):
+        super(DSSRecipeListItem, self).__init__(data)
+        self.client = client
+
+    def to_recipe(self):
+        """Gets the :class:`DSSRecipe` corresponding to this dataset"""
+        return  DSSRecipe(self.client, self._data["projectKey"], self._data["name"])
+
+    @property
+    def name(self):
+        return self._data["name"]
+    @property
+    def id(self):
+        return self._data["name"]
+    @property
+    def type(self):
+        return self._data["type"]
 
 class DSSRecipe(object):
     """