datastock 0.0.46__py3-none-any.whl → 0.0.47__py3-none-any.whl

datastock/_class2_interactivity.py

@@ -459,12 +459,18 @@ def _get_ix_for_refx_only_1or2d(
 
 
 def get_fupdate(handle=None, dtype=None, norm=None, bstr=None):
+
+    # Note: set_xdata() and set_ydata() do not accept scalar values
+    #       Deprecation warning since matplotlib 3.7
+    # see https://github.com/matplotlib/matplotlib/pull/22329
+    # see https://github.com/matplotlib/matplotlib/issues/28927
+
     if dtype == 'xdata':
         def func(val, handle=handle):
-            handle.set_xdata(val)
+            handle.set_xdata(np.atleast_1d(val))
     elif dtype == 'ydata':
         def func(val, handle=handle):
-            handle.set_ydata(val)
+            handle.set_ydata(np.atleast_1d(val))
     elif dtype in ['data']:   # Also works for imshow
         def func(val, handle=handle):
             handle.set_data(val)
@@ -588,4 +594,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/_generic_check.py

@@ -550,6 +550,126 @@ def _obj_key(d0=None, short=None, key=None, ndigits=None):
     )
 
 
+# #############################################################################
+# #############################################################################
+#                   Utilities for plotting
+# #############################################################################
+
+
+def _check_all_broadcastable(
+    return_full_arrays=None,
+    **kwdargs,
+):
+
+    # -------------------
+    # return_full_arrays
+    # -------------------
+
+    return_full_arrays = _check_var(
+        return_full_arrays, 'return_full_arrays',
+        types=bool,
+        default=False,
+    )
+
+    # -------------------
+    # Preliminary check
+    # -------------------
+
+    dout = {}
+    dfail = {}
+    for k0, v0 in kwdargs.items():
+        try:
+            dout[k0] = np.atleast_1d(v0)
+        except Exception:
+            dfail[k0] = f"Not convertible to np.ndarray! - {v0}"
+
+    # Raise Exception
+    if len(dfail) > 0:
+        lstr = [f"\t- {k0}: {v0}" for k0, v0 in dfail.items()]
+        msg = (
+            "The following kwdargs are non-conform:\n"
+            + "\n".join(lstr)
+        )
+        raise Exception(msg)
+
+    # -------------------
+    # check ndim
+    # -------------------
+
+    dndim = {k0: v0.ndim for k0, v0 in dout.items() if v0.shape != (1,)}
+    lndim = list(set(dndim.values()))
+
+    if len(lndim) == 0:
+        # all scalar
+        if return_full_arrays:
+            return dout, (1,)
+        else:
+            return {k0: v0[0] for k0, v0 in dout.items()}, None
+
+    elif len(lndim) == 1:
+        ndim = lndim[0]
+
+    else:
+        lstr = [f"-t {k0}: {v0}" for k0, v0 in dndim.items()]
+        msg = (
+            "Some keyword args have non-compatible dimensions:\n"
+            + "\n".join(lstr)
+        )
+        raise Exception(msg)
+
+    # -------------------
+    # check shapes
+    # -------------------
+
+    dfail = {}
+    shapef = np.ones((ndim,), dtype=int)
+    for k0, v0 in dout.items():
+
+        if v0.shape == (1,):
+            continue
+
+        for ii in range(ndim):
+            if v0.shape[ii] == 1:
+                pass
+            elif shapef[ii] == 1:
+                shapef[ii] = v0.shape[ii]
+            elif v0.shape[ii] == shapef[ii]:
+                pass
+            else:
+                dfail[k0] = f"Non-compatible shape = {v0.shape} (ii = {ii})"
+                continue
+
+    shapef = tuple(shapef)
+
+    # raise Exception if needed
+    if len(dfail) > 0:
+        lstr = [f"\t- {k0}: {v0}" for k0, v0 in dfail.items()]
+        msg = (
+            "The following keywords args have non-compatible shape:\n"
+            + "\n".join(lstr)
+            + f"\nReference shape: {shapef}\n"
+        )
+        raise Exception(msg)
+
+    # -------------------
+    # reshape output
+    # -------------------
+
+    if return_full_arrays is True:
+        for k0, v0 in dout.items():
+            if v0.shape == (1,):
+                dout[k0] = np.full(shapef, v0[0])
+            elif v0.shape != shapef:
+                dout[k0] = np.broadcast_to(v0, shapef)
+
+    else:
+        for k0, v0 in dout.items():
+            if v0.shape == (1,):
+                dout[k0] = v0[0]
+
+    return dout, shapef
+
+
 # #############################################################################
 # #############################################################################
 #                   Utilities for plotting
@@ -929,4 +1049,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/tests/test_01_DataStock.py

@@ -14,6 +14,7 @@ import numpy as np
 import matplotlib.pyplot as plt
 
 # datastock-specific
+from .._generic_check import _check_all_broadcastable
 from .._class import DataStock
 from .._saveload import load
 
@@ -228,6 +229,46 @@ class Test01_Instanciate():
     def test03_add_obj(self):
         _add_obj(st=self.st, nc=self.nc)
 
