Skip to content

fix: point table validation to public sanitizer #1165

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

Open
stanbot8 wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −1
Open

fix: point table validation to public sanitizer #1165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/spatialdata/_core/validation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ def __exit__(
# Exceptions were collected that we want to raise as a combined validation error.
if self._collector.errors:
raise ValidationError(
title=self._message + "\nTo fix, run `spatialdata.utils.sanitize_table(adata)`.",
title=self._message + "\nTo fix, run `spatialdata.sanitize_table(adata)`.",
errors=self._collector.errors,
)
return True
13 changes: 13 additions & 0 deletions tests/models/test_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from spatial_image import to_spatial_image
from xarray import DataArray, DataTree

import spatialdata
from spatialdata._core.spatialdata import SpatialData
from spatialdata._core.validation import ValidationError
from spatialdata._types import ArrayLike
Expand Down Expand Up @@ -624,6 +625,18 @@ def test_table_model_invalid_names(self, key: str, attr: str, parse: bool):
else:
TableModel.validate(adata)

def test_table_model_invalid_name_suggests_public_sanitizer(self):
adata = AnnData(np.array([[0]]), uns={"invalid name": {}})

with pytest.raises(
ValidationError,
match=r"`spatialdata\.sanitize_table\(adata\)`",
):
TableModel.validate(adata)

spatialdata.sanitize_table(adata)
TableModel.validate(adata)

@pytest.mark.parametrize(
"keys",
[
Expand Down