Merge remote-tracking branch 'origin/main' into users/mprosser/add-more-samples

Author: Mike Prosser

src/nipanel/_convert.py

@@ -21,6 +21,7 @@
     IntCollectionConverter,
     StrCollectionConverter,
 )
+from nipanel.converters.protobuf_types import DoubleAnalogWaveformConverter, ScalarConverter
 
 _logger = logging.getLogger(__name__)
 
@@ -38,6 +39,9 @@
     FloatCollectionConverter(),
     IntCollectionConverter(),
     StrCollectionConverter(),
+    # Protobuf Types
+    DoubleAnalogWaveformConverter(),
+    ScalarConverter(),
 ]
 
 _CONVERTIBLE_COLLECTION_TYPES = {
@@ -54,6 +58,12 @@
 
 def to_any(python_value: object) -> any_pb2.Any:
     """Convert a Python object to a protobuf Any."""
+    best_matching_type = _get_best_matching_type(python_value)
+    converter = _CONVERTER_FOR_PYTHON_TYPE[best_matching_type]
+    return converter.to_protobuf_any(python_value)
+
+
+def _get_best_matching_type(python_value: object) -> str:
     underlying_parents = type(python_value).mro()  # This covers enum.IntEnum and similar
 
     container_type = None
@@ -86,9 +96,7 @@ def to_any(python_value: object) -> any_pb2.Any:
             f"Unsupported type: ({container_type}, {payload_type}) with parents {underlying_parents}. Supported types are: {_SUPPORTED_PYTHON_TYPES}"
         )
     _logger.debug(f"Best matching type for '{repr(python_value)}' resolved to {best_matching_type}")
-
-    converter = _CONVERTER_FOR_PYTHON_TYPE[best_matching_type]
-    return converter.to_protobuf_any(python_value)
+    return best_matching_type
 
 
 def from_any(protobuf_any: any_pb2.Any) -> object:

tests/unit/test_convert.py

@@ -1,8 +1,16 @@
-from typing import Any, Type, Union
+from typing import Any, Union
 
+import numpy as np
 import pytest
 from google.protobuf import any_pb2, wrappers_pb2
+from google.protobuf.message import Message
+from ni.protobuf.types.scalar_pb2 import ScalarData
 from ni.pythonpanel.v1 import python_panel_types_pb2
+from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types.waveform_pb2 import (
+    DoubleAnalogWaveform,
+)
+from nitypes.scalar import Scalar
+from nitypes.waveform import AnalogWaveform
 from typing_extensions import TypeAlias
 
 import nipanel._convert
@@ -26,7 +34,52 @@
 
 
 # ========================================================
-# Python to Protobuf
+# _get_best_matching_type() tests
+# ========================================================
+@pytest.mark.parametrize(
+    "python_object, expected_type_string",
+    [
+        (False, "bool"),
+        (b"mystr", "bytes"),
+        (456.2, "float"),
+        (123, "int"),
+        ("mystr", "str"),
+        ([False, False], "Collection.bool"),
+        ([b"mystr", b"mystr"], "Collection.bytes"),
+        ([456.2, 1.0], "Collection.float"),
+        ([123, 456], "Collection.int"),
+        (["mystr", "mystr"], "Collection.str"),
+        ((False, False), "Collection.bool"),
+        ((b"mystr", b"mystr"), "Collection.bytes"),
+        ((456.2, 1.0), "Collection.float"),
+        ((123, 456), "Collection.int"),
+        (("mystr", "mystr"), "Collection.str"),
+        ((False, False), "Collection.bool"),
+        ((b"mystr", b"mystr"), "Collection.bytes"),
+        ((456.2, 1.0), "Collection.float"),
+        ((123, 456), "Collection.int"),
+        (("mystr", "mystr"), "Collection.str"),
+        (set([False, True]), "Collection.bool"),
+        (set([b"mystr", b"mystr2"]), "Collection.bytes"),
+        (set([456.2, 1.0]), "Collection.float"),
+        (set([123, 456]), "Collection.int"),
+        (set(["mystr", "mystr2"]), "Collection.str"),
+        (frozenset([False, True]), "Collection.bool"),
+        (frozenset([b"mystr", b"mystr2"]), "Collection.bytes"),
+        (frozenset([456.2, 1.0]), "Collection.float"),
+        (frozenset([123, 456]), "Collection.int"),
+        (frozenset(["mystr", "mystr2"]), "Collection.str"),
+    ],
+)
+def test___various_python_objects___get_best_matching_type___returns_correct_type_string(
+    python_object: object, expected_type_string: str
+) -> None:
+    type_string = nipanel._convert._get_best_matching_type(python_object)
+    assert type_string == expected_type_string
+
+
+# ========================================================
+# Built-in Types: Python to Protobuf
 # ========================================================
 @pytest.mark.parametrize(
     "proto_type, default_value, expected_value",
@@ -39,7 +92,7 @@
     ],
 )
 def test___python_builtin_scalar___to_any___valid_wrapperpb2_value(
-    proto_type: Type[_AnyWrappersPb2], default_value: Any, expected_value: Any
+    proto_type: type[_AnyWrappersPb2], default_value: Any, expected_value: Any
 ) -> None:
     result = nipanel._convert.to_any(expected_value)
     unpack_dest = proto_type(value=default_value)
