datastock 0.0.38__py3-none-any.whl → 0.0.40__py3-none-any.whl

datastock/_class1.py

@@ -617,6 +617,9 @@ class DataStock1(DataStock0):
         quant=None,
         name=None,
         units=None,
+        # exclude from search
+        key_exclude=None,
+        ref_exclude=None,
         # nearest-neighbour interpolation input
         values=None,
         indices=None,
@@ -666,6 +669,9 @@ class DataStock1(DataStock0):
             quant=quant,
             name=name,
             units=units,
+            # exclude from search
+            key_exclude=key_exclude,
+            ref_exclude=ref_exclude,
             # parameters
             values=values,
             indices=indices,
@@ -686,6 +692,9 @@ class DataStock1(DataStock0):
         # strategy for choosing common ref vector
         strategy=None,
         strategy_bounds=None,
+        # exclude from search
+        key_exclude=None,
+        ref_exclude=None,
         # values, indices
         values=None,
         indices=None,
@@ -719,6 +728,9 @@ class DataStock1(DataStock0):
             # strategy for choosing common ref vector
             strategy=strategy,
             strategy_bounds=strategy_bounds,
+            # exclude from search
+            key_exclude=key_exclude,
+            ref_exclude=ref_exclude,
             # parameters
             values=values,
             indices=indices,
@@ -977,6 +989,37 @@ class DataStock1(DataStock0):
     def show_interactive(self):
         self.show(show_which=['axes', 'mobile', 'interactivity'])
 
+    def show_details(
+        self,
+        key=None,
+        which=None,
+        # pretty print options
+        sep=None,
+        line=None,
+        justify=None,
+        table_sep=None,
+        # bool options
+        verb=True,
+        returnas=False,
+    ):
+        """ Summary description of the object content """
+        return _class1_show.main_details(
+            coll=self,
+            which=which,
+            key=key,
+            # pretty print options
+            sep=sep,
+            line=line,
+            justify=justify,
+            table_sep=table_sep,
+            # bool options
+            verb=verb,
+            returnas=returnas,
+        )
+
+    def _get_show_details(self, which=None, key=None):
+        raise NotImplementedError()
+
     def __repr__(self):
         try:
             return self.show(returnas=str, verb=False)

datastock/_class1_check.py

