Skip to content
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.

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

Added str_list to annotation_util to handle None for Matlab #914

Merged
merged 3 commits into from
Apr 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions hed/models/tabular_input.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,7 @@ def get_column_refs(self):
if self._sidecar:
return self._sidecar.get_column_refs()
return []

def get_sidecar(self):
"""Return the sidecar associated with this TabularInput."""
return self._sidecar
16 changes: 15 additions & 1 deletion hed/tools/analysis/annotation_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ def str_to_tabular(tsv_str, sidecar=None):

Parameters:
tsv_str (str): A string representing a tabular input.
sidecar (Sidecar): An optional Sidecar object.
sidecar (Sidecar, str, File or File-like): An optional Sidecar object.

Returns:
TabularInput: Represents a tabular input object.
Expand Down Expand Up @@ -208,6 +208,20 @@ def strs_to_sidecar(sidecar_strings):
return None


def to_strlist(obj_list):
""" Return a list with the objects converted to string except for None elements.

Parameters:
obj_list (list): A list of objects that are None or have a str method.

Returns:
list: A list with the objects converted to strings -- except None values are preserved.
"""

# Using list comprehension to convert non-None items to strings
return [str(item) if item is not None else None for item in obj_list]


def _flatten_cat_col(col_key, col_dict):
""" Flatten a sidecar entry corresponding to a categorical column.

Expand Down
25 changes: 21 additions & 4 deletions tests/tools/analysis/test_annotation_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@
from hed import schema as hedschema
from hed.errors import HedFileError
from hed.models.sidecar import Sidecar
from hed.tools.analysis.annotation_util import check_df_columns, df_to_hed, extract_tags,\
hed_to_df, merge_hed_dict, strs_to_sidecar, str_to_tabular
from hed.models.hed_string import HedString
from hed.models.tabular_input import TabularInput
from hed.tools.analysis.annotation_util import check_df_columns, df_to_hed, extract_tags, \
hed_to_df, merge_hed_dict, strs_to_sidecar, str_to_tabular, to_strlist
from hed.tools.analysis.annotation_util import _flatten_cat_col, _flatten_val_col, _get_value_entry, _tag_list_to_str, \
_update_cat_dict, generate_sidecar_entry
# from hed.tools.analysis.annotation_util import _find_last_pos, _find_first_pos, trim_back, trim_front
from hed.tools.analysis.tabular_summary import TabularSummary
from hed.tools.util.io_util import get_file_list

Expand Down Expand Up @@ -307,7 +308,23 @@ def test_strs_to_tabular(self):
with open(self.events_path, 'r') as file:
events_contents = file.read()
tab_in = str_to_tabular(events_contents, sidecar=self.json_path)

self.assertIsInstance(tab_in, TabularInput)

def test_convert_to_strlist(self):
# schema
# list1 = [HedString('Red, Sensory-event', schema)]
list1 = ['abc', '', None, 3.24]
str_list1 = to_strlist(list1)
self.assertEqual(len(str_list1), len(list1))
self.assertIsNone(str_list1[2], None)
self.assertEqual(str_list1[3], '3.24')
self.assertFalse(str_list1[1])
list2 = [HedString('Red, Sensory-event', self.hed_schema), None, HedString('', self.hed_schema)]
str_list2 = to_strlist(list2)
self.assertEqual(len(str_list2), len(list2))
self.assertIsNone(str_list2[1], None)
self.assertEqual(str_list2[0], 'Red,Sensory-event')
self.assertEqual(str_list2[2], '')

def test_flatten_cat_col(self):
col1 = self.sidecar2c["a"]
Expand Down
Loading