pymodaq 4.4.6__py3-none-any.whl → 4.4.7__py3-none-any.whl

pymodaq/resources/VERSION

@@ -1,2 +1,2 @@
-version = '4.4.6'
+version = '4.4.7'
 

pymodaq/utils/data.py

@@ -98,6 +98,7 @@ class DataUnitError(Exception):
 
 
 class DwaType(BaseEnum):
+    """Different types of `DataWithAxes`."""
     DataWithAxes = 0
     DataRaw = 1
     DataActuator = 2

pymodaq/utils/managers/remote_manager.py

@@ -17,7 +17,7 @@ logger = set_logger(get_module_name(__file__))
 remote_path = pymodaq.utils.config.get_set_remote_path()
 remote_types = ['ShortCut', 'Joystick']
 
-actuator_actions = ['move_Rel', 'move_Rel_p', 'move_Rel_m']
+actuator_actions = ['move_rel', 'move_rel_p', 'move_rel_m']
 detector_actions = ['snap', 'grab', 'stop']
 remote_types = ['Keyboard', 'Joystick']
 try:

pymodaq/utils/tcp_ip/serializer.py

@@ -5,8 +5,9 @@ Created the 20/10/2023
 @author: Sebastien Weber
 """
 from base64 import b64encode, b64decode
+from enum import Enum
 import numbers
-from typing import Tuple, List, Union, TYPE_CHECKING, Iterable
+from typing import Optional, Tuple, List, Union, TYPE_CHECKING
 
 
 import numpy as np
@@ -20,17 +21,38 @@ if TYPE_CHECKING:
 
 
 SERIALIZABLE = Union[
-    int,
+    # native
+    bool,
+    bytes,
     str,
-    numbers.Number,
+    complex,  # float and int are subtypes for type hinting
+    float,
+    int,
     list,
+    # numpy
     np.ndarray,
+    # pymodaq
     Axis,
     DataWithAxes,
     DataToExport,
+    putils.ParameterWithPath,
 ]
 
 
+class SerializableTypes(Enum):
+    """Type names of serializable types"""
+    BOOL = "bool"
+    BYTES = "bytes"
+    STRING = "string"
+    SCALAR = "scalar"
+    LIST = "list"
+    ARRAY = "array"
+    AXIS = "axis"
+    DATA_WITH_AXES = "dwa"
+    DATA_TO_EXPORT = "dte"
+    PARAMETER = "parameter"
+
+
 class SocketString:
     """Mimic the Socket object but actually using a bytes string not a socket connection
 
@@ -86,7 +108,7 @@ class Serializer:
     """Used to Serialize to bytes python objects, numpy arrays and PyMoDAQ DataWithAxes and
     DataToExport objects"""
 
-    def __init__(self, obj: SERIALIZABLE = None):
+    def __init__(self, obj: Optional[SERIALIZABLE] = None) -> None:
         self._bytes_string = b''
         self._obj = obj
 
@@ -154,7 +176,7 @@ class Serializer:
         return message.encode()
 
     @classmethod
-    def str_len_to_bytes(cls, message: Union[str, bytes]) -> (bytes, bytes):
+    def str_len_to_bytes(cls, message: Union[str, bytes]) -> Tuple[bytes, bytes]:
         """ Convert a string and its length to two bytes
         Parameters
         ----------
@@ -174,7 +196,7 @@ class Serializer:
         return message, cls.int_to_bytes(len(message))
 
     def _int_serialization(self, int_obj: int) -> bytes:
-        """serialize an unsigned integer used for getting the length of messages internaly, for outside integer
+        """Serialize an unsigned integer used for getting the length of messages internally, for outside integer
         serialization or deserialization use scalar_serialization"""
         int_bytes = self.int_to_bytes(int_obj)
         bytes_string = int_bytes
@@ -205,18 +227,19 @@ class Serializer:
         self._bytes_string += bytes_string
         return bytes_string
 
-    def scalar_serialization(self, scalar: numbers.Number) -> bytes:
+    def scalar_serialization(self, scalar: complex) -> bytes:
         """ Convert a scalar into a bytes message together with the info to convert it back
 
         Parameters
         ----------
-        scalar: str
+        scalar: A python number (complex or subtypes like float and int)
 
         Returns
         -------
         bytes: the total bytes message to serialize the scalar
         """
         if not isinstance(scalar, numbers.Number):
+            # type hint is complex, instance comparison Number
             raise TypeError(f'{scalar} should be an integer or a float, not a {type(scalar)}')
         scalar_array = np.array([scalar])
         data_type = scalar_array.dtype.descr[0][1]
@@ -350,49 +373,56 @@ class Serializer:
         self._bytes_string += bytes_string
         return bytes_string
 
-    def type_and_object_serialization(self, obj):
+    def type_and_object_serialization(self, obj: Optional[SERIALIZABLE] = None) -> bytes:
+        """Serialize an object with its type, such that it can be retrieved by
+        `DeSerializer.type_and_object_deserialization`.
+        """
+
+        if obj is None and self._obj is not None:
+            obj = self._obj
+
         bytes_string = b''
         if isinstance(obj, DataWithAxes):
-            bytes_string += self.string_serialization('dwa')
+            bytes_string += self.string_serialization(SerializableTypes.DATA_WITH_AXES.value)
             bytes_string += self.dwa_serialization(obj)
 
         elif isinstance(obj, Axis):
-            bytes_string += self.string_serialization('axis')
+            bytes_string += self.string_serialization(SerializableTypes.AXIS.value)
             bytes_string += self.axis_serialization(obj)
 
         elif isinstance(obj, np.ndarray):
-            bytes_string += self.string_serialization('array')
+            bytes_string += self.string_serialization(SerializableTypes.ARRAY.value)
             bytes_string += self.ndarray_serialization(obj)
 
         elif isinstance(obj, bytes):
-            bytes_string += self.string_serialization('bytes')
+            bytes_string += self.string_serialization(SerializableTypes.BYTES.value)
             bytes_string += self.bytes_serialization(obj)
 
         elif isinstance(obj, str):
-            bytes_string += self.string_serialization('string')
+            bytes_string += self.string_serialization(SerializableTypes.STRING.value)
             bytes_string += self.string_serialization(obj)
 
-        elif isinstance(obj, numbers.Number):
-            bytes_string += self.string_serialization('scalar')
+        elif isinstance(obj, bool):
+            bytes_string += self.string_serialization(SerializableTypes.BOOL.value)
             bytes_string += self.scalar_serialization(obj)
 
-        elif isinstance(obj, bool):
-            bytes_string += self.string_serialization('bool')
-            bytes_string += self.scalar_serialization(int(obj))
+        elif isinstance(obj, numbers.Number):
+            bytes_string += self.string_serialization(SerializableTypes.SCALAR.value)
+            bytes_string += self.scalar_serialization(obj)
 
         elif isinstance(obj, list):
-            bytes_string += self.string_serialization('list')
+            bytes_string += self.string_serialization(SerializableTypes.LIST.value)
             bytes_string += self.list_serialization(obj)
 
         elif isinstance(obj, putils.ParameterWithPath):
             path = obj.path
             param_as_xml = ioxml.parameter_to_xml_string(obj.parameter)
-            bytes_string += self.string_serialization('parameter')
+            bytes_string += self.string_serialization(SerializableTypes.PARAMETER.value)
             bytes_string += self.list_serialization(path)
-            bytes_string += self.string_serialization(param_as_xml)
+            bytes_string += self.bytes_serialization(param_as_xml)
 
         elif isinstance(obj, DataToExport):
-            bytes_string += self.string_serialization('dte')
+            bytes_string += self.string_serialization(SerializableTypes.DATA_TO_EXPORT.value)
             bytes_string += self.dte_serialization(obj)
 
         else:
