add warnings for ragged inputs to table

hdmf-dev · Mar 6, 2024 · 9f7011f · 9f7011f
1 parent a147f3b
commit 9f7011f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 13 deletions.
diff --git a/src/hdmf/common/table.py b/src/hdmf/common/table.py
@@ -710,7 +710,8 @@ def add_row(self, **kwargs):
             else:
                 c.add_row(data[colname])
                 if is_ragged(c.data):
-                    raise ValueError("Data is ragged. Use the 'index' argument when creating a column that will have ragged data.")
+                    warn("Data is ragged. Use the 'index' argument when creating a column that will have ragged data.",
+                         stacklevel=2)
 
     def __eq__(self, other):
         """Compare if the two DynamicTables contain the same data.
@@ -828,7 +829,8 @@ def add_column(self, **kwargs):  # noqa: C901
 
             # if no index was provided, check that data is not ragged
             if index is False and is_ragged(data):
-                raise ValueError("Data is ragged. Use the 'index' argument when adding a column with ragged data.")
+                warn("Data is ragged. Use the 'index' argument when adding a column with ragged data.",
+                     stacklevel=2)
 
             # Check that we are asked to create an index
             if (isinstance(index, bool) or isinstance(index, int)) and index > 0 and len(data) > 0:

diff --git a/tests/unit/common/test_table.py b/tests/unit/common/test_table.py
@@ -370,16 +370,16 @@ def test_add_column_without_required_index(self):
         multi_nested_data = [[[1, 2, 3], [1, 2, 3, 4]], [1, 2]]
         arr_data = np.array([[1, 2, 3], [1, 2, 3, 4]], dtype='object')
 
-        with self.assertRaisesWith(ValueError, msg):
-            table.add_column(name='qux', description='qux column', data=lol_data,)
-        with self.assertRaisesWith(ValueError, msg):
-            table.add_column(name='qux', description='qux column', data=str_data,)
-        with self.assertRaisesWith(ValueError, msg):
-            table.add_column(name='qux', description='qux column', data=empty_data,)
-        with self.assertRaisesWith(ValueError, msg):
-            table.add_column(name='qux', description='qux column', data=multi_nested_data,)
-        with self.assertRaisesWith(ValueError, msg):
-            table.add_column(name='qux', description='qux column', data=arr_data,)
+        with self.assertWarnsWith(UserWarning, msg):
+            table.add_column(name='col1', description='', data=lol_data,)
+        with self.assertWarnsWith(UserWarning, msg):
+            table.add_column(name='col2', description='', data=str_data,)
+        with self.assertWarnsWith(UserWarning, msg):
+            table.add_column(name='col3', description='', data=empty_data,)
+        with self.assertWarnsWith(UserWarning, msg):
+            table.add_column(name='col4', description='', data=multi_nested_data,)
+        with self.assertWarnsWith(UserWarning, msg):
+            table.add_column(name='col5', description='', data=arr_data,)
 
     def test_add_row_without_required_index(self):
         """
@@ -389,7 +389,7 @@ def test_add_row_without_required_index(self):
         table.add_column(name='qux', description='qux column')
         table.add_row(foo=5, bar=50.0, baz='lizard', qux=[1, 2, 3])
         msg = "Data is ragged. Use the 'index' argument when creating a column that will have ragged data."
-        with self.assertRaisesWith(ValueError, msg):
+        with self.assertWarnsWith(UserWarning, msg):
             table.add_row(foo=5, bar=50.0, baz='lizard', qux=[1, 2, 3 ,4])
 
     def test_add_column_auto_index_int(self):