Rename dict-like class and add docstring

Author: nicolasservel

dataikuapi/dss/ml.py

@@ -1,7 +1,7 @@
 from ..utils import DataikuException
 from ..utils import DataikuUTF8CSVReader
 from ..utils import DataikuStreamedHttpUTF8CSVReader
-from ..utils import DSSExtendableDict
+from ..utils import DSSExtensibleDict
 import json
 import time
 from .metrics import ComputedMetrics
@@ -722,7 +722,7 @@ def get_partial_dependencies(self):
         return DSSPartialDependencies(data)
 
 
-class DSSSubpopulationModality(DSSExtendableDict):
+class DSSSubpopulationModality(DSSExtensibleDict):
     """
     Object to read details of a subpopulation analysis modality
 
@@ -804,7 +804,7 @@ def contains(self, value):
         return value == self.value
 
 
-class DSSSubpopulationAnalysis(DSSExtendableDict):
+class DSSSubpopulationAnalysis(DSSExtensibleDict):
     """
     Object to read details of a subpopulation analysis of a trained model
 
@@ -871,7 +871,7 @@ def get_raw(self):
         return self.internal_dict
 
 
-class DSSSubpopulationAnalyses(DSSExtendableDict):
+class DSSSubpopulationAnalyses(DSSExtensibleDict):
     """
     Object to read details of subpopulation analyses of a trained model
 
@@ -912,7 +912,7 @@ def get_analysis(self, feature):
             raise ValueError("Subpopulation analysis for feature '%s' cannot be found" % feature)
 
 
-class DSSPartialDependence(DSSExtendableDict):
+class DSSPartialDependence(DSSExtensibleDict):
     """
     Object to read details of partial dependence of a trained model
 
@@ -939,7 +939,7 @@ def get_raw(self):
         return self.internal_dict
 
 
-class DSSPartialDependencies(DSSExtendableDict):
+class DSSPartialDependencies(DSSExtensibleDict):
     """
     Object to read details of partial dependencies of a trained model
 

dataikuapi/utils.py

@@ -95,7 +95,16 @@ def str_to_bool(s):
                 yield [none_if_throws(caster)(val)
                         for (caster, val) in dku_zip_longest(casters, uncasted_tuple)]
 
-class DSSExtendableDict(dict):
+class DSSExtensibleDict(dict):
+    """
+    Utility to define dict-like objects that can be sub-classed.
+    
+    Behaves like dict for most common operations. In particular, 
+    it is possible to update an instance of `:class:`dataikuapi.dss.ml.DSSExtensibleDict` 
+    with either a dict or another instance of `:class:`dataikuapi.dss.ml.DSSExtensibleDict`.
+    
+    Provides an `internal_dict` dict field that is the actual holder of the data.
+    """
 
     def __init__(self, orig_dict=None):
         if orig_dict is None:
@@ -149,7 +158,7 @@ def setdefault(self, key, default_value=None):
         return self.internal_dict.setdefault(key, default_value)
 
     def update(self, *args, **kwargs):
-        if len(args) == 1 and isinstance(args[0], DSSExtendableDict):
+        if len(args) == 1 and isinstance(args[0], DSSExtensibleDict):
             self.internal_dict.update(args[0].internal_dict, **kwargs)
         else:
             self.internal_dict.update(*args, **kwargs)