Merge branch 'release/7.0' into fterrazzoni/eda-public-api-client

Author: fterrazzoni

README

@@ -1,4 +1,4 @@
 API client for Dataiku Data Science Studio
 
 For more information, see:
-https://doc.dataiku.com/dss/latest/api/public/client-python/index.html
+https://doc.dataiku.com/dss/latest/python-api/rest-api-client/index.html

dataikuapi/dss/dataset.py

@@ -337,14 +337,15 @@ def with_store_into(self, connection, type_option_id = None, format_option_id =
             self.creation_settings["specificSettings"]["formatOptionId"] = format_option_id 
         return self
 
-    def with_copy_partitioning_from(self, dataset_ref):
+    def with_copy_partitioning_from(self, dataset_ref, object_type='DATASET'):
         """
         Sets the new managed dataset to use the same partitioning as an existing dataset_name
 
         :param str dataset_ref: Name of the dataset to copy partitioning from
         :return: self
         """
-        self.creation_settings["partitioningOptionId"] = "copy:%s" % dataset_ref
+        code = 'dataset' if object_type == 'DATASET' else 'folder'
+        self.creation_settings["partitioningOptionId"] = "copy:%s:%s" % (code, dataset_ref)
         return self
 
     def create(self):

dataikuapi/dss/ml.py

@@ -534,7 +534,10 @@ def get_variables(self):
     def set_variables(self, obj):
         """
         Sets the variables of this project.
-        @param obj: must be a modified version of the object returned by get_variables
+        WARNING: if executed from a python recipe, the changes made by `set_variables` will not be "seen" in that recipe.
+                 Use the internal API dataiku.get_custom_variables() instead if this behavior is needed
+
+        @param dict obj: must be a modified version of the object returned by get_variables
         """
         if not "standard" in obj:
             raise ValueError("Missing 'standard' key in argument")

dataikuapi/dss/project.py

@@ -329,7 +329,7 @@ def with_new_output(self, name, connection_id, typeOptionId=None, format_option_
                                      AVRO, ORC 
         :param override_sql_schema: schema to force dataset, for SQL dataset. If left empty, will be autodetected
         :param str partitioning_option_id: to copy the partitioning schema of an existing dataset 'foo', pass a
-                                           value of 'copy:foo'
+                                           value of 'copy:dataset:foo'
         :param append: whether the recipe should append or overwrite the output when running
                        (note: not available for all dataset types)
         :param str object_type: DATASET or MANAGED_FOLDER

dataikuapi/dss/recipe.py

@@ -156,6 +156,13 @@ def get_average_duration(self, limit=3):
             return None
         return sum([run.get_duration() for run in last_runs]) / len(last_runs)
 
+    def delete(self):
+        """
+        Deletes this scenario
+        """
+        return self.client._perform_json(
+            "DELETE", "/projects/%s/scenarios/%s" % (self.project_key, self.id))
+
     ########################################################
     # Discussions
     ########################################################

dataikuapi/dss/scenario.py

@@ -237,6 +237,16 @@ def upload_attachement(self, fp, filename):
 
         self.client._perform_json("POST", "/projects/%s/wiki/%s/upload" % (self.project_key, dku_quote_fn(self.article_id)), files={"file":(clean_filename, fp)})
 
+    def get_uploaded_file(self, upload_id):
+        """"
+        Download the attachement of an article
+
+        :param str upload_id: The attachement upload id
+        :returns: The requests.Response object
+        :rtype: :class:`requests.Response`
+        """
+        return self.client._perform_raw("GET", "/projects/%s/wiki/%s/uploads/%s" % (self.project_key, self.article_id, upload_id))
+
     def delete(self):
         """
         Delete the article

dataikuapi/dss/wiki.py

@@ -94,3 +94,28 @@ def str_to_bool(s):
                                                 doublequote=True):
                 yield [none_if_throws(caster)(val)
                         for (caster, val) in dku_zip_longest(casters, uncasted_tuple)]
+
+class DSSInternalDict(object):
+    """
+    Class that provides some helpers and an `_internal_dict` dict field that is the actual holder of the data.
+    """
+    
+    def __init__(self, orig_dict=None):
+        if orig_dict is None:
+            self._internal_dict = dict()
+        else:
+            self._internal_dict = orig_dict
+
+    def get(self, name, default=None):
+        return self._internal_dict.get(name, default)
+
+    def get_raw(self):
+        """
+        Gets the raw dictionary of the actual data
+
+        :rtype: dict
+        """
+        return self._internal_dict
+
+    def __repr__(self):
+        return self.__class__.__name__ + "(" + self._internal_dict.__repr__() + ")"

dataikuapi/utils.py

@@ -2,7 +2,7 @@
 
 from setuptools import setup
 
-VERSION = "6.0.0"
+VERSION = "7.0.0"
 
 long_description = (open('README').read() +
     '\n\n' + open('HISTORY.txt').read())