Implement XYData publish/read (#43)

* Implement XYData publish/read

Signed-off-by: Michael Johansen <michael.johansen@emerson.com>

* Re-lock after merge from main

Signed-off-by: Michael Johansen <michael.johansen@emerson.com>

---------

Signed-off-by: Michael Johansen <michael.johansen@emerson.com>

Author: mjohanse-emr

poetry.lock

@@ -40,7 +40,7 @@ protobuf = {version=">=4.21"}
 ni-datamonikers-v1-client = { version = ">=0.1.0.dev1", allow-prereleases = true }
 ni-measurements-data-v1-client = { version = ">=0.1.0.dev1", allow-prereleases = true }
 ni-measurements-metadata-v1-client = { version = ">=0.1.0.dev1", allow-prereleases = true }
-ni-protobuf-types = { version = ">=0.1.0.dev3", allow-prereleases = true }
+ni-protobuf-types = { version = ">=1.0.1.dev0", allow-prereleases = true }
 hightime = { version = ">=0.3.0.dev0", allow-prereleases = true }
 
 [tool.poetry.group.dev.dependencies]

pyproject.toml

@@ -44,11 +44,16 @@
     I16AnalogWaveform,
     I16ComplexWaveform,
 )
+from ni.protobuf.types.xydata_conversion import (
+    float64_xydata_from_protobuf,
+    float64_xydata_to_protobuf,
+)
 from ni.protobuf.types.xydata_pb2 import DoubleXYData
 from nitypes.complex import ComplexInt32DType
 from nitypes.scalar import Scalar
 from nitypes.vector import Vector
 from nitypes.waveform import AnalogWaveform, ComplexWaveform, DigitalWaveform, Spectrum
+from nitypes.xy_data import XYData
 
 _logger = logging.getLogger(__name__)
 
