Skip to content

Type match with collections.abc.Collection and some exclusions #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 4, 2025
Merged

Type match with collections.abc.Collection and some exclusions #152

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
80698ea
Update conversion code to look for collections.abc.Collection instead…
Sep 3, 2025
37820b5
Fix is_collection to ignore certain types.
Sep 3, 2025
9bd4f59
Remove debugging code
Sep 3, 2025
07eef45
Merge from main
Sep 4, 2025
f95476f
Refactor into private global as suggested in PR feedback.
Sep 4, 2025
7f08d0c
Remove unneeded comment.
Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions src/nipanel/_convert.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

from __future__ import annotations

import enum
import logging
from collections.abc import Collection
from typing import Any, Iterable

from google.protobuf import any_pb2
from nitypes.vector import Vector
from nitypes.waveform import AnalogWaveform, ComplexWaveform

from nipanel.converters import Converter
Expand Down Expand Up @@ -73,17 +75,18 @@
VectorConverter(),
]

_CONVERTIBLE_COLLECTION_TYPES = {
frozenset,
list,
set,
tuple,
}

_CONVERTER_FOR_PYTHON_TYPE = {entry.python_typename: entry for entry in _CONVERTIBLE_TYPES}
_CONVERTER_FOR_GRPC_TYPE = {entry.protobuf_typename: entry for entry in _CONVERTIBLE_TYPES}
_SUPPORTED_PYTHON_TYPES = _CONVERTER_FOR_PYTHON_TYPE.keys()

_SKIPPED_COLLECTIONS = (
str, # Handled by StrConverter
bytes, # Handled by BytesConverter
dict, # Unsupported data type
enum.Enum, # Handled by IntConverter
Vector, # Handled by VectorConverter
)


def to_any(python_value: object) -> any_pb2.Any:
"""Convert a Python object to a protobuf Any."""
Expand All @@ -97,7 +100,7 @@ def _get_best_matching_type(python_value: object) -> str:
additional_info_string = _get_additional_type_info_string(python_value)

container_types = []
value_is_collection = any(_CONVERTIBLE_COLLECTION_TYPES.intersection(underlying_parents))
value_is_collection = _is_collection_for_convert(python_value)
# Variable to use when traversing down through collection types.
working_python_value = python_value
while value_is_collection:
Expand All @@ -119,9 +122,7 @@ def _get_best_matching_type(python_value: object) -> str:
# If this element is a collection, we want to continue traversing. Once we find a
# non-collection, underlying_parents will refer to the candidates for the non-
# collection type.
value_is_collection = any(
_CONVERTIBLE_COLLECTION_TYPES.intersection(underlying_parents)
)
value_is_collection = _is_collection_for_convert(working_python_value)
container_types.append(Collection)

best_matching_type = None
Expand Down Expand Up @@ -192,3 +193,9 @@ def _get_additional_type_info_string(python_value: object) -> str:
return str(python_value.dtype)
else:
return ""


def _is_collection_for_convert(python_value: object) -> bool:
return isinstance(python_value, Collection) and not isinstance(
python_value, _SKIPPED_COLLECTIONS
)
Loading