Skip to content

Commit

Permalink
* add checks to ensure that name and default name args do not contain…
Browse files Browse the repository at this point in the history
… slashes.

* include tests
  • Loading branch information
bendichter committed Dec 12, 2024
1 parent d1d1b5a commit 761378a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/hdmf/spec/spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -310,12 +310,16 @@ class BaseStorageSpec(Spec):
def __init__(self, **kwargs):
name, doc, quantity, attributes, linkable, data_type_def, data_type_inc = \
getargs('name', 'doc', 'quantity', 'attributes', 'linkable', 'data_type_def', 'data_type_inc', kwargs)
if name is not None and "/" in name:
raise ValueError(f"Name '{name}' is invalid. Names of Groups and Datasets cannot contain '/'")
if name is None and data_type_def is None and data_type_inc is None:
raise ValueError("Cannot create Group or Dataset spec with no name "
"without specifying '%s' and/or '%s'." % (self.def_key(), self.inc_key()))
super().__init__(doc, name=name)
default_name = getargs('default_name', kwargs)
if default_name:
if "/" in default_name:
raise ValueError(f"Default name '{default_name}' is invalid. Names of Groups and Datasets cannot contain '/'")
if name is not None:
warn("found 'default_name' with 'name' - ignoring 'default_name'")
else:
Expand Down
14 changes: 14 additions & 0 deletions tests/unit/spec_tests/test_dataset_spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -261,3 +261,17 @@ def test_build_warn_extra_args(self):
"'dtype': 'int', 'required': True}")
with self.assertWarnsWith(UserWarning, msg):
DatasetSpec.build_spec(spec_dict)

def test_constructor_validates_name(self):
with self.assertRaisesWith(
ValueError,
"Name 'one/two' is invalid. Names of Groups and Datasets cannot contain '/'",
):
DatasetSpec(doc='my first dataset', dtype='int', name='one/two')

def test_constructor_validates_default_name(self):
with self.assertRaisesWith(
ValueError,
"Default name 'one/two' is invalid. Names of Groups and Datasets cannot contain '/'",
):
DatasetSpec(doc='my first dataset', dtype='int', default_name='one/two', data_type_def='test')

0 comments on commit 761378a

Please sign in to comment.