Refactor python type names to use brackets and include module names for Collection. Type name logic moved into base class.

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

Author: Michael Johansen

src/nipanel/_convert.py

@@ -101,13 +101,12 @@ def _get_best_matching_type(python_value: object) -> str:
             value_is_collection = any(
                 _CONVERTIBLE_COLLECTION_TYPES.intersection(underlying_parents)
             )
-        container_types.append(Collection.__name__)
+        container_types.append(Collection)
 
     best_matching_type = None
     candidates = _get_candidate_strings(underlying_parents)
     for candidate in candidates:
-        containers_str = ".".join(container_types)
-        python_typename = f"{containers_str}.{candidate}" if containers_str else candidate
+        python_typename = _create_python_typename(candidate, container_types)
         if python_typename not in _SUPPORTED_PYTHON_TYPES:
             continue
         best_matching_type = python_typename
@@ -150,3 +149,10 @@ def _get_candidate_strings(candidates: Iterable[type]) -> list[str]:
         candidate_names.append(f"{candidate.__module__}.{candidate.__name__}")
 
     return candidate_names
+
+
+def _create_python_typename(candidate_name: str, container_types: Iterable[type]) -> str:
+    name = candidate_name
+    for container_type in container_types:
+        name = f"{container_type.__module__}.{container_type.__name__}[{name}]"
+    return name

src/nipanel/converters/__init__.py

@@ -3,11 +3,13 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
+from collections.abc import Collection
 from typing import Generic, Type, TypeVar
 
 from google.protobuf import any_pb2
 from google.protobuf.message import Message
 
+_TItemType = TypeVar("_TItemType")
 _TPythonType = TypeVar("_TPythonType")
 _TProtobufType = TypeVar("_TProtobufType", bound=Message)
 
@@ -17,9 +19,14 @@ class Converter(Generic[_TPythonType, _TProtobufType], ABC):
 
     @property
     @abstractmethod
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
 
+    @property
+    def python_typename(self) -> str:
+        """The Python type name that this converter handles."""
+        return f"{self.python_type.__module__}.{self.python_type.__name__}"
+
     @property
     @abstractmethod
     def protobuf_message(self) -> Type[_TProtobufType]:
@@ -52,3 +59,56 @@ def to_python(self, protobuf_value: any_pb2.Any) -> _TPythonType:
     @abstractmethod
     def to_python_value(self, protobuf_message: _TProtobufType) -> _TPythonType:
         """Convert the protobuf wrapper message to its matching Python type."""
+
+
+class CollectionConverter(
+    Generic[_TItemType, _TProtobufType],
+    Converter[Collection[_TItemType], _TProtobufType],
+    ABC,
+):
+    """A converter between a collection of Python objects and protobuf Any messages."""
+
+    @property
+    @abstractmethod
+    def item_type(self) -> type:
+        """The Python item type that this converter handles."""
+
+    @property
+    def python_type(self) -> type:
+        """The Python type that this converter handles."""
+        return Collection
+
+    @property
+    def python_typename(self) -> str:
+        """The Python type name that this converter handles."""
+        return "{}[{}]".format(
+            f"{Collection.__module__}.{Collection.__name__}",
+            f"{self.item_type.__module__}.{self.item_type.__name__}",
+        )
+
+
+class CollectionConverter2D(
+    Generic[_TItemType, _TProtobufType],
+    Converter[Collection[Collection[_TItemType]], _TProtobufType],
+    ABC,
+):
+    """A converter between a 2D collection of Python objects and protobuf Any messages."""
+
+    @property
+    @abstractmethod
+    def item_type(self) -> type:
+        """The Python item type that this converter handles."""
+
+    @property
+    def python_type(self) -> type:
+        """The Python type that this converter handles."""
+        return Collection
+
+    @property
+    def python_typename(self) -> str:
+        """The Python type name that this converter handles."""
+        return "{}[{}[{}]]".format(
+            f"{Collection.__module__}.{Collection.__name__}",
+            f"{Collection.__module__}.{Collection.__name__}",
+            f"{self.item_type.__module__}.{self.item_type.__name__}",
+        )