@@ -509,7 +539,7 @@ class DeSerializer:
     :py:class:`~pymodaq.utils.tcp_ip.mysocket.Socket`
     """
 
-    def __init__(self, bytes_string:  Union[bytes, 'Socket'] = None):
+    def __init__(self, bytes_string:  Union[bytes, 'Socket'] = None) -> None:
         if isinstance(bytes_string, bytes):
             bytes_string = SocketString(bytes_string)
         self._bytes_string = bytes_string
@@ -531,7 +561,7 @@ class DeSerializer:
         return int.from_bytes(bytes_string, 'big')
 
     @staticmethod
-    def bytes_to_scalar(data: bytes, dtype: np.dtype) -> numbers.Number:
+    def bytes_to_scalar(data: bytes, dtype: np.dtype) -> complex:
         """Convert bytes to a scalar given a certain numpy dtype
 
         Parameters
@@ -588,8 +618,8 @@ class DeSerializer:
         str_obj = self._bytes_string.get_first_nbytes(string_len).decode()
         return str_obj
 
-    def scalar_deserialization(self) -> numbers.Number:
-        """Convert bytes into a numbers.Number object
+    def scalar_deserialization(self) -> complex:
+        """Convert bytes into a python number object
 
         Get first the data type from a string deserialization, then the data length and finally convert this
         length of bytes into a number (float, int)
@@ -602,9 +632,11 @@ class DeSerializer:
         data_len = self._int_deserialization()
         number = np.frombuffer(self._bytes_string.get_first_nbytes(data_len), dtype=data_type)[0]
         if 'f' in data_type:
-            number = float(number)  # because one get numpy  float type
+            number = float(number)  # because one get numpy float type
         elif 'i' in data_type:
             number = int(number)  # because one get numpy int type
+        elif 'c' in data_type:
+            number = complex(number)  # because one get numpy complex type
         return number
 
     def boolean_deserialization(self) -> bool:
@@ -642,7 +674,7 @@ class DeSerializer:
         ndarray = np.atleast_1d(ndarray)  # remove singleton dimensions
         return ndarray
 
-    def type_and_object_deserialization(self):
+    def type_and_object_deserialization(self) -> SERIALIZABLE:
         """ Deserialize specific objects from their binary representation (inverse of `Serializer.type_and_object_serialization`).
 
         See Also
@@ -652,28 +684,29 @@ class DeSerializer:
         """
         obj_type = self.string_deserialization()
         elt = None
-        if obj_type == 'scalar':
+        if obj_type == SerializableTypes.SCALAR.value:
             elt = self.scalar_deserialization()
-        elif obj_type == 'string':
+        elif obj_type == SerializableTypes.STRING.value:
             elt = self.string_deserialization()
-        elif obj_type == 'bytes':
+        elif obj_type == SerializableTypes.BYTES.value:
             elt = self.bytes_deserialization()
-        elif obj_type == 'array':
+        elif obj_type == SerializableTypes.ARRAY.value:
             elt = self.ndarray_deserialization()
-        elif obj_type == 'dwa':
+        elif obj_type == SerializableTypes.DATA_WITH_AXES.value:
             elt = self.dwa_deserialization()
-        elif obj_type == 'dte':
+        elif obj_type == SerializableTypes.DATA_TO_EXPORT.value:
             elt = self.dte_deserialization()
-        elif obj_type == 'axis':
+        elif obj_type == SerializableTypes.AXIS.value:
             elt = self.axis_deserialization()
-        elif obj_type == 'bool':
+        elif obj_type == SerializableTypes.BOOL.value:
             elt = self.boolean_deserialization()
-        elif obj_type == 'list':
+        elif obj_type == SerializableTypes.LIST.value:
             elt = self.list_deserialization()
-        elif obj_type == 'parameter':
+        elif obj_type == SerializableTypes.PARAMETER.value:
             elt = self.parameter_deserialization()
         else:
             print(f'invalid object type {obj_type}')
+            elt = None  # desired behavior?
         return elt
 
     def list_deserialization(self) -> list:
@@ -774,4 +807,4 @@ class DeSerializer:
                            data=self.list_deserialization(),
                            )
         dte.timestamp = timestamp
-        return dte
+        return dte

