Relocate /statistics/* on top of /datasets/XXX/statistics/*

Author: fterrazzoni

dataikuapi/dss/dataset.py

@@ -4,6 +4,7 @@
 import json
 from .metrics import ComputedMetrics
 from .discussion import DSSObjectDiscussions
+from .worksheet import DSSStatisticsWorksheet, DSSStatisticsCard
 
 class DSSDataset(object):
     """
@@ -204,6 +205,57 @@ def run_checks(self, partition='', checks=None):
                     "POST" , "/projects/%s/datasets/%s/actions/runChecks" %(self.project_key, self.dataset_name),
                     params={'partition':partition}, body=checks)
 
+    ########################################################
+    # Statistics worksheets
+    ########################################################
+
+    def list_statistics_worksheets(self, as_objects=True):
+        worksheets = self.client._perform_json(
+            "GET", "/projects/%s/datasets/%s/statistics/worksheets/" % (self.project_key, self.dataset_name))
+        if as_objects:
+            return [self.get_statistics_worksheet(worksheet['id']) for worksheet in worksheets]
+        else:
+            return worksheets
+
+    def create_statistics_worksheet(self, name="My worksheet"):
+        """
+        Create a new worksheet in the project, and return a handle to interact with it.
+
+        :param string input_dataset: input dataset of the worksheet
+        :param string worksheet_name: name of the worksheet
+
+        Returns:
+            A :class:`dataikuapi.dss.dataset.DSSStatisticsWorksheet` dataset handle
+        """
+
+        worksheet_definition = {
+            "projectKey": self.project_key,
+            "name": name,
+            "dataSpec": {
+                "inputDatasetSmartName": self.dataset_name,
+                "datasetSelection": {
+                    "partitionSelectionMethod": "ALL",
+                    "maxRecords": 30000,
+                    "samplingMethod": "FULL"
+                }
+            }
+        }
+        created_worksheet = self.client._perform_json(
+            "POST", "/projects/%s/datasets/%s/statistics/worksheets/" % (self.project_key, self.dataset_name),
+            body=worksheet_definition
+        )
+        return self.get_statistics_worksheet(created_worksheet['id'])
+
+    def get_statistics_worksheet(self, worksheet_id):
+        """
+        Get a handle to interact with a specific worksheet
+
+        :param string worksheet_id: the ID of the desired worksheet
+
+        :returns: A :class:`dataikuapi.dss.worksheet.DSSStatisticsWorksheet` worksheet handle
+        """
+        return DSSStatisticsWorksheet(self.client, self.project_key, self.dataset_name, worksheet_id)
+
     ########################################################
     # Metrics
     ########################################################

dataikuapi/dss/project.py

@@ -5,7 +5,6 @@
 from .savedmodel import DSSSavedModel
 from .job import DSSJob, DSSJobWaiter
 from .scenario import DSSScenario
-from .worksheet import DSSStatisticsWorksheet, DSSStatisticsCard
 from .apiservice import DSSAPIService
 import sys
 import os.path as osp
@@ -16,8 +15,7 @@
 from .discussion import DSSObjectDiscussions
 from .ml import DSSMLTask
 from .analysis import DSSAnalysis
-from dataikuapi.utils import DataikuException, resolve_smart_name
-
+from dataikuapi.utils import DataikuException
 
 
 class DSSProject(object):
@@ -794,60 +792,8 @@ def set_tags(self, tags={}):
         Set the tags of this project.
         @param obj: must be a modified version of the object returned by list_tags
         """
-        return self.client._perform_empty("PUT", "/projects/%s/tags" % self.project_key, body=tags)
-
-    ########################################################
-    # Statistics worksheets
-    ########################################################
-
-    def list_statistics_worksheets(self, as_objects=True):
-        worksheets = self.client._perform_json(
-            "GET", "/projects/%s/statistics/worksheets/" % self.project_key)
-        if as_objects:
-            return [self.get_statistics_worksheet(worksheet['id']) for worksheet in worksheets]
-        else:
-            return worksheets
-
-    def create_statistics_worksheet(self, input_dataset, name="My worksheet"):
-        """
-        Create a new worksheet in the project, and return a handle to interact with it.
+        return self.client._perform_empty("PUT", "/projects/%s/tags" % self.project_key, body = tags)
 
-        :param string input_dataset: input dataset of the worksheet
-        :param string worksheet_name: name of the worksheet
-
-        Returns:
-            A :class:`dataikuapi.dss.dataset.DSSStatisticsWorksheet` dataset handle
-        """
-        dataset_project_key, dataset_name = resolve_smart_name(
-            input_dataset, self.project_key)
-
-        worksheet_definition = {
-            "projectKey": self.project_key,
-            "name": name,
-            "dataSpec": {
-                "dataset": {"id": dataset_name, "projectKey": dataset_project_key},
-                "datasetSelection": {
-                    "partitionSelectionMethod": "ALL",
-                    "maxRecords": 30000,
-                    "samplingMethod": "FULL"
-                }
-            }
-        }
-        created_worksheet = self.client._perform_json(
-            "POST", "/projects/%s/statistics/worksheets/" % self.project_key,
-            body=worksheet_definition
-        )
-        return self.get_statistics_worksheet(created_worksheet['id'])
-
-    def get_statistics_worksheet(self, worksheet_id):
-        """
-        Get a handle to interact with a specific worksheet
-
-        :param string worksheet_id: the ID of the desired worksheet
-
-        :returns: A :class:`dataikuapi.dss.worksheet.DSSStatisticsWorksheet` worksheet handle
-        """
-        return DSSStatisticsWorksheet(self.client, self.project_key, worksheet_id)
 
     ########################################################
     # Macros

dataikuapi/dss/worksheet.py

@@ -10,9 +10,10 @@ class DSSStatisticsWorksheet(object):
     A handle to interact with a worksheet on the DSS instance
     """
 
-    def __init__(self, client, project_key, worksheet_id):
+    def __init__(self, client, project_key, dataset_name, worksheet_id):
         self.client = client
         self.project_key = project_key
+        self.dataset_name = dataset_name
         self.worksheet_id = worksheet_id
 
     ########################################################
@@ -24,7 +25,7 @@ def delete(self):
         Delete the worksheet
         """
         return self.client._perform_empty(
-            "DELETE", "/projects/%s/statistics/worksheets/%s" % (self.project_key, self.worksheet_id))
+            "DELETE", "/projects/%s/datasets/%s/statistics/worksheets/%s" % (self.project_key, self.dataset_name, self.worksheet_id))
 
     ########################################################
     # Worksheet definition
@@ -38,7 +39,7 @@ def get_definition(self):
             the definition, as a JSON object
         """
         return self.client._perform_json(
-            "GET", "/projects/%s/statistics/worksheets/%s" % (self.project_key, self.worksheet_id))
+            "GET", "/projects/%s/datasets/%s/statistics/worksheets/%s" % (self.project_key, self.dataset_name, self.worksheet_id))
 
     def set_definition(self, definition):
         """
@@ -49,7 +50,7 @@ def set_definition(self, definition):
             that has been retrieved using the get_definition call.
         """
         return self.client._perform_json(
-            "PUT", "/projects/%s/statistics/worksheets/%s" % (self.project_key, self.worksheet_id), body=definition)
+            "PUT", "/projects/%s/datasets/%s/statistics/worksheets/%s" % (self.project_key, self.dataset_name, self.worksheet_id), body=definition)
 
     def add_card(self, card_definition):
         """
@@ -73,7 +74,8 @@ def get_standalone_cards(self):
         definition = self.get_definition()
         standalone_cards = []
         for card in definition["rootCard"]["cards"]:
-            standalone_cards.append(DSSStatisticsCard(self.client, self.project_key, definition['dataSpec'], card))
+            standalone_cards.append(DSSStatisticsCard(
+                self.client, self.project_key, self.dataset_name, definition['dataSpec'], card))
 
         return standalone_cards
 
@@ -89,7 +91,7 @@ def compute(self):
         """
 
         future_response = self.client._perform_json(
-            "POST", "/projects/%s/statistics/worksheets/%s/actions/compute-worksheet" % (self.project_key, self.worksheet_id))
+            "POST", "/projects/%s/datasets/%s/statistics/worksheets/%s/actions/compute-worksheet" % (self.project_key, self.dataset_name, self.worksheet_id))
 
         return DSSFuture(self.client, future_response.get("jobId", None), future_response)
 
@@ -101,9 +103,10 @@ class DSSStatisticsCard(object):
     Unlike a worksheet, a standalone card is not persisted on the DSS instance
     """
 
-    def __init__(self, client, project_key, data_spec, card):
+    def __init__(self, client, project_key, dataset_name, data_spec, card):
         self.client = client
         self.project_key = project_key
+        self.dataset_name = dataset_name
         self.data_spec = data_spec
         self.card = card
 
@@ -115,6 +118,7 @@ def compute(self):
         """
 
         future_response = self.client._perform_json(
-            "POST", "/projects/%s/statistics/cards/compute-card" % self.project_key,
+            "POST", "/projects/%s/datasets/%s/statistics/cards/compute-card" % (
+                self.project_key, self.dataset_name),
             body={"card": self.card, "dataSpec": self.data_spec})
         return DSSFuture(self.client, future_response.get("jobId", None), future_response)

dataikuapi/utils.py

@@ -94,12 +94,3 @@ def str_to_bool(s):
                                                 doublequote=True):
                 yield [none_if_throws(caster)(val)
                         for (caster, val) in dku_zip_longest(casters, uncasted_tuple)]
-
-def resolve_smart_name(smart_name, context_project_key):
-    parts = smart_name.split('.')
-    if len(parts) == 1:
-        return context_project_key, smart_name
-    elif len(parts) == 2:
-        return parts[0], parts[1]
-    else:
-        raise ValueError('Invalid smart name: %s' % smart_name)