Address review feedback around timing conversion.

Signed-off-by: Michael Johansen <[email protected]>

Author: Michael Johansen

src/nipanel/converters/protobuf_types.py

@@ -1,9 +1,9 @@
 """Classes to convert between measurement specific protobuf types and containers."""
 
 import collections.abc
-import datetime as dt
 from typing import Type, Union
 
+import hightime as ht
 import numpy
 from ni.protobuf.types import scalar_pb2
 from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types.precision_timestamp_pb2 import (
@@ -15,7 +15,13 @@
 )
 from nitypes.bintime import DateTime, TimeValueTuple
 from nitypes.scalar import Scalar
-from nitypes.waveform import AnalogWaveform, ExtendedPropertyDictionary, NoneScaleMode, Timing
+from nitypes.waveform import (
+    AnalogWaveform,
+    ExtendedPropertyDictionary,
+    NoneScaleMode,
+    SampleIntervalMode,
+    Timing,
+)
 from typing_extensions import TypeAlias
 
 from nipanel.converters import Converter
@@ -93,14 +99,32 @@ def to_python_value(
         self, protobuf_value: DoubleAnalogWaveform
     ) -> AnalogWaveform[numpy.float64]:
         """Convert the protobuf DoubleAnalogWaveform to a Python AnalogWaveform."""
-        pt_converter = PrecisionTimestampConverter()
-        bin_datetime = pt_converter.to_python_value(protobuf_value.t0)
-        timestamp = bin_datetime._to_datetime_datetime()
-        sample_interval = dt.timedelta(seconds=protobuf_value.dt)
-        timing = Timing.create_with_regular_interval(
-            sample_interval,
-            timestamp,
-        )
+        if (
+            not protobuf_value.dt
+            and not protobuf_value.t0.seconds
+            and not protobuf_value.t0.fractional_seconds
+        ):
+            # If both dt and t0 and unset, use Timing.empty.
+            timing = Timing.empty
+        else:
+            # Timestamp
+            pt_converter = PrecisionTimestampConverter()
+            bin_datetime = pt_converter.to_python_value(protobuf_value.t0)
+            timestamp = bin_datetime._to_datetime_datetime()
+
+            # Sample Interval
+            if not protobuf_value.dt:
+                sample_interval_mode = SampleIntervalMode.NONE
+                sample_interval = None
+            else:
+                sample_interval_mode = SampleIntervalMode.REGULAR
+                sample_interval = ht.timedelta(seconds=protobuf_value.dt)
+
+            timing = Timing(
+                sample_interval_mode=sample_interval_mode,
+                timestamp=timestamp,
+                sample_interval=sample_interval,
+            )
 
         extended_properties = {}
         for key, value in protobuf_value.attributes.items():

tests/unit/test_protobuf_type_conversion.py

@@ -12,7 +12,7 @@
 )
 from nitypes.bintime import DateTime
 from nitypes.scalar import Scalar