{pymodaq-4.4.6.dist-info → pymodaq-4.4.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pymodaq
-Version: 4.4.6
+Version: 4.4.7
 Summary: Modular Data Acquisition with Python
 Project-URL: Homepage, http://pymodaq.cnrs.fr
 Project-URL: Source, https://github.com/PyMoDAQ/PyMoDAQ
@@ -27,7 +27,6 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
         THE SOFTWARE.
-License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Other Environment
 Classifier: Intended Audience :: Science/Research
@@ -44,7 +43,7 @@ Classifier: Topic :: Scientific/Engineering :: Visualization
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: User Interfaces
 Requires-Python: >=3.7
-Requires-Dist: bayesian-optimization
+Requires-Dist: bayesian-optimization<2.0.0
 Requires-Dist: easydict
 Requires-Dist: importlib-metadata; python_version < '3.8'
 Requires-Dist: multipledispatch

{pymodaq-4.4.6.dist-info → pymodaq-4.4.7.dist-info}/RECORD

@@ -59,7 +59,7 @@ pymodaq/post_treatment/daq_measurement/daq_measurement_GUI.py,sha256=1u7hWDaiwsZ
 pymodaq/post_treatment/daq_measurement/daq_measurement_GUI.ui,sha256=PyzbCWPMkh5oIYYteZczXyWMeHKW9EJmM1QlzXhnyTk,7037
 pymodaq/post_treatment/daq_measurement/daq_measurement_main.py,sha256=CAKwcWMOD86aXB8mbdxOK7e8nZRos5d59FzDtqK1QoY,17093
 pymodaq/post_treatment/daq_measurement/process_from_QtDesigner_DAQ_Measurement_GUI.bat,sha256=e1tu2A67MS9fk3jhriF6saQgRxWIucIvNW92iWXFP6E,164
-pymodaq/resources/VERSION,sha256=WLq0vLL18vLMV1jwQsziDmyw7JVoEVuWAB0pDGzYEvM,19
+pymodaq/resources/VERSION,sha256=ib4rQ9G3YTfdijgNEWBcOoAIZQyUy-mfF0jvGog9fno,19
 pymodaq/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pymodaq/resources/config_template.toml,sha256=d3pofgIK5FxaRMELAI1qEsRcMD3GlYd87zZjDj9G9m0,3210
 pymodaq/resources/preset_default.xml,sha256=Dt8iWLwPPOPtcG00JCVP-mh-G7KC6B0YN8hd8RQdnNI,27256
@@ -312,7 +312,7 @@ pymodaq/utils/chrono_timer.py,sha256=rwX8apS8B-IKhA0Cp2H9tLz0BRN7G3Pg5ptozvd3MKM
 pymodaq/utils/config.py,sha256=0QqoBJC4ECuIeh1UsvUQqhxkKl7Vfgi4iERp-6qNWAc,16202
 pymodaq/utils/conftests.py,sha256=3Ak8WEpa3EhAp73Yb1LLq8YFONhPqiL7gG9eSDIoTNc,58
 pymodaq/utils/daq_utils.py,sha256=0jTrbT0aaZr3KaTgeDicmK9FbVnu3iaWBmNHnNJpr3A,28050
-pymodaq/utils/data.py,sha256=rasOk1-2o8fJHE_zm7ygrWXL7cBOHJOgwWMZhbVG7z0,111863
+pymodaq/utils/data.py,sha256=RdzEDz3ziRmwbaqy875fLr06jrmaG1wzU-0e_5QQKXM,111908
 pymodaq/utils/enums.py,sha256=wpRipioUJkKcEfoaY2NrDQ2WhGxZTZiZoJty5f2Ljpc,2236
 pymodaq/utils/exceptions.py,sha256=wLO6VlofzfwWkOOWMN2B-3NEWMfpgygyeEdakIx_rAs,668
 pymodaq/utils/factory.py,sha256=QLqAPFnTZ93eUpmAAIr7kESDk2enD57RNSuFUsjxE4E,2311
@@ -374,7 +374,7 @@ pymodaq/utils/managers/overshoot_manager.py,sha256=fe_CR1Bkw85BER34MoVFlm-xtKl9H
 pymodaq/utils/managers/parameter_manager.py,sha256=hO3RXcpkYOtuqjAQaD5H3r71rVEHntYg64VHZwVCQBg,11473
 pymodaq/utils/managers/preset_manager.py,sha256=m8r_TcfFbUatddBX9SJj7XI_GZ3FhoiwzhFgocw9jZ8,9481
 pymodaq/utils/managers/preset_manager_utils.py,sha256=d148YBjeNOP9FTkFoTsfdRDxMIXOR8JJHqbOmoL2aVA,8155
-pymodaq/utils/managers/remote_manager.py,sha256=H6k9aiBkuJRJbZ4rpd5jfawQ-pMRFAXOE_miakvciP8,22251
+pymodaq/utils/managers/remote_manager.py,sha256=SwzefJuGpgzvvjTbJSo3T3Rc2rncvHHyPYPBd8gCQX8,22251
 pymodaq/utils/managers/roi_manager.py,sha256=RRICNSLMxiUoq8tEBKihpdydIVAu78ogkYOFWWphaHE,29892
 pymodaq/utils/parameter/__init__.py,sha256=fMljZeQ9EVvh2bmss550C5BpxFeKOxT8_AVJdPxQ0kQ,433
 pymodaq/utils/parameter/ioxml.py,sha256=jduHhMrpc0lkSJlznnI-LRHUJ0Ofc4PoFfNlxLbLmw8,17091
@@ -437,10 +437,10 @@ pymodaq/utils/svg/svg_view.py,sha256=bmXpDqnw9S-Bp3F8Hi_oeYB5Y9gebiCNsQWVJzCq-PA
 pymodaq/utils/svg/svg_viewer2D.py,sha256=LTJ3Ulb5zWXdRPr7vqcWumbpq7ZctzrYUMtD5QV3x60,1523
 pymodaq/utils/tcp_ip/__init__.py,sha256=1e_EK0AgvdoLAD_CSGGEaITZdy6OWCO7ih9IAIp7HT4,81
 pymodaq/utils/tcp_ip/mysocket.py,sha256=StAWj8dzHeMnbLj68Sel81uWFy-YkKVNRnVf7gXrESI,3452
-pymodaq/utils/tcp_ip/serializer.py,sha256=htVQCE4saRBMeIcseEyxTt5G58A341m6OGkaJUA34Wk,27766
+pymodaq/utils/tcp_ip/serializer.py,sha256=kXmvFLR5ZedjY2rVGUs83lsJk9Z9l_iAWR6srDxzaYQ,29262
 pymodaq/utils/tcp_ip/tcp_server_client.py,sha256=xIMTNgVW_rKK0yTi4FDNFLf85-Akb27Jz2LdrvOrP68,30660
-pymodaq-4.4.6.dist-info/METADATA,sha256=mJV-zKqrF_yCIPzo_-brHM2vJqBIdptzQPzVJ8qmIbM,7627
-pymodaq-4.4.6.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-pymodaq-4.4.6.dist-info/entry_points.txt,sha256=RAzdYNjvUT28I2eiCKki_g2NzXq0woWxhev6lwzwRv8,348
-pymodaq-4.4.6.dist-info/licenses/LICENSE,sha256=VKOejxexXAe3XwfhAhcFGqeXQ12irxVHdeAojZwFEI8,1108
-pymodaq-4.4.6.dist-info/RECORD,,
+pymodaq-4.4.7.dist-info/METADATA,sha256=jkmtri16XiPHC-2It45CeeZp--C6giXVJ0FLp3g13u8,7611
+pymodaq-4.4.7.dist-info/WHEEL,sha256=3U_NnUcV_1B1kPkYaPzN-irRckL5VW_lytn0ytO_kRY,87
+pymodaq-4.4.7.dist-info/entry_points.txt,sha256=RAzdYNjvUT28I2eiCKki_g2NzXq0woWxhev6lwzwRv8,348
+pymodaq-4.4.7.dist-info/licenses/LICENSE,sha256=VKOejxexXAe3XwfhAhcFGqeXQ12irxVHdeAojZwFEI8,1108
+pymodaq-4.4.7.dist-info/RECORD,,

{pymodaq-4.4.6.dist-info → pymodaq-4.4.7.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.26.1
 Root-Is-Purelib: true
 Tag: py3-none-any