@@ -60,7 +113,7 @@ def test___python_builtin_scalar___to_any___valid_wrapperpb2_value(
     ],
 )
 def test___python_panel_collection___to_any___valid_paneltype_value(
-    proto_type: Type[_AnyPanelPbTypes], default_value: Any, expected_value: Any
+    proto_type: type[_AnyPanelPbTypes], default_value: Any, expected_value: Any
 ) -> None:
     result = nipanel._convert.to_any(expected_value)
     unpack_dest = proto_type(values=default_value)
@@ -71,7 +124,7 @@ def test___python_panel_collection___to_any___valid_paneltype_value(
 
 
 # ========================================================
-# Protobuf to Python
+# Built-in Types: Protobuf to Python
 # ========================================================
 @pytest.mark.parametrize(
     "proto_type, expected_value",
@@ -84,7 +137,7 @@ def test___python_panel_collection___to_any___valid_paneltype_value(
     ],
 )
 def test___wrapperpb2_value___from_any___valid_python_value(
-    proto_type: Type[_AnyWrappersPb2], expected_value: Any
+    proto_type: type[_AnyWrappersPb2], expected_value: Any
 ) -> None:
     pb_value = proto_type(value=expected_value)
     packed_any = _pack_into_any(pb_value)
@@ -106,7 +159,7 @@ def test___wrapperpb2_value___from_any___valid_python_value(
     ],
 )
 def test___paneltype_value___from_any___valid_python_value(
-    proto_type: Type[_AnyPanelPbTypes], expected_value: Any
+    proto_type: type[_AnyPanelPbTypes], expected_value: Any
 ) -> None:
     pb_value = proto_type(values=expected_value)
     packed_any = _pack_into_any(pb_value)
@@ -117,15 +170,64 @@ def test___paneltype_value___from_any___valid_python_value(
     assert result == expected_value
 
 
+# ========================================================
+# Protobuf Types: Python to Protobuf
+# ========================================================
+def test___python_scalar_object___to_any___valid_scalar_data_value() -> None:
+    scalar_obj = Scalar(1.0, "amps")
+    result = nipanel._convert.to_any(scalar_obj)
+    unpack_dest = ScalarData()
+    _assert_any_and_unpack(result, unpack_dest)
+
+    assert isinstance(unpack_dest, ScalarData)
+    assert unpack_dest.double_value == 1.0
+    assert unpack_dest.units == "amps"
+
+
+def test___python_analog_waveform___to_any___valid_double_analog_waveform() -> None:
+    wfm_obj = AnalogWaveform(3)
+    result = nipanel._convert.to_any(wfm_obj)
+    unpack_dest = DoubleAnalogWaveform()
+    _assert_any_and_unpack(result, unpack_dest)
+
+    assert isinstance(unpack_dest, DoubleAnalogWaveform)
+    assert list(unpack_dest.y_data) == [0.0, 0.0, 0.0]
+
+
+# ========================================================
+# Protobuf Types: Protobuf to Python
+# ========================================================
+def test___scalar_data___from_any___valid_python_scalar_object() -> None:
+    pb_value = ScalarData(units="amps", double_value=1.0)
+    packed_any = _pack_into_any(pb_value)
+
+    result = nipanel._convert.from_any(packed_any)
+
+    assert isinstance(result, Scalar)
+    assert result.value == 1.0
+    assert result.units == "amps"
+
+
+def test___double_analog_waveform___from_any___valid_python_analog_waveform() -> None:
+    pb_value = DoubleAnalogWaveform(y_data=[0.0, 0.0, 0.0])
+    packed_any = _pack_into_any(pb_value)
+
+    result = nipanel._convert.from_any(packed_any)
+
+    assert isinstance(result, AnalogWaveform)
+    assert result.sample_count == result.capacity == len(result.raw_data) == 3
+    assert result.dtype == np.float64
+
+
 # ========================================================
 # Pack/Unpack Helpers
 # ========================================================
-def _assert_any_and_unpack(packed_message: any_pb2.Any, unpack_destination: Any) -> None:
+def _assert_any_and_unpack(packed_message: any_pb2.Any, unpack_destination: Message) -> None:
     assert isinstance(packed_message, any_pb2.Any)
     assert packed_message.Unpack(unpack_destination)
 
 
-def _pack_into_any(proto_value: Union[_AnyWrappersPb2, _AnyPanelPbTypes]) -> any_pb2.Any:
+def _pack_into_any(proto_value: Message) -> any_pb2.Any:
     as_any = any_pb2.Any()
     as_any.Pack(proto_value)
     return as_any