-from nitypes.waveform import AnalogWaveform, NoneScaleMode, Timing
+from nitypes.waveform import AnalogWaveform, NoneScaleMode, SampleIntervalMode, Timing
 
 from nipanel.converters.protobuf_types import (
     DoubleAnalogWaveformConverter,
@@ -26,6 +26,7 @@
 # ========================================================
 def test___default_analog_waveform___convert___valid_protobuf() -> None:
     analog_waveform = AnalogWaveform()
+
     converter = DoubleAnalogWaveformConverter()
     dbl_analog_waveform = converter.to_protobuf_message(analog_waveform)
 
@@ -77,7 +78,6 @@ def test___analog_waveform_with_standard_timing___convert___valid_protobuf() ->
     dbl_analog_waveform = converter.to_protobuf_message(analog_waveform)
 
     assert dbl_analog_waveform.dt == 1.0
-
     bin_dt = DateTime(t0_dt)
     pt_converter = PrecisionTimestampConverter()
     converted_t0 = pt_converter.to_protobuf_message(bin_dt)
@@ -89,18 +89,19 @@ def test___analog_waveform_with_standard_timing___convert___valid_protobuf() ->
 # ========================================================
 def test___default_dbl_analog_wfm___convert___valid_python_object() -> None:
     dbl_analog_wfm = DoubleAnalogWaveform()
+
     converter = DoubleAnalogWaveformConverter()
     analog_waveform = converter.to_python_value(dbl_analog_wfm)
 
     assert not analog_waveform.extended_properties
-    assert analog_waveform.timing.sample_interval == dt.timedelta()
-    assert analog_waveform.timing.start_time == dt.datetime(1904, 1, 1, tzinfo=dt.timezone.utc)
+    assert analog_waveform.timing == Timing.empty
     assert analog_waveform.scaled_data.size == 0
     assert analog_waveform.scale_mode == NoneScaleMode()
 
 
 def test___dbl_analog_wfm_with_y_data___convert___valid_python_object() -> None:
     dbl_analog_wfm = DoubleAnalogWaveform(y_data=[1.0, 2.0, 3.0])
+
     converter = DoubleAnalogWaveformConverter()
     analog_waveform = converter.to_python_value(dbl_analog_wfm)
 
@@ -113,6 +114,7 @@ def test___dbl_analog_wfm_with_attributes___convert___valid_python_object() -> N
         "NI_UnitDescription": WaveformAttributeValue(string_value="Volts"),
     }
     dbl_analog_wfm = DoubleAnalogWaveform(attributes=attributes)
+
     converter = DoubleAnalogWaveformConverter()
     analog_waveform = converter.to_python_value(dbl_analog_wfm)
 
@@ -125,11 +127,38 @@ def test___dbl_analog_wfm_with_timing___convert___valid_python_object() -> None:
     pt_converter = PrecisionTimestampConverter()
     t0_pt = pt_converter.to_protobuf_message(t0_dt)
     dbl_analog_wfm = DoubleAnalogWaveform(t0=t0_pt, dt=0.1, y_data=[1.0, 2.0, 3.0])
+
     converter = DoubleAnalogWaveformConverter()
     analog_waveform = converter.to_python_value(dbl_analog_wfm)
 
     assert analog_waveform.timing.start_time == t0_dt._to_datetime_datetime()
     assert analog_waveform.timing.sample_interval == dt.timedelta(seconds=0.1)
+    assert analog_waveform.timing.sample_interval_mode == SampleIntervalMode.REGULAR
+
+
+def test___dbl_analog_wfm_with_timing_no_t0___convert___valid_python_object() -> None:
+    dbl_analog_wfm = DoubleAnalogWaveform(dt=0.1, y_data=[1.0, 2.0, 3.0])
+
+    converter = DoubleAnalogWaveformConverter()
+    analog_waveform = converter.to_python_value(dbl_analog_wfm)
+
+    assert analog_waveform.timing.start_time == dt.datetime(1904, 1, 1, tzinfo=dt.timezone.utc)
+    assert analog_waveform.timing.sample_interval == dt.timedelta(seconds=0.1)
+    assert analog_waveform.timing.sample_interval_mode == SampleIntervalMode.REGULAR
+
+
+def test___dbl_analog_wfm_with_timing_no_dt___convert___valid_python_object() -> None:
+    t0_dt = DateTime(2020, 5, 5, tzinfo=dt.timezone.utc)
+    pt_converter = PrecisionTimestampConverter()
+    t0_pt = pt_converter.to_protobuf_message(t0_dt)
+    dbl_analog_wfm = DoubleAnalogWaveform(t0=t0_pt, y_data=[1.0, 2.0, 3.0])
+
+    converter = DoubleAnalogWaveformConverter()
+    analog_waveform = converter.to_python_value(dbl_analog_wfm)
+
+    assert analog_waveform.timing.start_time == t0_dt._to_datetime_datetime()
+    assert not analog_waveform.timing.has_sample_interval
+    assert analog_waveform.timing.sample_interval_mode == SampleIntervalMode.NONE
 
 
 # ========================================================