@@ -137,6 +142,11 @@ def populate_publish_measurement_request_value(
             raise TypeError(f"Unsupported Spectrum dtype: {value.dtype}")
     elif isinstance(value, DigitalWaveform):
         publish_request.digital_waveform.CopyFrom(digital_waveform_to_protobuf(value))
+    elif isinstance(value, XYData):
+        if value.dtype == np.float64:
+            publish_request.x_y_data.CopyFrom(float64_xydata_to_protobuf(value))
+        else:
+            raise TypeError(f"Unsupported XYData dtype: {value.dtype}")
     elif isinstance(value, Iterable):
         if not value:
             raise ValueError("Cannot publish an empty Iterable.")
@@ -152,7 +162,6 @@ def populate_publish_measurement_request_value(
         raise TypeError(
             f"Unsupported measurement value type: {type(value)}. Please consult the documentation."
         )
-    # TODO: Implement conversion from proper XYData type
 
 
 def populate_publish_measurement_batch_request_values(
@@ -208,10 +217,7 @@ def unpack_and_convert_from_protobuf_any(read_value: Any) -> object:
     elif value_type == DoubleXYData.DESCRIPTOR.full_name:
         xydata = DoubleXYData()
         read_value.Unpack(xydata)
-        _logger.warning(
-            "DoubleXYData conversion is not yet implemented. Returning the raw protobuf object."
-        )
-        return xydata
+        return float64_xydata_from_protobuf(xydata)
     elif value_type == VectorProto.DESCRIPTOR.full_name:
         vector = VectorProto()
         read_value.Unpack(vector)

src/ni/datastore/data/_grpc_conversion.py

@@ -21,11 +21,13 @@
     scalar_pb2,
     vector_pb2,
     waveform_pb2,
+    xydata_pb2,
 )
 from nitypes.complex import ComplexInt32DType
 from nitypes.scalar import Scalar
 from nitypes.vector import Vector
 from nitypes.waveform import AnalogWaveform, ComplexWaveform, DigitalWaveform, Spectrum
+from nitypes.xy_data import XYData
 
 
 # ========================================================
@@ -193,6 +195,21 @@ def test___python_float64_spectrum___populate_measurement___measurement_updated_
     assert request.double_spectrum.frequency_increment == 10.0
 
 
+def test___python_float64_xydata___populate_measurement___measurement_updated_correctly() -> None:
+    xydata = XYData.from_arrays_1d(
+        [1.0, 2.0], [3.0, 4.0], np.float64, x_units="Volts", y_units="Seconds"
+    )
+
+    request = PublishMeasurementRequest()
+    populate_publish_measurement_request_value(request, xydata)
+
+    assert isinstance(request.x_y_data, xydata_pb2.DoubleXYData)
+    assert list(request.x_y_data.x_data) == [1.0, 2.0]
+    assert list(request.x_y_data.y_data) == [3.0, 4.0]
+    assert request.x_y_data.attributes["NI_UnitDescription_X"].string_value == "Volts"
+    assert request.x_y_data.attributes["NI_UnitDescription_Y"].string_value == "Seconds"
+
+
 # ========================================================
 # Populate Measurement Batch
 # ========================================================
@@ -322,6 +339,27 @@ def test___double_spectrum_proto___convert_from_protobuf___valid_python_spectrum
     assert result.frequency_increment == 10.0
 
 
+def test___xydata_proto___convert_from_protobuf___valid_python_xydata() -> None:
+    attrs = {
+        "NI_UnitDescription_X": attribute_value_pb2.AttributeValue(string_value="amps"),
+        "NI_UnitDescription_Y": attribute_value_pb2.AttributeValue(string_value="seconds"),
+    }
+    pb_value = xydata_pb2.DoubleXYData(
+        x_data=[1.0, 2.0],
+        y_data=[3.0, 4.0],
+        attributes=attrs,
+    )
+    packed_any = _pack_into_any(pb_value)
+
+    result = unpack_and_convert_from_protobuf_any(packed_any)
+
+    assert isinstance(result, XYData)
+    assert list(result.x_data) == [1.0, 2.0]
+    assert list(result.y_data) == [3.0, 4.0]
+    assert result.x_units == "amps"
+    assert result.y_units == "seconds"
+
+
 # ========================================================
 # Pack/Unpack Helpers
 # ========================================================

tests/unit/data/test_grpc_conversion.py

@@ -29,8 +29,11 @@
 from ni.protobuf.types.vector_pb2 import Vector as VectorProto
 from ni.protobuf.types.waveform_conversion import float64_analog_waveform_to_protobuf
 from ni.protobuf.types.waveform_pb2 import DoubleAnalogWaveform
+from ni.protobuf.types.xydata_conversion import float64_xydata_to_protobuf
+from ni.protobuf.types.xydata_pb2 import DoubleXYData
 from nitypes.vector import Vector
 from nitypes.waveform import AnalogWaveform, Timing
+from nitypes.xy_data import XYData
 
 
 @pytest.mark.parametrize("value", [True, False])
@@ -118,6 +121,34 @@ def test___publish_analog_waveform_data___calls_data_store_service_client(
     assert request.test_adapter_ids == []
 
 
+def test___publish_float64_xydata___calls_data_store_service_client(
+    data_store_client: DataStoreClient,
+    mocked_data_store_service_client: NonCallableMock,
+) -> None:
+    xydata = XYData.from_arrays_1d(
+        x_array=[1.0, 2.0],
+        y_array=[3.0, 4.0],
+        dtype=np.float64,
+        x_units="Volts",
+        y_units="Seconds",
+    )
+    expected_protobuf_xydata = DoubleXYData()
+    expected_protobuf_xydata.CopyFrom(float64_xydata_to_protobuf(xydata))
+    published_measurement = PublishedMeasurement(published_measurement_id="response_id")
+    expected_response = PublishMeasurementResponse(published_measurement=published_measurement)
+    mocked_data_store_service_client.publish_measurement.return_value = expected_response
+
+    # Now, when client.publish_measurement calls foo.MyClass().publish(), it will use the mock
+    result = data_store_client.publish_measurement("name", xydata, "step_id")
+
+    args, __ = mocked_data_store_service_client.publish_measurement.call_args
+    request = cast(PublishMeasurementRequest, args[0])  # The PublishMeasurementRequest object
+    assert result.published_measurement_id == "response_id"
+    assert request.step_id == "step_id"
+    assert request.measurement_name == "name"
+    assert request.x_y_data == expected_protobuf_xydata
+
+
 @pytest.mark.parametrize(
     "value", [[1, 2, 3], [1.0, 2.0, 3.0], [True, False, True], ["one", "two", "three"]]
 )

tests/unit/data/test_publish_measurement.py

@@ -9,10 +9,11 @@
 from google.protobuf.any_pb2 import Any as gpAny
 from ni.datamonikers.v1.data_moniker_pb2 import Moniker, ReadFromMonikerResult
 from ni.datastore.data import DataStoreClient
-from ni.protobuf.types import array_pb2, attribute_value_pb2, vector_pb2, waveform_pb2
+from ni.protobuf.types import array_pb2, attribute_value_pb2, vector_pb2, waveform_pb2, xydata_pb2
 from nitypes.complex import ComplexInt32DType
 from nitypes.vector import Vector
 from nitypes.waveform import AnalogWaveform, ComplexWaveform, DigitalWaveform, Spectrum
+from nitypes.xy_data import XYData
 
 
 def test___read_data___calls_moniker_client(
@@ -173,6 +174,34 @@ def test___read_vector___value_correct(
     assert actual_vector.units == "amps"
 
 
+def test___read_xydata___value_correct(
+    data_store_client: DataStoreClient, mocked_moniker_client: NonCallableMock
+) -> None:
+    moniker = _init_moniker()
+    result = ReadFromMonikerResult()
+    value_to_read = gpAny()
+    attrs = {
+        "NI_UnitDescription_X": attribute_value_pb2.AttributeValue(string_value="amps"),
+        "NI_UnitDescription_Y": attribute_value_pb2.AttributeValue(string_value="seconds"),
+    }
+    expected_xydata = xydata_pb2.DoubleXYData(
+        x_data=[1.0, 2.0],
+        y_data=[3.0, 4.0],
+        attributes=attrs,
+    )
+    value_to_read.Pack(expected_xydata)
+    result.value.CopyFrom(value_to_read)
+    mocked_moniker_client.read_from_moniker.return_value = result
+
+    actual_xydata = data_store_client.read_data(moniker, XYData)
+
+    assert isinstance(actual_xydata, XYData)
+    assert list(actual_xydata.x_data) == [1.0, 2.0]
+    assert list(actual_xydata.y_data) == [3.0, 4.0]
+    assert actual_xydata.x_units == "amps"
+    assert actual_xydata.y_units == "seconds"
+
+
 def _init_moniker() -> Moniker:
     moniker = Moniker()
     moniker.data_instance = 12