use as_type instead of as_object.

Author: pbailly

dataikuapi/dss/jupyternotebook.py

@@ -38,12 +38,12 @@ def get_sessions(self, as_objects=False):
         else:
             return sessions
 
-    def get_content(self):
+    def get_contents(self):
         """
         Get the content of this Jupyter notebook (metadata, cells, nbformat)
         """
-        raw_content = self.client._perform_json("GET", "/projects/%s/jupyter-notebooks/%s" % (self.project_key, self.notebook_name))
-        return DSSNotebookContent(self.client, self.project_key, self.notebook_name, raw_content)
+        raw_contents = self.client._perform_json("GET", "/projects/%s/jupyter-notebooks/%s" % (self.project_key, self.notebook_name))
+        return DSSNotebookContents(self.client, self.project_key, self.notebook_name, raw_contents)
 
     def delete(self):
         """
@@ -64,48 +64,48 @@ def get_object_discussions(self):
         """
         return DSSObjectDiscussions(self.client, self.project_key, "JUPYTER_NOTEBOOK", self.notebook_name)
 
-class DSSNotebookContent(object):
+class DSSNotebookContents(object):
     """
-    Content of a Jupyter Notebook. Do not create this directly, use :meth:`DSSJupyterNotebook.get_content`
+    Contents of a Jupyter Notebook. Do not create this directly, use :meth:`DSSJupyterNotebook.get_contents`
     """
 
     """
     A Python/R/Scala notebook on the DSS instance
     """
-    def __init__(self, client, project_key, notebook_name, content):
+    def __init__(self, client, project_key, notebook_name, contents):
         self.client = client
         self.project_key = project_key
         self.notebook_name = notebook_name
-        self.content = content
+        self.contents = contents
 
     def get_raw(self):
         """
-        Get the content of this Jupyter notebook (metadata, cells, nbformat)
-        :rtype: a dict containing the full content of a notebook
+        Get the contents of this Jupyter notebook (metadata, cells, nbformat)
+        :rtype: a dict containing the full contents of a notebook
         """
-        return self.content
+        return self.contents
 
     def get_metadata(self):
         """
         Get the metadata associated to this Jupyter notebook
         :rtype: dict with metadata
         """
-        return self.content["metadata"]
+        return self.contents["metadata"]
 
     def get_cells(self):
         """
         Get the cells associated to this Jupyter notebook
         :rtype: list of cells
         """
-        return self.content["cells"]
+        return self.contents["cells"]
 
     def save(self):
         """
-        Save the content of this Jupyter notebook
+        Save the contents of this Jupyter notebook
         """
         return self.client._perform_json("PUT",
                                          "/projects/%s/jupyter-notebooks/%s" % (self.project_key, self.notebook_name),
-                                         body=self.content)
+                                         body=self.contents)
 
 class DSSNotebookSession(object):
     """

dataikuapi/dss/project.py

@@ -1,6 +1,6 @@
 import time, warnings, sys, os.path as osp
 from .dataset import DSSDataset, DSSDatasetListItem, DSSManagedDatasetCreationHelper
-from .jupyternotebook import DSSJupyterNotebook, DSSNotebookContent
+from .jupyternotebook import DSSJupyterNotebook
 from .notebook import DSSNotebook
 from .streaming_endpoint import DSSStreamingEndpoint, DSSStreamingEndpointListItem, DSSManagedStreamingEndpointCreationHelper
 from .recipe import DSSRecipeListItem, DSSRecipe
@@ -829,23 +829,24 @@ def new_job_definition_builder(self, job_type='NON_RECURSIVE_FORCED_BUILD'):
     # Jupyter Notebooks
     ########################################################
 
-    def list_jupyter_notebooks(self, as_objects=True, active=False):
+    def list_jupyter_notebooks(self, active=False, as_type="object"):
         """
         List the jupyter notebooks of a project.
 
-        :param bool as_objects: if True, return the jupyter notebooks as a :class:`dataikuapi.dss.notebook.DSSNotebook`
-                        notebook handles instead of raw JSON
+        :param bool as_type: How to return the list. Supported values are "names" and "objects".
         :param bool active: if True, only return currently running jupyter notebooks.
 
-
-        :returns: The list of the notebooks - see as_objects for more information
-        :rtype: list
+        :returns: The list of the notebooks. If "as_type" is "names", each one as a string, if "as_type" is "objects", each one as a :class:`dataikuapi.dss.notebook.DSSJupyterNotebook`
+        :rtype: list of :class:`dataikuapi.dss.notebook.DSSJupyterNotebook` or list of String
         """
         notebook_names = self.client._perform_json("GET", "/projects/%s/jupyter-notebooks/" % self.project_key, params={"active": active})
-        if as_objects:
+        if as_type == "names" or as_type == "name":
+            return notebook_names
+        elif as_type == "objects" or as_type == "object":
             return [DSSJupyterNotebook(self.client, self.project_key, notebook_name) for notebook_name in notebook_names]
         else:
-            return notebook_names
+            raise ValueError("Unknown as_type")
+
 
     def get_jupyter_notebook(self, notebook_name):
         """

dataikuapi/dssclient.py

@@ -1,11 +1,9 @@
 import json
-import warnings
 
 from requests import Session
 from requests import exceptions
 from requests.auth import HTTPBasicAuth
 
-from dataikuapi.dss.jupyternotebook import DSSJupyterNotebook
 from dataikuapi.dss.notebook import DSSNotebook
 from .dss.future import DSSFuture
 from .dss.projectfolder import DSSProjectFolder