@@ -904,7 +904,7 @@ def _check_ddata(
                                 v0.get('ref') is None
                                 or isinstance(v0.get('ref'), str)
                                 or (
-                                    isinstance(v0.get('ref'), tuple)
+                                    isinstance(v0.get('ref'), (list, tuple))
                                     and all([
                                         isinstance(rr, str)
                                         for rr in v0['ref']
@@ -977,6 +977,8 @@ def _check_ddata(
         # find ref
         if isinstance(v0['ref'], str):
             ddata[k0]['ref'] = (v0['ref'],)
+        elif isinstance(v0['ref'], list):
+            ddata[k0]['ref'] = tuple(v0['ref'])
 
         _check_data_ref(
             k0=k0,

datastock/_class1_show.py

@@ -13,7 +13,6 @@ from . import _generic_utils
 from . import _generic_check
 
 
-
 #############################################
 #############################################
 #       Main
@@ -77,7 +76,13 @@ def main(
         for k0 in coll._dobj.keys():
             if 'obj' in show_which or k0 in show_which:
                 func = coll._get_show_obj(k0)
-                lcol, lar = func(coll=coll, which=k0, lcol=lcol, lar=lar, show=show)
+                lcol, lar = func(
+                    coll=coll,
+                    which=k0,
+                    lcol=lcol,
+                    lar=lar,
+                    show=show,
+                )
 
     return _generic_utils.pretty_print(
         headers=lcol,
@@ -403,4 +408,116 @@ def _show_extract(dobj=None, lk=None):
         else:
             lv0.append(str(v0))
 
-    return lv0
+    return lv0
+
+
+#############################################
+#############################################
+#       Main - details
+#############################################
+
+
+def main_details(
+    coll=None,
+    # options
+    which=None,
+    key=None,
+    # print parameters
+    sep=None,
+    line=None,
+    justify=None,
+    table_sep=None,
+    # bool options
+    verb=True,
+    returnas=False,
+):
+
+    # -------------
+    # check inputs
+    # -------------
+
+    which, key = _check_details(
+        coll=coll,
+        which=which,
+        key=key,
+    )
+
+    # intialize
+    lcol, lar = [], []
+
+    # -----------------------
+    # Build for dobj
+    # -----------------------
+
+    func = coll._get_show_details(which=which)
+    lcol, lar = func(
+        coll=coll,
+        key=key,
+        lcol=lcol,
+        lar=lar,
+    )
+
+    return _generic_utils.pretty_print(
+        headers=lcol,
+        content=lar,
+        sep=sep,
+        line=line,
+        table_sep=table_sep,
+        verb=verb,
+        returnas=returnas,
+    )
+
+
+###########################################################
+###########################################################
+#       check details
+###########################################################
+
+
+def _check_details(
+    coll=None,
+    which=None,
+    key=None,
+):
+
+    # -------------
+    # key
+    # -------------
+
+    lok_which = list(coll._dobj.keys())
+    dkey = {}
+    for kw in lok_which:
+        dkey.update({
+            k1: kw for k1 in coll.dobj[kw].keys()
+        })
+
+    # check
+    try:
+        key = _generic_check._check_var(
+            key, 'key',
+            types=str,
+            allowed=list(dkey.keys()),
+        )
+
+        which = dkey[key]
+
+    except Exception:
+
+        # -------------
+        # show_which
+
+        lok = list(coll._dobj.keys())
+        which = _generic_check._check_var(
+            which, 'which',
+            types=str,
+            allowed=lok,
+        )
+
+        lok = [k1 for k1, kw in dkey.items() if kw == which]
+        key = _generic_check._check_var(
+            key, 'key',
+            types=str,
+            allowed=lok,
+        )
+
+    return which, key

datastock/_class1_uniformize.py

@@ -43,6 +43,9 @@ def get_ref_vector(
     quant=None,
     name=None,
     units=None,
+    # exclude from search
+    key_exclude=None,
+    ref_exclude=None,
     # parameters
     values=None,
     indices=None,
@@ -52,6 +55,7 @@ def get_ref_vector(
 
     # ----------------
     # check inputs
+    # ----------------
 
     # ind_strict
     ind_strict = _generic_check._check_var(
@@ -82,6 +86,27 @@ def get_ref_vector(
         allowed=lkok,
     )
 
+    # key_exclude
+    if key_exclude is not None:
+        if isinstance(key_exclude, str):
+            key_exclude = [key_exclude]
+        key_exclude = _generic_check._check_var_iter(
+            key_exclude, 'key_exclude',
+            types=(list, tuple),
+            types_iter=str,
+        )
+
+    # ref_exclude
+    if ref_exclude is not None:
+        if isinstance(ref_exclude, str):
+            ref_exclude = [ref_exclude]
+        ref_exclude = _generic_check._check_var_iter(
+            ref_exclude, 'ref_exclude',
+            types=(list, tuple),
+            types_iter=str,
+        )
+
+    # key0 vs ref
     if key0 is None and ref is None:
         msg = "Please provide key0 or ref at least!"
         raise Exception(msg)
@@ -95,6 +120,7 @@ def get_ref_vector(
 
     # ------------------------
     # hasref, hasvect
+    # ------------------------
 
     hasref = None
     if ref is not None and key0 is not None:
@@ -109,8 +135,13 @@ def get_ref_vector(
     elif key0 is not None:
         refok = ddata[key0]['ref']
 
+    # ----------------------
     # identify possible vect
+    # ----------------------
+
     if hasref is not False:
+
+
         lp = [('dim', dim), ('quant', quant), ('name', name), ('units', units)]
         lk_vect = [
             k0 for k0, v0 in ddata.items()
@@ -121,6 +152,8 @@ def get_ref_vector(
                 or (vv is not None and v0[ss] == vv)
                 for ss, vv in lp
             ])
+            and (key_exclude is None or k0 not in key_exclude)
+            and (ref_exclude is None or v0['ref'][0] not in ref_exclude)
         ]
 
         # if key is provided
@@ -134,7 +167,7 @@ def get_ref_vector(
         # cases
         if len(lk_vect) == 0:
             if warn is True:
-                msg = "No matching vector found!"
+                msg = f"No vector found for key0 = '{key0}', ref '{ref}'!"
                 warnings.warn(msg)
             hasvect = False
 
@@ -148,27 +181,30 @@ def get_ref_vector(
                 hasref = True
 
         else:
-            if warn is True:
-                msg = (
-                    f"Multiple possible vectors found:\n{lk_vect}\n"
-                    f"\t- key0: {key0}\n"
-                    f"\t- ref: {ref}\n"
-                    f"\t- hasref: {hasref}\n"
-                    f"\t- refok: {refok}\n"
-                )
-                warnings.warn(msg)
+            msg = (
+                f"Multiple possible vectors found:\n{lk_vect}\n"
+                f"\t- key0: {key0}\n"
+                f"\t- ref: {ref}\n"
+                f"\t- hasref: {hasref}\n"
+                f"\t- refok: {refok}\n"
+            )
+            warnings.warn(msg)
             hasvect = False
     else:
         hasvect = False
 
+    # -------------------------
     # set hasref if not yet set
+
     if hasvect is False:
         key_vector = None
         if hasref is None:
             hasref = False
             ref = None
 
+    # ----------------------
     # consistency check
+
     assert hasref == (ref is not None)
     assert hasvect == (key_vector is not None)
 
@@ -180,6 +216,7 @@ def get_ref_vector(
 
     # -----------------
     # values vs indices
+    # -----------------
 
     dind = _get_ref_vector_values(
         dref=dref,
@@ -193,7 +230,9 @@ def get_ref_vector(
         indices=indices,
     )
 
+    # -----
     # val
+
     if dind is None:
         if key_vector is not None:
             val = ddata[key_vector]['data']
@@ -457,6 +496,9 @@ def get_ref_vector_common(
     quant=None,
     name=None,
     units=None,
+    # exclude from search
+    key_exclude=None,
+    ref_exclude=None,
     # strategy for choosing common ref vector
     strategy=None,
     strategy_bounds=None,
@@ -522,6 +564,10 @@ def get_ref_vector_common(
             quant=quant,
             name=name,
             units=units,
+            # exclude from search
+            key_exclude=key_exclude,
+            ref_exclude=ref_exclude,
+            # parameters
             values=None,
             indices=None,
         )
@@ -699,6 +745,9 @@ def get_ref_vector_common(
         dkeys=dkeys,
         key_vector=key_vector,
         val=val,
+        # exclude from search
+        key_exclude=key_exclude,
+        ref_exclude=ref_exclude,
         # values, indices
         values=values,
         indices=indices,
@@ -727,6 +776,9 @@ def _get_ref_vector_common_values(
     dkeys=None,
     key_vector=None,
     val=None,
+    # exclude from search
+    key_exclude=None,
+    ref_exclude=None,
     # values, indices
     values=None,
     indices=None,
@@ -755,6 +807,10 @@ def _get_ref_vector_common_values(
                 quant=quant,
                 name=name,
                 units=units,
+                # exclude from search
+                key_exclude=key_exclude,
+                ref_exclude=ref_exclude,
+                # parameters
                 values=values,
                 indices=indices,
             )

datastock/_class2.py

@@ -87,12 +87,18 @@ class DataStock2(DataStock1):
 
         if isinstance(dtype, str):
             dtype = [dtype]
+        lok = [
+            'xdata', 'ydata',
+            'data', 'data.T',
+            'xy', 'alpha',
+            'txt', 'x', 'y', 'position',
+        ]
         dtype = _generic_check._check_var_iter(
             dtype,
             'dtype',
             types=(list, tuple),
             types_iter=str,
-            allowed=['xdata', 'ydata', 'data', 'data.T', 'xy', 'alpha', 'txt']
+            allowed=lok,
         )
         if len(dtype) != nref:
             msg = (

datastock/_class2_interactivity.py

@@ -479,6 +479,15 @@ def get_fupdate(handle=None, dtype=None, norm=None, bstr=None):
             handle.set_alpha(norm(val))
     elif dtype == 'txt':
         func = lambda val, handle=handle, bstr=bstr: handle.set_text(bstr.format(val))
+    elif dtype == 'x':
+        def func(val, handle=handle):
+            handle.set_x(val)
+    elif dtype == 'y':
+        def func(val, handle=handle):
+            handle.set_y(val)
+    elif dtype == 'position':
+        def func(val, handle=handle):
+            handle.set_position(val)
     else:
         msg = f'Unknown mobile dtype: {dtype}'
         raise Exception(msg)
@@ -579,4 +588,4 @@ def _update_mobile(k0=None, dmobile=None, dref=None, ddata=None):
                     # ddata[dmobile[k0]['data'][ii]]['data'][
                         # dmobile[k0]['func_slice'][ii](iref[ii])
                     # ]
-                # )
+                # )

datastock/_plot_as_array.py

@@ -906,4 +906,4 @@ def get_data_str(dk=None, coll2=None, key=None, ndim=None, dscale=None):
     else:
         lab = f"{key} ({units})"
 
-    return dk, key, lab
+    return dk, key, lab

datastock/_plot_as_array_234d.py

@@ -783,4 +783,4 @@ def _label_axes(
             ax.set_xticks([])
             ax.set_yticks([])
 
-    return dax
+    return dax

datastock/version.py

@@ -1,2 +1,2 @@
 # Do not edit, pipeline versioning governed by git tags!
-__version__ = '0.0.38'
+__version__ = '0.0.40'

{datastock-0.0.38.dist-info → datastock-0.0.40.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datastock
-Version: 0.0.38
+Version: 0.0.40
 Summary: A python library for generic class and data handling
 Home-page: https://github.com/ToFuProject/datastock
 Author: Didier VEZINET
@@ -23,12 +23,12 @@ Requires-Dist: scipy
 Requires-Dist: matplotlib
 Requires-Dist: astropy
 Provides-Extra: dev
-Requires-Dist: check-manifest ; extra == 'dev'
-Requires-Dist: coverage ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: sphinx ; extra == 'dev'
-Requires-Dist: sphinx-gallery ; extra == 'dev'
-Requires-Dist: sphinx-bootstrap-theme ; extra == 'dev'
+Requires-Dist: check-manifest; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-gallery; extra == "dev"
+Requires-Dist: sphinx-bootstrap-theme; extra == "dev"
 
 [![Conda]( https://anaconda.org/conda-forge/datastock/badges/version.svg)](https://anaconda.org/conda-forge/datastock)
 [![](https://anaconda.org/conda-forge/datastock/badges/downloads.svg)](https://anaconda.org/conda-forge/datastock)

{datastock-0.0.38.dist-info → datastock-0.0.40.dist-info}/RECORD

@@ -3,16 +3,16 @@ datastock/_DataCollection_utils.py,sha256=hHf6HvGKMmM-psx3fj9QcY1TEmKrAtTdkRokH7
 datastock/__init__.py,sha256=i_Ijl-AM07n4zN52frWfbeGN1iB6v4e5oLzTuVIh_oM,217
 datastock/_class.py,sha256=Az9PS3aSskiPMb1ekt78Y2ynBujYVc_cDjJxW9xH9g4,47
 datastock/_class0.py,sha256=QULjNJke13jJrGLIeM7SWHZVziorDK_KCIlqq8LgS9U,5883
-datastock/_class1.py,sha256=PVlY3_kZQk_Nm4RL-GcdAGWoR7O4_h60NCveg2zAYgI,27591
+datastock/_class1.py,sha256=8R4zM6p7b62FJuoI7Gyik4_tRCUFi6aF4oaMimiOoFE,28726
 datastock/_class1_binning.py,sha256=LWHv2LIfgZfSFWYwqdcN0DKpNe6q7Go3sxfcJqmzTrI,28085
-datastock/_class1_check.py,sha256=0oWF07MOo2c_G7219H7Dz-gRjBiTDDqbZ5loq9mC8ko,50574
+datastock/_class1_check.py,sha256=0PikkAZjlU0L59i8iue3ihK1t_uN-9oGh9Xe060QvWo,50672
 datastock/_class1_compute.py,sha256=yHdG0afYc_YtjpR6RvMh7SeRtWEyuHZ5y9VOPRIYVDo,31671
 datastock/_class1_domain.py,sha256=bkuCl29QO7C3RchC8qZyreU90QxmdDYNVYDmzuCLCUY,6252
 datastock/_class1_interpolate.py,sha256=3LRKK6aOepJLSnRoRpsS8RAnobqTdE-QZrkdQrnIaqc,37825
-datastock/_class1_show.py,sha256=J_CVhfxIYaicqtBoub6NvXwRHNmKHPnFTUt2cYb7I6M,9490
-datastock/_class1_uniformize.py,sha256=NtriKnQAMhzdEAc766rgYWouz4GFEG1MVAVhu9VcaOk,26918
-datastock/_class2.py,sha256=ag8bfEtAF1G_ET4ufpWh8uM609cVUUfhAO6L8L7hc14,45322
-datastock/_class2_interactivity.py,sha256=YdM4cEjDrgh-bSsOzkkwtu-pqKoeqhSyfiZl2Udkl3E,16632
+datastock/_class1_show.py,sha256=hqd-FeJ1NqiOzbrHzGMrwIo8_lLsjC199Zmw68NqkDQ,11745
+datastock/_class1_uniformize.py,sha256=dEJime_0SqmW8hX8ooZpHsPI_d8CIE9U9Yz9GhqsEUY,28433
+datastock/_class2.py,sha256=FG-ZGPVdZEdkRc_3Z9LRzYdRm9Xat7HI06E3-hI5rCk,45422
+datastock/_class2_interactivity.py,sha256=b7ORi0wR-gcFIua10PhbKTEB12vJN1F4skuIJX0gnbw,16918
 datastock/_class3.py,sha256=CH1oD_lTfVlcDp29L_iwzSfP78vX6_edDmZG9aSb1Ks,10848
 datastock/_direct_calls.py,sha256=EHFwI2mGMDqGz8_Bv2BseMBX4J8dSdE_RcNX3pt0ZYY,1801
 datastock/_export_dataframe.py,sha256=fy-uJR3EhDlHvd9ls1EQna_C8fyha1jCJLu1DTKTkdo,1576
@@ -22,21 +22,21 @@ datastock/_generic_utils.py,sha256=iBsEQcVEoyN11-R5lMCZJzZUAksROkVD_gzKNvWXLvA,2
 datastock/_generic_utils_plot.py,sha256=xrWzeZFtdTAs-RO2DfpCRveJPqw_p4lRFtQuuAn1pD8,3709
 datastock/_plot_BvsA_as_distribution.py,sha256=fpRhlbv3Bk96buANC46Brc9hdLxkOAsoKpE5A9pohG0,15389
 datastock/_plot_BvsA_as_distribution_check.py,sha256=2LoM3mGHtPu87_qf37hLcFuknWfeSydU8WDqpVo1Sco,13086
-datastock/_plot_as_array.py,sha256=DwumZrzfKmAUeUF_y6v33mVBH1mVDBAlIbZ-wHnvn5E,22707
+datastock/_plot_as_array.py,sha256=bnYui-3gli_AFnwYrbULCQVEq3i2TF7tUPWdqcJhDYQ,22708
 datastock/_plot_as_array_1d.py,sha256=6J-95zRTH2RPn_3g8GzDLX8HAGiLU39awNYi-EB2t7o,6611
-datastock/_plot_as_array_234d.py,sha256=k1AcKyseuObcte8yPm-FSn2g01rK-m_-japUA738IbA,21999
+datastock/_plot_as_array_234d.py,sha256=-j33lga5no4K3IBNN4Iy0ziBhassDtWVo4KZuezhyiQ,22000
 datastock/_plot_as_mobile_lines.py,sha256=QSmJZUMKrNa__SzUCJO96KpnQPoNB_qpjK_ZRJt11oY,23289
 datastock/_plot_as_profile1d.py,sha256=ebOrzcV1m197Ua1CE04EV6mno_LryrumCpwGcrrDZ5Y,23740
 datastock/_plot_correlations.py,sha256=ITOypu_AEoKl0ihxocV-JVTXIHqut6p9TfG-xZmQysc,10175
 datastock/_plot_old_backup.py,sha256=XixTi2CiihKjtQP0TRycH0b25caWN1m35DgpsDeiWZE,21729
 datastock/_plot_text.py,sha256=wQPqjfpLyIioS2JeOt3E9C9HgYUJ49YEoOgRuKYvAR8,3143
 datastock/_saveload.py,sha256=NdOykvmeCaPhpk0EF5WQezYzpuZM2Ul101Nqc4I3dnY,11729
-datastock/version.py,sha256=_bCAV5qSVuvH_tcB6Ai2e0766a-vOUJsDko63UrjeUg,80
+datastock/version.py,sha256=A38lpxv8KL6cnTASv1MoiCv6r7-tiQedYIq6p93AnrA,80
 datastock/tests/__init__.py,sha256=teOo2xP0IO7PQMuMDmum61XVHe2TuxW3BiHiL73X8jQ,35
 datastock/tests/test_01_DataStock.py,sha256=QJSmrVXD6wX-plfrFdLyZou20IYZGAKzartSi84BfC0,16982
 datastock/tests/output/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datastock-0.0.38.dist-info/LICENSE,sha256=V1uXqi3vxR0QhB4QdFyjkynl6jpN4wZmlB5EMYJk0NM,1068
-datastock-0.0.38.dist-info/METADATA,sha256=jpjDMUk_5ZEASgB8HU42yQ4Cjjp-GWDW7YG6Nl5P4pw,8666
-datastock-0.0.38.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-datastock-0.0.38.dist-info/top_level.txt,sha256=BzJsLLK_zZw13WQCoMhC74qWVKalnVCjBxdPXvJn7HQ,25
-datastock-0.0.38.dist-info/RECORD,,
+datastock-0.0.40.dist-info/LICENSE,sha256=V1uXqi3vxR0QhB4QdFyjkynl6jpN4wZmlB5EMYJk0NM,1068
+datastock-0.0.40.dist-info/METADATA,sha256=3RtX-DeKoRjaxewU2stlRCb8oF5zuMqiI1BArp0HyII,8660
+datastock-0.0.40.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+datastock-0.0.40.dist-info/top_level.txt,sha256=BzJsLLK_zZw13WQCoMhC74qWVKalnVCjBxdPXvJn7HQ,25
+datastock-0.0.40.dist-info/RECORD,,

{datastock-0.0.38.dist-info → datastock-0.0.40.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (74.1.2)
 Root-Is-Purelib: true
 Tag: py3-none-any