src/nipanel/converters/builtin.py

@@ -7,16 +7,16 @@
 from google.protobuf import duration_pb2, timestamp_pb2, wrappers_pb2
 from ni.panels.v1 import panel_types_pb2
 
-from nipanel.converters import Converter
+from nipanel.converters import Converter, CollectionConverter
 
 
 class BoolConverter(Converter[bool, wrappers_pb2.BoolValue]):
     """A converter for boolean types."""
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{bool.__module__}.{bool.__name__}"
+        return bool
 
     @property
     def protobuf_message(self) -> Type[wrappers_pb2.BoolValue]:
@@ -36,9 +36,9 @@ class BytesConverter(Converter[bytes, wrappers_pb2.BytesValue]):
     """A converter for byte string types."""
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{bytes.__module__}.{bytes.__name__}"
+        return bytes
 
     @property
     def protobuf_message(self) -> Type[wrappers_pb2.BytesValue]:
@@ -58,9 +58,9 @@ class FloatConverter(Converter[float, wrappers_pb2.DoubleValue]):
     """A converter for floating point types."""
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{float.__module__}.{float.__name__}"
+        return float
 
     @property
     def protobuf_message(self) -> Type[wrappers_pb2.DoubleValue]:
@@ -80,9 +80,9 @@ class IntConverter(Converter[int, wrappers_pb2.Int64Value]):
     """A converter for integer types."""
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{int.__module__}.{int.__name__}"
+        return int
 
     @property
     def protobuf_message(self) -> Type[wrappers_pb2.Int64Value]:
@@ -102,9 +102,9 @@ class StrConverter(Converter[str, wrappers_pb2.StringValue]):
     """A converter for text string types."""
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{str.__module__}.{str.__name__}"
+        return str
 
     @property
     def protobuf_message(self) -> Type[wrappers_pb2.StringValue]:
@@ -124,9 +124,9 @@ class DTDateTimeConverter(Converter[dt.datetime, timestamp_pb2.Timestamp]):
     """A converter for datetime.datetime types."""
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{dt.datetime.__module__}.{dt.datetime.__name__}"
+        return dt.datetime
 
     @property
     def protobuf_message(self) -> Type[timestamp_pb2.Timestamp]:
@@ -148,9 +148,9 @@ class DTTimeDeltaConverter(Converter[dt.timedelta, duration_pb2.Duration]):
     """A converter for datetime.timedelta types."""
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{dt.timedelta.__module__}.{dt.timedelta.__name__}"
+        return dt.timedelta
 
     @property
     def protobuf_message(self) -> Type[duration_pb2.Duration]:
@@ -168,13 +168,13 @@ def to_python_value(self, protobuf_message: duration_pb2.Duration) -> dt.timedel
         return protobuf_message.ToTimedelta()
 
 
-class BoolCollectionConverter(Converter[Collection[bool], panel_types_pb2.BoolCollection]):
+class BoolCollectionConverter(CollectionConverter[bool, panel_types_pb2.BoolCollection]):
     """A converter for a Collection of bools."""
 
     @property
-    def python_typename(self) -> str:
+    def item_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{Collection.__name__}.{bool.__module__}.{bool.__name__}"
+        return bool
 
     @property
     def protobuf_message(self) -> Type[panel_types_pb2.BoolCollection]:
@@ -190,13 +190,13 @@ def to_python_value(self, protobuf_message: panel_types_pb2.BoolCollection) -> C
         return list(protobuf_message.values)
 
 
-class BytesCollectionConverter(Converter[Collection[bytes], panel_types_pb2.ByteStringCollection]):
+class BytesCollectionConverter(CollectionConverter[bytes, panel_types_pb2.ByteStringCollection]):
     """A converter for a Collection of byte strings."""
 
     @property
-    def python_typename(self) -> str:
+    def item_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{Collection.__name__}.{bytes.__module__}.{bytes.__name__}"
+        return bytes
 
     @property
     def protobuf_message(self) -> Type[panel_types_pb2.ByteStringCollection]:
@@ -216,13 +216,13 @@ def to_python_value(
         return list(protobuf_message.values)
 
 
-class FloatCollectionConverter(Converter[Collection[float], panel_types_pb2.FloatCollection]):
+class FloatCollectionConverter(CollectionConverter[float, panel_types_pb2.FloatCollection]):
     """A converter for a Collection of floats."""
 
     @property
-    def python_typename(self) -> str:
+    def item_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{Collection.__name__}.{float.__module__}.{float.__name__}"
+        return float
 
     @property
     def protobuf_message(self) -> Type[panel_types_pb2.FloatCollection]:
@@ -242,13 +242,13 @@ def to_python_value(
         return list(protobuf_message.values)
 
 
-class IntCollectionConverter(Converter[Collection[int], panel_types_pb2.IntCollection]):
+class IntCollectionConverter(CollectionConverter[int, panel_types_pb2.IntCollection]):
     """A converter for a Collection of integers."""
 
     @property
-    def python_typename(self) -> str:
+    def item_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{Collection.__name__}.{int.__module__}.{int.__name__}"
+        return int
 
     @property
     def protobuf_message(self) -> Type[panel_types_pb2.IntCollection]:
@@ -264,13 +264,13 @@ def to_python_value(self, protobuf_message: panel_types_pb2.IntCollection) -> Co
         return list(protobuf_message.values)
 
 
-class StrCollectionConverter(Converter[Collection[str], panel_types_pb2.StringCollection]):
+class StrCollectionConverter(CollectionConverter[str, panel_types_pb2.StringCollection]):
     """A converter for a Collection of strings."""
 
     @property
-    def python_typename(self) -> str:
+    def item_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{Collection.__name__}.{str.__module__}.{str.__name__}"
+        return str
 
     @property
     def protobuf_message(self) -> Type[panel_types_pb2.StringCollection]:

src/nipanel/converters/protobuf_types.py

@@ -31,7 +31,7 @@
 from nitypes.waveform.typing import ExtendedPropertyValue
 from typing_extensions import TypeAlias
 
-from nipanel.converters import Converter
+from nipanel.converters import Converter, CollectionConverter2D
 
 _AnyScalarType: TypeAlias = Union[bool, int, float, str]
 _SCALAR_TYPE_TO_PB_ATTR_MAP = {
@@ -42,13 +42,13 @@
 }
 
 
-class Double2DArrayConverter(Converter[Collection[Collection[float]], Double2DArray]):
+class Double2DArrayConverter(CollectionConverter2D[float, Double2DArray]):
     """A converter between Collection[Collection[float]] and Double2DArray."""
 
     @property
-    def python_typename(self) -> str:
-        """The Python type that this converter handles."""
-        return f"{Collection.__name__}.{Collection.__name__}.{float.__module__}.{float.__name__}"
+    def item_type(self) -> type:
+        """The Python item type that this converter handles."""
+        return float
 
     @property
     def protobuf_message(self) -> Type[Double2DArray]:
@@ -95,9 +95,9 @@ def __init__(self) -> None:
         self._pt_converter = PrecisionTimestampConverter()
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{AnalogWaveform.__module__}.{AnalogWaveform.__name__}"
+        return AnalogWaveform
 
     @property
     def protobuf_message(self) -> Type[DoubleAnalogWaveform]:
@@ -192,9 +192,9 @@ class PrecisionTimestampConverter(Converter[bt.DateTime, PrecisionTimestamp]):
     """A converter for bintime.DateTime types."""
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{bt.DateTime.__module__}.{bt.DateTime.__name__}"
+        return bt.DateTime
 
     @property
     def protobuf_message(self) -> Type[PrecisionTimestamp]:
@@ -218,9 +218,9 @@ class ScalarConverter(Converter[Scalar[_AnyScalarType], scalar_pb2.ScalarData]):
     """A converter for Scalar objects."""
 
     @property
-    def python_typename(self) -> str:
+    def python_type(self) -> type:
         """The Python type that this converter handles."""
-        return f"{Scalar.__module__}.{Scalar.__name__}"
+        return Scalar
 
     @property
     def protobuf_message(self) -> Type[scalar_pb2.ScalarData]: