From 761378a1010f5cc29bb0373cb59f6d394be6654d Mon Sep 17 00:00:00 2001 From: Ben Dichter Date: Thu, 12 Dec 2024 15:05:25 +0300 Subject: [PATCH] * add checks to ensure that name and default name args do not contain slashes. * include tests --- src/hdmf/spec/spec.py | 4 ++++ tests/unit/spec_tests/test_dataset_spec.py | 14 ++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/src/hdmf/spec/spec.py b/src/hdmf/spec/spec.py index d5adf6b5e..4cdb67583 100644 --- a/src/hdmf/spec/spec.py +++ b/src/hdmf/spec/spec.py @@ -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: diff --git a/tests/unit/spec_tests/test_dataset_spec.py b/tests/unit/spec_tests/test_dataset_spec.py index c9db14635..60025fd7e 100644 --- a/tests/unit/spec_tests/test_dataset_spec.py +++ b/tests/unit/spec_tests/test_dataset_spec.py @@ -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')