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.

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

Forbid slashes in names of Groups and Datasets #1219

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Forbid slashes in names of Groups and Datasets #1219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
761378a
* add checks to ensure that name and default name args do not contain…
bendichter Dec 12, 2024
578dba2
ruff
bendichter Dec 12, 2024
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
6 changes: 6 additions & 0 deletions src/hdmf/spec/spec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,12 +310,18 @@ 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
View file
Open in desktop
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')
Loading