+    # ------------------------
+    #   Tools
+    # ------------------------
+
+    def test04_check_all_broadcastable(self):
+        # all scalar
+        dout, shape = _check_all_broadcastable(a=1, b=2)
+
+        # scalar + arrays
+        dout, shape = _check_all_broadcastable(a=1, b=(1, 2, 3))
+
+        # all arrays
+        dout, shape = _check_all_broadcastable(
+            a=(1, 2, 3),
+            b=(1, 2, 3),
+        )
+
+        # all arrays - 2d
+        dout, shape = _check_all_broadcastable(
+            a=np.r_[1, 2, 3][:, None],
+            b=np.r_[10, 20][None, :],
+        )
+
+        # check flag
+        err = False
+        try:
+            dout, shape = _check_all_broadcastable(a=(1, 2), b=(1, 2, 3))
+        except Exception:
+            err = True
+        assert err is True
+
+        # all arrays - mix
+        dout, shape = _check_all_broadcastable(
+            a=np.r_[1, 2, 3][:, None],
+            b=np.r_[10, 20][None, :],
+            c=3,
+            return_full_arrays=True,
+        )
+        assert all([v0.shape == (3, 2) for v0 in dout.values()])
+
 
 #######################################################
 #
@@ -639,4 +680,4 @@ class Test02_Manipulate():
         msg = st2.__eq__(self.st, returnas=str)
         if msg is not True:
             raise Exception(msg)
-        os.remove(pfe)
+        os.remove(pfe)

datastock/version.py

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

{datastock-0.0.46.dist-info → datastock-0.0.47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datastock
-Version: 0.0.46
+Version: 0.0.47
 Summary: A python library for generic class and data handling
 Home-page: https://github.com/ToFuProject/datastock
 Author: Didier VEZINET

{datastock-0.0.46.dist-info → datastock-0.0.47.dist-info}/RECORD

@@ -13,12 +13,12 @@ datastock/_class1_interpolate.py,sha256=3VKGMDsiWFQUguMHxMaTQTyMhcN8Ikg1PmaH6TjI
 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/_class2_interactivity.py,sha256=glAqqkIyH8JBVj0AsgJPNlaltcTIXB0iCqNBq3gKSb8,17198
 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
 datastock/_find_plateau.py,sha256=sqnAuy0361DXkqBb_Lo1MmIGjn35tnKFvcv6MW6hifs,2685
-datastock/_generic_check.py,sha256=x41ITg3NxOiMK4IyIQX9wYrrqwPy88991rlvCpkFy8w,24812
+datastock/_generic_check.py,sha256=yKnxlLSJomRCYzBayEy-i0O6FhOGt1rR98iu2XSd37U,27940
 datastock/_generic_utils.py,sha256=_iV51SiujEmQfAlvyIEW4BvzIXdhPCD-vumV5DmUL44,23421
 datastock/_generic_utils_plot.py,sha256=xrWzeZFtdTAs-RO2DfpCRveJPqw_p4lRFtQuuAn1pD8,3709
 datastock/_plot_BvsA_as_distribution.py,sha256=fpRhlbv3Bk96buANC46Brc9hdLxkOAsoKpE5A9pohG0,15389
@@ -32,12 +32,12 @@ datastock/_plot_correlations.py,sha256=ITOypu_AEoKl0ihxocV-JVTXIHqut6p9TfG-xZmQy
 datastock/_plot_old_backup.py,sha256=XixTi2CiihKjtQP0TRycH0b25caWN1m35DgpsDeiWZE,21729
 datastock/_plot_text.py,sha256=wQPqjfpLyIioS2JeOt3E9C9HgYUJ49YEoOgRuKYvAR8,3143
 datastock/_saveload.py,sha256=1vAMp27KfqXbo5b_Pi8hJux0stsHq6dO5vy8k1d4_iA,14141
-datastock/version.py,sha256=TTZXyi6fkfPDWOJIxiEa00X66SrcWUHC11j32Bjcyh0,80
+datastock/version.py,sha256=mPvpgVj454Vfs5m6V8fuocNdwJDUMd-Yv6J6PlDaGVA,80
 datastock/tests/__init__.py,sha256=teOo2xP0IO7PQMuMDmum61XVHe2TuxW3BiHiL73X8jQ,35
-datastock/tests/test_01_DataStock.py,sha256=Ngz0nbb7Qj3Sr0c4TV2OlK_v4R6aMBrQYXr8BWaYAnw,18048
+datastock/tests/test_01_DataStock.py,sha256=aUseXH2zYnFtNDJSCuEROgPxfKKNeLCkCQSR--_Fheg,19176
 datastock/tests/output/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datastock-0.0.46.dist-info/LICENSE,sha256=V1uXqi3vxR0QhB4QdFyjkynl6jpN4wZmlB5EMYJk0NM,1068
-datastock-0.0.46.dist-info/METADATA,sha256=rs7ozSmlV2xJ4_yOJIwDrDj3brqxOHxqZRlG7W2hLqA,8660
-datastock-0.0.46.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-datastock-0.0.46.dist-info/top_level.txt,sha256=BzJsLLK_zZw13WQCoMhC74qWVKalnVCjBxdPXvJn7HQ,25
-datastock-0.0.46.dist-info/RECORD,,
+datastock-0.0.47.dist-info/LICENSE,sha256=V1uXqi3vxR0QhB4QdFyjkynl6jpN4wZmlB5EMYJk0NM,1068
+datastock-0.0.47.dist-info/METADATA,sha256=pCzvjokhOrHGFpDFABU6QbnPT7MvBZ1NQW_Mbd1vxnQ,8660
+datastock-0.0.47.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+datastock-0.0.47.dist-info/top_level.txt,sha256=BzJsLLK_zZw13WQCoMhC74qWVKalnVCjBxdPXvJn7HQ,25
+datastock-0.0.47.dist-info/RECORD,,

{datastock-0.0.46.dist-info → datastock-0.0.47.dist-info}/WHEEL

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