datastock 0.0.35__py3-none-any.whl → 0.0.37__py3-none-any.whl

datastock/_generic_check.py

@@ -80,8 +80,9 @@ def _check_var(
             var = allowed[0]
         elif var not in allowed:
             msg = (
-                f"Arg {varname} must be in {allowed}!\n"
-                f"Provided: {var}"
+                f"Arg {varname} not in allowed range!\n"
+                f"Provided: {var}\n"
+                f"Allowed: {allowed}\n"
             )
             raise Exception(_complete_extra_msg(msg, extra_msg))
 
@@ -98,8 +99,9 @@ def _check_var(
     if excluded is not None:
         if var in excluded:
             msg = (
-                f"Arg {varname} must not be in {excluded}!\n"
-                f"Provided: {var}"
+                f"Arg {varname} must not be in excluded range!\n"
+                f"Provided: {var}\n"
+                f"Excluded: {excluded}\n"
             )
             raise Exception(_complete_extra_msg(msg, extra_msg))
 
@@ -124,7 +126,7 @@ def _check_var(
 
         if err is True:
             msg = (
-                f"Arg {varname} must be {sign}\n"
+                f"Arg {varname} must be of sign {sign}\n"
                 f"Provided: {var}"
             )
             raise Exception(_complete_extra_msg(msg, extra_msg))
@@ -543,51 +545,47 @@ def _obj_key(d0=None, short=None, key=None, ndigits=None):
 #                   Utilities for plotting
 # #############################################################################
 
+# DEPRECATED
+# def _check_inplace(coll=None, keys=None):
+    # """ Check key to data and inplace """
 
-def _check_inplace(coll=None, keys=None, inplace=None):
-    """ Check key to data and inplace """
+    # # -----------------------------
+    # # keys of data to be extracted
+    # # ----------------------------
 
-    # key
-    if isinstance(keys, str):
-        keys = [keys]
-    keys = _check_var_iter(
-        keys, 'keys',
-        default=None,
-        types=list,
-        types_iter=str,
-        allowed=list(coll.ddata.keys()),
-    )
+    # if isinstance(keys, str):
+        # keys = [keys]
+    # keys = _check_var_iter(
+        # keys, 'keys',
+        # default=None,
+        # types=list,
+        # types_iter=str,
+        # allowed=list(coll.ddata.keys()),
+    # )
 
-    # inplace
-    inplace = _check_var(
-        inplace, 'inplace',
-        types=bool,
-        default=False,
-    )
+    # # ----------------------
+    # # extract sub-collection
+    # # ----------------------
 
-    # extract sub-collection of necessary
-    if inplace:
-        coll2 = coll
-    else:
-        lk0 = list(keys)
-        for key in keys:
+    # lk0 = list(keys)
+    # for key in keys:
 
-            # Include all data matching any single ref
-            for rr in coll._ddata[key]['ref']:
-                for k0, v0 in coll._ddata.items():
-                    if v0['ref'] == (rr,):
-                        if k0 not in lk0:
-                            lk0.append(k0)
+        # # Include all data matching any single ref
+        # for rr in coll._ddata[key]['ref']:
+            # for k0, v0 in coll._ddata.items():
+                # if v0['ref'] == (rr,):
+                    # if k0 not in lk0:
+                        # lk0.append(k0)
 
-            # include all data matching all refs
-            for k0, v0 in coll._ddata.items():
-                if v0['ref'] == coll._ddata[key]['ref']:
-                    if k0 not in lk0:
-                        lk0.append(k0)
+        # # include all data matching all refs
+        # for k0, v0 in coll._ddata.items():
+            # if v0['ref'] == coll._ddata[key]['ref']:
+                # if k0 not in lk0:
+                    # lk0.append(k0)
 
-        coll2 = coll.extract(lk0)
+    # coll2 = coll.extract(lk0)
 
-    return keys, inplace, coll2
+    # return keys, coll2
 
 
 def _check_dax(dax=None, main=None):
@@ -921,4 +919,4 @@ def _check_cmap_vminvmax(data=None, cmap=None, vmin=None, vmax=None):
         else:
             vmax = nanmax
 
-    return cmap, vmin, vmax
+    return cmap, vmin, vmax

datastock/_generic_utils.py

@@ -31,7 +31,10 @@ def _pretty_print_check(
     returnas=None,
 ):
 
+    # -------------
     # headers
+    # -------------
+
     c0 = (
         isinstance(headers, list)
         and all([
@@ -65,7 +68,10 @@ def _pretty_print_check(
                 headers[ii] = [headers[ii]]
     nhead = [len(h0[0]) for h0 in headers]
 
+    # -------------
     # content
+    # -------------
+
     c0 = (
         isinstance(content, list)
         and all([
@@ -92,10 +98,14 @@ def _pretty_print_check(
         )
         raise Exception(msg)
 
+    # -------------
+    # options
+    # -------------
+
     # sep
     sep = _generic_check._check_var(
         sep, 'sep',
-        default=' ',
+        default='  ',
         types=str,
     )
 

datastock/_generic_utils_plot.py

@@ -17,6 +17,7 @@ __all__ = [
     'set_aspect3d',
 ]
 
+
 # ###############################################################
 # ###############################################################
 #                   set_aspect3d
@@ -31,7 +32,7 @@ def set_aspect3d(
     # ------------
     # check inputs
 
-    ax, margin =  _check(
+    ax, margin = _set_aspect3d_check(
         ax=ax,
         margin=margin,
     )
@@ -73,7 +74,7 @@ def set_aspect3d(
 # ################
 
 
-def _check(
+def _set_aspect3d_check(
     ax=None,
     margin=None,
 ):
@@ -100,4 +101,76 @@ def _check(
         sign='>=0',
     )
 
-    return ax, margin
+    return ax, margin
+
+
+# ############################################################
+# ############################################################
+#                _get_str_datadlab
+# ############################################################
+
+
+def _get_str_datadlab(
+    coll=None,
+    keyX=None,
+    refX=None,
+    nx=None,
+    islogX=None,
+):
+
+    keyX2 = keyX
+    xstr = (
+        (keyX != 'index')
+        and coll.ddata[keyX]['data'].dtype.type == np.str_
+    )
+
+    # --------------------
+    # add index vector
+
+    if keyX == 'index' or xstr:
+        keyX2 = f"{refX}_index"
+
+        c0 = (
+            keyX2 in coll.ddata.keys()
+            and coll.ddata[keyX2]['ref'] == (refX,)
+            and np.allclose(coll.ddata[keyX2]['data'], np.arange(nx))
+        )
+
+        if not c0:
+            coll.add_data(
+                key=keyX2,
+                data=np.arange(0, nx),
+                ref=refX,
+                units='',
+            )
+        dX2 = 0.5
+        if keyX == 'index':
+            labX = "index"
+        else:
+            labX = ''
+
+        if xstr is True:
+            xstr = coll.ddata[keyX]['data']
+
+    # -------------------------------------
+    # keyX refers to exising numerical data
+
+    else:
+        if islogX is True:
+            keyX2 = f"{keyX}_log10"
+            coll.add_data(
+                key=keyX2,
+                data=np.log10(coll.ddata[keyX]['data']),
+                ref=coll.ddata[keyX]['ref'],
+                units=coll.ddata[keyX]['units'],
+            )
+            labX = r"$\log_{10}$" + f"({keyX} ({coll._ddata[keyX]['units']}))"
+            dataX = coll.ddata[keyX2]['data']
+            coll.remove_data(keyX, propagate=False)
+
+        else:
+            labX = f"{keyX} ({coll._ddata[keyX]['units']})"
+            dataX = coll.ddata[keyX]['data']
+        dX2 = np.nanmean(np.diff(dataX)) / 2.
+
+    return keyX2, xstr, dX2, labX

datastock/_plot_BvsA_as_distribution_check.py

@@ -116,12 +116,16 @@ def _plot_BvsA_check(
         dataB = dataB.toarray()
 
     # check key, inplace flag and extract sub-collection
-    keys, inplace, coll2 = _generic_check._check_inplace(
-        coll=coll,
-        keys=[keyA, keyB],
-        inplace=inplace,
+    lk = [kk for kk in [keyA, keyB, keyX] if kk is not None]
+    coll2, key = coll.extract(
+        lk,
+        inc_monot=False,
+        inc_vectors=False,
+        inc_allrefs=False,
+        return_keys=True,
     )
-    keyA, keyB = keys
+    keyA, keyB = key[:2]
+
     dimA, dimB = dataA.ndim, dataB.ndim
     if dimA > dimB:
         ndim, refs, shape = dimA, refA, dataA.shape