pymodaq_data 5.0.24__tar.gz → 5.0.26__tar.gz

{pymodaq_data-5.0.24 → pymodaq_data-5.0.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymodaq_data
-Version: 5.0.24
+Version: 5.0.26
 Summary: Modular Data Acquisition with Python
 Project-URL: Homepage, http://pymodaq.cnrs.fr
 Project-URL: Source, https://github.com/PyMoDAQ/pymodaq_data

{pymodaq_data-5.0.24 → pymodaq_data-5.0.26}/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '5.0.24'
-__version_tuple__ = version_tuple = (5, 0, 24)
+__version__ = version = '5.0.26'
+__version_tuple__ = version_tuple = (5, 0, 26)
+
+__commit_id__ = commit_id = None

{pymodaq_data-5.0.24 → pymodaq_data-5.0.26}/src/pymodaq_data/data.py

@@ -3210,7 +3210,7 @@ class DataToExport(DataLowLevel, SerializableBase):
 
         return dims
 
-    def get_data_from_source(self, source: DataSource, deepcopy=False) -> DataToExport:
+    def get_data_from_source(self, source: DataSource, deepcopy=False, sort_by_name=False) -> DataToExport:
         """Get the data matching the given DataSource
 
         Returns
@@ -3218,7 +3218,7 @@ class DataToExport(DataLowLevel, SerializableBase):
         DataToExport: filtered with data matching the dimensionality
         """
         source = enum_checker(DataSource, source)
-        return self.get_data_from_attribute('source', source, deepcopy=deepcopy)
+        return self.get_data_from_attribute('source', source, deepcopy=deepcopy, sort_by_name=sort_by_name)
 
     def get_data_from_missing_attribute(self, attribute: str, deepcopy=False) -> DataToExport:
         """ Get the data matching a given attribute value
@@ -3238,23 +3238,38 @@ class DataToExport(DataLowLevel, SerializableBase):
         else:
             return DataToExport(self.name, data=[dwa for dwa in self if not hasattr(dwa, attribute)])
 
-    def get_data_from_attribute(self, attribute: str, attribute_value: Any, deepcopy=False) -> DataToExport:
+    def get_data_from_attribute(self, attribute: str,
+                                attribute_value: Any,
+                                deepcopy=False,
+                                sort_by_name=False) -> DataToExport:
         """Get the data matching a given attribute value
 
+        Parameters
+        ----------
+        attribute: str
+            The name of the attribute to sort data with
+        attribute_value: Any
+            The value of the attribute
+        deepcopy: bool
+            If True, the returned data are deepcopied from the original
+        sort_by_name: bool
+            If True the returned data are sorted alphabetically using their name, default is False
+
         Returns
         -------
         DataToExport: filtered with data matching the attribute presence and value
         """
         selection = find_objects_in_list_from_attr_name_val(self.data, attribute, attribute_value,
                                                             return_first=False)
-        selection.sort(key=lambda elt: elt[0].name)
+        if sort_by_name:
+            selection.sort(key=lambda elt: elt[0].name)
         if deepcopy:
             data = [sel[0].deepcopy() for sel in selection]
         else:
             data = [sel[0] for sel in selection]
         return DataToExport(name=self.name, data=data)
 
-    def get_data_from_dim(self, dim: DataDim, deepcopy=False) -> DataToExport:
+    def get_data_from_dim(self, dim: DataDim, deepcopy=False, sort_by_name=False) -> DataToExport:
         """Get the data matching the given DataDim
 
         Returns
@@ -3262,9 +3277,9 @@ class DataToExport(DataLowLevel, SerializableBase):
         DataToExport: filtered with data matching the dimensionality
         """
         dim = enum_checker(DataDim, dim)
-        return self.get_data_from_attribute('dim', dim, deepcopy=deepcopy)
+        return self.get_data_from_attribute('dim', dim, deepcopy=deepcopy, sort_by_name=sort_by_name)
 
-    def get_data_from_dims(self, dims: List[DataDim], deepcopy=False) -> DataToExport:
+    def get_data_from_dims(self, dims: List[DataDim], deepcopy=False, sort_by_name=False) -> DataToExport:
         """Get the data matching the given DataDim
 
         Returns
@@ -3273,7 +3288,7 @@ class DataToExport(DataLowLevel, SerializableBase):
         """
         data = DataToExport(name=self.name)
         for dim in dims:
-            data.append(self.get_data_from_dim(dim, deepcopy=deepcopy))
+            data.append(self.get_data_from_dim(dim, deepcopy=deepcopy, sort_by_name=sort_by_name))
         return data
 
     def get_data_from_sig_axes(self, Naxes: int, deepcopy: bool = False) -> DataToExport:

{pymodaq_data-5.0.24 → pymodaq_data-5.0.26}/src/pymodaq_data/h5modules/exporter.py

@@ -18,24 +18,14 @@ from pymodaq_utils.logger import set_logger, get_module_name
 logger = set_logger(get_module_name(__file__))
 
 
-class H5Exporter(metaclass=ABCMeta):
-    """Base class for an exporter. """
 
-    # This is to define an abstract class attribute
-    @classmethod
-    @property
-    @abstractmethod
-    def FORMAT_DESCRIPTION(cls):
-        """str: file format description as a short text. eg: text file"""
-        raise NotImplementedError
 
-    @classmethod
-    @property
-    @abstractmethod
-    def FORMAT_EXTENSION(cls):
-        """str: File format extension. eg: txt"""
-        raise NotImplementedError
+class H5Exporter(metaclass=ABCMeta):
+    """Base class for an exporter. """
 
+    FORMAT_EXTENSION: str = NotImplemented
+    FORMAT_DESCRIPTION: str = NotImplemented
+    
     def __init__(self):
         """Abstract Exporter Constructor"""
         pass
@@ -63,6 +53,11 @@ class ExporterFactory:
         """
 
         def inner_wrapper(wrapped_class) -> Callable:
+            if wrapped_class.FORMAT_EXTENSION   is NotImplemented or \
+               wrapped_class.FORMAT_DESCRIPTION is NotImplemented:
+                raise NotImplementedError(f'{wrapped_class} does not properly provide a valid value for '
+                                          f'`FORMAT_EXTENSION` ({wrapped_class.FORMAT_EXTENSION}) or for '
+                                          f'`FORMAT_DESCRIPTION` ({wrapped_class.FORMAT_DESCRIPTION})')
             extension = wrapped_class.FORMAT_EXTENSION
             format_desc = wrapped_class.FORMAT_DESCRIPTION
 

{pymodaq_data-5.0.24 → pymodaq_data-5.0.26}/src/pymodaq_data/h5modules/saving.py

@@ -227,7 +227,7 @@ class H5SaverLowLevel(H5Backend):
         """
         if array_type is None:
             if array_to_save is None:
-                array_type = config('data_saving', 'data_type', 'dynamic')
+                array_type = config('data_saving', 'data_type', 'dynamics')[0]
             else:
                 array_type = array_to_save.dtype