Create HTDateTimeConverter and rename PrecisionTimestampConverter (#138)

* Create HighTimeDateTimeConverter and rename PrecisionTimestampConverter

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

* Revert changes to raised TypeError.

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

* Update get_value docstring based on PR feedback.

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

---------

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

Author: mjohanse-emr

examples/all_types/all_types_panel.py

@@ -3,6 +3,7 @@
 import datetime as dt
 from enum import Enum, Flag
 
+import hightime as ht
 import streamlit as st
 from define_types import all_types_with_values
 
@@ -121,11 +122,20 @@
             st.number_input(label=name, value=default_value, key=name, format="%.2f")
         elif isinstance(default_value, str):
             st.text_input(label=name, value=default_value, key=name)
+        elif isinstance(default_value, ht.datetime):
+            # In order to avoid multiple date_input elements with the same ID,
+            # specify a unique key for both ht.datetime and dt.datetime.
+            date = st.date_input(label="date", key="ht1", value=default_value)
+            time = st.time_input(label="time", key="ht2", value=default_value)
+            ht_datetime = ht.datetime.combine(date, time, tzinfo=dt.timezone.utc)
+            panel.set_value(name, ht_datetime)
         elif isinstance(default_value, dt.datetime):
-            date = st.date_input(label="date", value=default_value)
-            time = st.time_input(label="time", value=default_value)
-            datetime = dt.datetime.combine(date, time)
-            panel.set_value(name, datetime)
+            # In order to avoid multiple date_input elements with the same ID,
+            # specify a unique key for both ht.datetime and dt.datetime.
+            date = st.date_input(label="date", key="dt1", value=default_value)
+            time = st.time_input(label="time", key="dt2", value=default_value)
+            dt_datetime = dt.datetime.combine(date, time)
+            panel.set_value(name, dt_datetime)
 
     with col3:
         st.write(panel.get_value(name, default_value=default_value))

examples/all_types/define_types.py

@@ -3,6 +3,8 @@
 import datetime as dt
 import enum
 
+import hightime as ht
+import nitypes.bintime as bt
 import numpy as np
 from nitypes.complex import ComplexInt32DType
 from nitypes.scalar import Scalar
@@ -74,6 +76,8 @@ class MyMixedEnum(enum.Enum):
     "int": 42,
     "str": "sample string",
     "dt_datetime": dt.datetime.now(),
+    "ht_datetime": ht.datetime.now(tz=dt.timezone.utc),
+    "bt_datetime": bt.DateTime.now(tz=dt.timezone.utc),
     "dt_timedelta": dt.timedelta(weeks=2, days=5, minutes=12, milliseconds=75),
     # supported enum and flag types
     "intflags": MyIntFlags.VALUE1 | MyIntFlags.VALUE4,

src/nipanel/_convert.py

@@ -20,6 +20,7 @@
     StrConverter,
 )
 from nipanel.converters.protobuf_types import (
+    BTDateTimeConverter,
     BoolCollectionConverter,
     BytesCollectionConverter,
     DigitalWaveformConverter,
@@ -28,6 +29,7 @@
     DoubleComplexWaveformConverter,
     DoubleSpectrumConverter,
     FloatCollectionConverter,
+    HTDateTimeConverter,
     Int16AnalogWaveformConverter,
     Int16ComplexWaveformConverter,
     IntCollectionConverter,
@@ -49,6 +51,7 @@
     DTDateTimeConverter(),
     DTTimeDeltaConverter(),
     # Protobuf Types
+    BTDateTimeConverter(),
     BoolCollectionConverter(),
     BytesCollectionConverter(),
     DigitalWaveformConverter(),
@@ -57,6 +60,7 @@
     DoubleComplexWaveformConverter(),
     DoubleSpectrumConverter(),
     FloatCollectionConverter(),
+    HTDateTimeConverter(),
     Int16AnalogWaveformConverter(),
     Int16ComplexWaveformConverter(),
     IntCollectionConverter(),

src/nipanel/_panel_value_accessor.py

@@ -6,8 +6,11 @@
 from typing import TypeVar, overload
 
 import grpc
+import hightime as ht
+import nitypes.bintime as bt
 from ni_measurement_plugin_sdk_service.discovery import DiscoveryClient
 from ni_measurement_plugin_sdk_service.grpc.channelpool import GrpcChannelPool
+from nitypes.time import convert_datetime
 
 from nipanel._panel_client import _PanelClient
 
@@ -65,7 +68,8 @@ def get_value(self, value_id: str, default_value: _T | None = None) -> _T | obje
             default_value: The default value to return if the value is not set
 
         Returns:
-            The value, or the default value if not set
+            The value, or the default value if not set. The returned value will
+            be the same as default_value, if one was provided.
 
         Raises:
             KeyError: If the value is not set and no default value is provided
@@ -81,6 +85,12 @@ def get_value(self, value_id: str, default_value: _T | None = None) -> _T | obje
                 enum_type = type(default_value)
                 return enum_type(value)
 
+            # The grpc converter always converts PrecisionTimestamp into bt.DateTime, so
+            # we need to handle the case where they provide an ht.datetime default by
+            # converting to hightime.
+            if isinstance(default_value, ht.datetime) and isinstance(value, bt.DateTime):
+                return convert_datetime(ht.datetime, value)
+
             # lists are allowed to not match, since sets and tuples are converted to lists
             if not isinstance(value, list):
                 raise TypeError(

src/nipanel/converters/protobuf_types.py

@@ -5,6 +5,7 @@
 from collections.abc import Collection
 from typing import Any, Type, Union
 
+import hightime as ht
 import nitypes.bintime as bt
 import numpy as np
 from ni.protobuf.types import (
@@ -377,9 +378,7 @@ def to_python_value(
         return waveform_conversion.float64_spectrum_from_protobuf(protobuf_message)
 
 
-class PrecisionTimestampConverter(
-    Converter[bt.DateTime, precision_timestamp_pb2.PrecisionTimestamp]
-):
+class BTDateTimeConverter(Converter[bt.DateTime, precision_timestamp_pb2.PrecisionTimestamp]):
     """A converter for bintime.DateTime types."""
 
     @property
@@ -405,6 +404,44 @@ def to_python_value(
         return precision_timestamp_conversion.bintime_datetime_from_protobuf(protobuf_message)
 
 
+class HTDateTimeConverter(Converter[ht.datetime, precision_timestamp_pb2.PrecisionTimestamp]):
+    """A converter for hightime.datetime objects."""
+
+    @property
+    def python_type(self) -> type:
+        """The Python type that this converter handles."""
+        return ht.datetime
+
+    @property
+    def protobuf_message(self) -> Type[precision_timestamp_pb2.PrecisionTimestamp]:
+        """The type-specific protobuf message for the Python type."""
+        return precision_timestamp_pb2.PrecisionTimestamp
+
+    @property
+    def protobuf_typename(self) -> str:
+        """The protobuf name for the type.
+
+        Override the base class here because there can only be one converter that
+        converts ``PrecisionTimestamp`` objects. Since there are two converters that convert
+        to ``PrecisionTimestamp``, we have to choose one to handle conversion from protobuf.
+        For the purposes of nipanel, we'll convert ``PrecisionTimestamp`` messages to
+        bintime.DateTime. See ``BTDateTimeConverter``.
+        """
+        return "PrecisionTimestamp_Placeholder"
+
+    def to_protobuf_message(
+        self, python_value: ht.datetime
+    ) -> precision_timestamp_pb2.PrecisionTimestamp:
+        """Convert the Python DateTime to a protobuf PrecisionTimestamp."""
+        return precision_timestamp_conversion.hightime_datetime_to_protobuf(python_value)
+
+    def to_python_value(
+        self, protobuf_message: precision_timestamp_pb2.PrecisionTimestamp
+    ) -> ht.datetime:
+        """Convert the protobuf PrecisionTimestamp to a Python DateTime."""
+        return precision_timestamp_conversion.hightime_datetime_from_protobuf(protobuf_message)
+
+
 class ScalarConverter(Converter[Scalar[_AnyScalarType], scalar_pb2.Scalar]):
     """A converter for Scalar objects."""
 

tests/unit/test_convert.py

@@ -1,13 +1,23 @@
 import datetime as dt
 from typing import Any, Collection, Union
 
+import hightime as ht
+import nitypes.bintime as bt
 import numpy as np
 import pytest
 from google.protobuf import any_pb2, duration_pb2, timestamp_pb2, wrappers_pb2
 from google.protobuf.message import Message
-from ni.protobuf.types import array_pb2, attribute_value_pb2, scalar_pb2, vector_pb2, waveform_pb2
+from ni.protobuf.types import (
+    array_pb2,
+    attribute_value_pb2,
+    precision_timestamp_pb2,
+    scalar_pb2,
+    vector_pb2,
+    waveform_pb2,
+)
 from nitypes.complex import ComplexInt32DType
 from nitypes.scalar import Scalar
+from nitypes.time import convert_datetime
 from nitypes.vector import Vector
 from nitypes.waveform import AnalogWaveform, ComplexWaveform, DigitalWaveform, Spectrum
 from typing_extensions import TypeAlias
@@ -50,6 +60,8 @@
         (tests.types.MixinStrEnum.VALUE11, "builtins.str"),
         (dt.datetime.now(), "datetime.datetime"),
         (dt.timedelta(days=1), "datetime.timedelta"),
+        (bt.DateTime.now(tz=dt.timezone.utc), "nitypes.bintime.DateTime"),
+        (ht.datetime.now(), "hightime.datetime"),
         ([False, False], "collections.abc.Collection[builtins.bool]"),
         ([b"mystr", b"mystr"], "collections.abc.Collection[builtins.bytes]"),
         ([456.2, 1.0], "collections.abc.Collection[builtins.float]"),
@@ -369,6 +381,31 @@ def test___python_float64_spectrum___to_any___valid_double_spectrum_proto() -> N
     assert unpack_dest.frequency_increment == 10.0
 
 
+def test___python_bintime_datetime__to_any___valid_precision_timestamp_proto() -> None:
+    python_value = bt.DateTime(year=2020, month=1, day=10, second=45, tzinfo=dt.timezone.utc)
+
+    result = nipanel._convert.to_any(python_value)
+    unpack_dest = precision_timestamp_pb2.PrecisionTimestamp()
+    _assert_any_and_unpack(result, unpack_dest)
+
+    expected_tuple = python_value.to_tuple()
+    assert unpack_dest.seconds == expected_tuple.whole_seconds
+    assert unpack_dest.fractional_seconds == expected_tuple.fractional_seconds
+
+
+def test___python_hightime_datetime__to_any___valid_precision_timestamp_proto() -> None:
+    python_value = ht.datetime(year=2020, month=1, day=10, second=45, tzinfo=dt.timezone.utc)
+
+    result = nipanel._convert.to_any(python_value)
+    unpack_dest = precision_timestamp_pb2.PrecisionTimestamp()
+    _assert_any_and_unpack(result, unpack_dest)
+
+    expected_bt_datetime = convert_datetime(bt.DateTime, python_value)
+    expected_tuple = expected_bt_datetime.to_tuple()
+    assert unpack_dest.seconds == expected_tuple.whole_seconds
+    assert unpack_dest.fractional_seconds == expected_tuple.fractional_seconds
+
+
 @pytest.mark.parametrize(
     "python_value",
     [
@@ -564,6 +601,21 @@ def test___double_spectrum_proto___from_any___valid_python_spectrum() -> None:
     assert result.frequency_increment == 10.0
 
 
+def test___precision_timestamp_proto__from_any___valid_bintime_datetime() -> None:
+    expected_bt_dt = bt.DateTime(year=2020, month=1, day=10, second=45, tzinfo=dt.timezone.utc)
+    expected_tuple = expected_bt_dt.to_tuple()
+    pb_value = precision_timestamp_pb2.PrecisionTimestamp(
+        seconds=expected_tuple.whole_seconds,
+        fractional_seconds=expected_tuple.fractional_seconds,
+    )
+    packed_any = _pack_into_any(pb_value)
+
+    result = nipanel._convert.from_any(packed_any)
+
+    assert isinstance(result, bt.DateTime)
+    assert result == expected_bt_dt
+
+
 def test___double2darray___from_any___valid_python_2dcollection() -> None:
     pb_value = array_pb2.Double2DArray(data=[1.0, 2.0, 3.0, 4.0], rows=2, columns=2)
     packed_any = _pack_into_any(pb_value)

tests/unit/test_waveform_conversion.py

@@ -4,7 +4,11 @@
 
 import nitypes.bintime as bt
 import numpy as np
-from ni.protobuf.types import precision_timestamp_pb2, waveform_pb2
+from ni.protobuf.types import (
+    precision_timestamp_conversion,
+    precision_timestamp_pb2,
+    waveform_pb2,
+)
 from nitypes.complex import ComplexInt32DType
 from nitypes.waveform import (
     AnalogWaveform,
@@ -23,7 +27,6 @@
     DoubleSpectrumConverter,
     Int16AnalogWaveformConverter,
     Int16ComplexWaveformConverter,
-    PrecisionTimestampConverter,
 )
 
 EXPECTED_SAMPLE_INTERVAL = 0.1
@@ -284,8 +287,7 @@ def test___double_spectrum___convert___valid_python_object() -> None:
 # Helpers
 # ========================================================
 def _get_t0_pt() -> precision_timestamp_pb2.PrecisionTimestamp:
-    pt_converter = PrecisionTimestampConverter()
-    return pt_converter.to_protobuf_message(EXPECTED_T0_BT)
+    return precision_timestamp_conversion.bintime_datetime_to_protobuf(EXPECTED_T0_BT)
 
 
 def _set_python_attributes(