ewoksdata 2.0.1__tar.gz → 2.0.3__tar.gz

{ewoksdata-2.0.1/src/ewoksdata.egg-info → ewoksdata-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ewoksdata
-Version: 2.0.1
+Version: 2.0.3
 Summary: Ewoks tasks for data access
 Author-email: ESRF <dau-pydev@esrf.fr>
 License: # MIT License

{ewoksdata-2.0.1 → ewoksdata-2.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ewoksdata"
-version = "2.0.1"
+version = "2.0.3"
 authors = [{ name = "ESRF", email = "dau-pydev@esrf.fr" }]
 description = "Ewoks tasks for data access"
 readme = { file = "README.md", content-type = "text/markdown" }

{ewoksdata-2.0.1 → ewoksdata-2.0.3}/src/ewoksdata/data/bliss.py

@@ -3,7 +3,9 @@ or from memory (Redis or device servers).
 """
 
 import logging
+import os
 import sys
+import time
 from numbers import Integral
 from numbers import Number
 from typing import Any
@@ -39,21 +41,49 @@ logger = logging.getLogger(__name__)
 
 def get_data(
     data: Union[str, DataUrl, ArrayLike, Number],
+    retry_timeout: Optional[float] = None,
+    retry_period: Optional[float] = None,
     **hdf5_options: Any,
 ) -> Union[numpy.ndarray, Number, Sequence]:
     """
-    Return a NumPy array or a scalar from *data*.
-
-    :param data: Either a data-URL, an array-like object or a scalar number.
-    :param **hdf5_options: Additional options forwarded to :class:`silx.io.h5py_utils.File`.
-    :return: The requested data.
+    Retrieve numerical data from a data source and return it as a NumPy array or scalar.
+
+    This function accepts various data representations, including data URLs,
+    array-like objects, and scalar numbers. The data source may not be
+    immediately available so a retry mechanism is used.
+
+    :param data: The input data source. May be:
+        - A string or :class:`DataUrl` referencing a dataset (e.g., HDF5),
+        - An array-like object convertible to a NumPy array,
+        - A scalar numerical value.
+    :param retry_timeout: Maximum time in seconds to wait for the data to become
+        available. If ``None`` (default), no timeout is applied.
+    :param retry_period: Interval in seconds between availability checks when
+        retrying. If ``None`` (default), a period of 0.1 seconds is used.
+    :param hdf5_options: Additional keyword arguments forwarded to
+        :class:`silx.io.h5py_utils.File` when opening HDF5 resources.
+
+    :returns: The resolved data. Array-like inputs are returned as NumPy arrays,
+        while scalar inputs are returned as numbers.
+
+    :raises TimeoutError: If the data does not become available within ``retry_timeout``.
+    :raises ValueError: If the input type is unsupported or the data cannot be resolved.
     """
     if isinstance(data, (str, DataUrl)):
         data_url = url.as_dataurl(data)
         filename, h5path, idx = url.h5dataset_url_parse(data_url)
 
-        if h5py.is_hdf5(filename):
-            return _get_hdf5_data(filename, h5path, idx=idx, **hdf5_options)
+        _wait_for_file(filename, retry_timeout=retry_timeout, retry_period=retry_period)
+
+        if _is_hdf5_filename(filename):
+            return _get_hdf5_data(
+                filename,
+                h5path,
+                idx=idx,
+                retry_timeout=retry_timeout,
+                retry_period=retry_period,
+                **hdf5_options,
+            )
 
         if not data_url.scheme():
             for scheme in ("fabio", "silx"):
@@ -73,16 +103,41 @@ def get_data(
     raise TypeError(f"Unsupported data type: {type(data)!r}")
 
 
+def _wait_for_file(
+    filename: str,
+    retry_timeout: Optional[float] = None,
+    retry_period: Optional[float] = None,
+    **_,
+) -> None:
+    if retry_period is None:
+        retry_period = 0.1
+    t0 = time.time()
+    while True:
+        if os.path.exists(filename):
+            return
+        if retry_timeout is not None:
+            if (time.time() - t0) > retry_timeout:
+                raise TimeoutError(
+                    f"File {filename} is not created within {retry_timeout} sec"
+                )
+        time.sleep(retry_period)
+
+
+def _is_hdf5_filename(filename: str) -> bool:
+    _, ext = os.path.splitext(filename)
+    return ext in (".h5", ".hdf5", ".nx", ".nxs", ".nexus")
+
+
 def get_image(
     data: Union[str, DataUrl, ArrayLike, Number], **hdf5_options: Any
 ) -> numpy.ndarray:
     """
     Return a NumPy array or a scalar from *data*.
 
+    Retry options, such as `retry_timeout` and `retry_period` are forwarded to the internal HDF5 data reader.
+
     :param data: Either a data-URL, an array-like object or a scalar number.
-    :param retry_timeout: Timeout for the retry mechanism.
-    :param retry_period: Interval between retries.
-    :param **hdf5_options: Additional options forwarded to :class:`silx.io.h5py_utils.File`.
+    :param hdf5_options: Additional options forwarded to :class:`silx.io.h5py_utils.File`.
     :return: A 2-D image.
     """
     data = get_data(data, **hdf5_options)

{ewoksdata-2.0.1 → ewoksdata-2.0.3}/src/ewoksdata/tests/test_data_bliss.py

@@ -28,8 +28,12 @@ def test_get_data_hdf5(tmpdir):
     numpy.testing.assert_array_equal(img1, img3)
 
     filename_non_existing = str(tmpdir / "data_non_existing.h5")
-    with pytest.raises(IOError):
-        _ = bliss.get_data(f"{filename_non_existing}?path=/img")
+    with pytest.raises(TimeoutError):
+        _ = bliss.get_data(f"{filename_non_existing}?path=/img", retry_timeout=0)
+
+    filename_non_existing = str(tmpdir / "data_non_existing.edf")
+    with pytest.raises(TimeoutError):
+        _ = bliss.get_data(filename_non_existing, retry_timeout=0)
 
 
 @pytest.mark.parametrize("lima_names", [(), ("p3",), ("p3", "p4")])

{ewoksdata-2.0.1 → ewoksdata-2.0.3/src/ewoksdata.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ewoksdata
-Version: 2.0.1
+Version: 2.0.3
 Summary: Ewoks tasks for data access
 Author-email: ESRF <dau-pydev@esrf.fr>
 License: # MIT License