scverse / scverse/spatialdata

bounding_box_query(filter_table=True) crashes if the SpatialData object contains an orphan table

Open
#1,248 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug 🚨 element: table 📑 method: query needs: triage priority: medium
Dominant language
Python
Stars
394
Forks
95
Avg merge
4d 3h
Merged PRs (30d)
7

Description

[!NOTE]
This whole message is AI-generated. The issue was automatically discovered and reported by an AI agent (Claude) during an autonomous bug hunt on the spatialdata code base. It has not been verified or triaged by a human yet; the needs: triage label is set so that a maintainer can confirm it. The reproduction script below was executed by the agent in an isolated environment (see Environment) and its output is pasted verbatim.

Summary

Found while triaging #992 (the original report there — that a query does not crop the annotating table — does not reproduce; an annotating table is cropped correctly on generated data). While building the MWE, adding a second, unrelated table to the object that has no spatialdata_attrs (e.g. an AnnData used only to carry obsm['spatial'] coordinates, never passed through TableModel.parse()) makes bounding_box_query(..., filter_table=True) (the default) crash for the entire object, even though the query does not touch that table at all. The same code path (_get_filtered_or_unfiltered_tables) is shared by polygon_query, so it is affected too.

Severity (agent's assessment): medium — a valid (if unusual) SpatialData object makes every bounding-box/polygon query crash

Where: src/spatialdata/_core/query/_utils.py::_get_filtered_or_unfiltered_tables (unconditionally calls _filter_table_by_elements on every table in sdata.tables) → src/spatialdata/_core/query/relational_query.py::_filter_table_by_elementssrc/spatialdata/models/models.py::get_table_keys, which raises ValueError: No spatialdata_attrs key found in table.uns for a table that was never parsed with TableModel.parse()/has no annotation metadata.

Expected behaviour

A table that has no spatialdata annotation metadata should either be treated as "not annotating anything" and passed through unfiltered (or dropped, with a warning), not crash the whole query. At minimum the ValueError from get_table_keys should be caught in _filter_table_by_elements/_get_filtered_or_unfiltered_tables.

Reproduction

Save as repro.py and run uv run repro.py (the PEP 723 header pins spatialdata to the commit the bug was found on; replace the URL fragment with @main to test the current main branch).

# /// script
# requires-python = ">=3.12"
# dependencies = [
#     "spatialdata @ git+https://github.com/scverse/spatialdata.git@ccf1ea048d054b6624214bf618008a9f9ae223e0",
# ]
# ///
"""#992: 'query.bounding_box not cropping the table'. With generated data: a table that annotates the queried shapes
IS cropped. Side finding: if the SpatialData object also contains an orphan table (no annotation metadata, e.g. one
that only carries obsm['spatial']), bounding_box_query(filter_table=True) crashes instead of skipping it."""
import warnings
import numpy as np
import pandas as pd
import geopandas as gpd
from anndata import AnnData
from shapely.geometry import Point
from spatialdata import SpatialData
from spatialdata.models import ShapesModel, TableModel

warnings.simplefilter("ignore")
shapes = ShapesModel.parse(gpd.GeoDataFrame({"geometry": [Point(2050, 2050), Point(5000, 5000)], "radius": [10.0, 10.0]}, index=[0, 1]))
obs = pd.DataFrame({"region": pd.Categorical(["cells"] * 2), "instance_id": [0, 1]})
annotating = TableModel.parse(AnnData(X=np.zeros((2, 1)), obs=obs), region="cells", region_key="region", instance_key="instance_id")
kwargs = dict(min_coordinate=[2000, 2000], max_coordinate=[2200, 2200], axes=("x", "y"), target_coordinate_system="global")
crop = SpatialData(shapes={"cells": shapes}, tables={"annotating": annotating}).query.bounding_box(**kwargs)
print("annotating table only -> tables after query:", {k: v.n_obs for k, v in crop.tables.items()}, "(cropped from 2 to 1 row)")
orphan = AnnData(X=np.zeros((2, 1)), obs=pd.DataFrame(index=["a", "b"]))
orphan.obsm["spatial"] = np.array([[2050, 2050], [5000, 5000]])
sdata = SpatialData(shapes={"cells": shapes}, tables={"annotating": annotating, "orphan": orphan})
try:
    crop = sdata.query.bounding_box(**kwargs)
    print("with an additional orphan table -> tables after query:", {k: v.n_obs for k, v in crop.tables.items()})
    side_bug = False
except Exception as e:  # noqa: BLE001
    print("with an additional orphan table ->", type(e).__name__, str(e)[:110])
    side_bug = True
print("VERDICT: NOT REPRODUCED for the reported symptom (an annotating table is cropped)" + ("; SIDE FINDING: an orphan table makes bounding_box_query(filter_table=True) crash" if side_bug else ""))
Observed output
annotating table only -> tables after query: {'annotating': 1} (cropped from 2 to 1 row)
with an additional orphan table -> ValueError No spatialdata_attrs key found in table.uns, therefore, no table keys found. Please parse the table.
VERDICT: NOT REPRODUCED for the reported symptom (an annotating table is cropped); SIDE FINDING: an orphan table makes bounding_box_query(filter_table=True) crash

Possible fix direction (unverified)

Wrap the get_table_keys(table) call inside _filter_table_by_elements (or the loop in _get_filtered_or_unfiltered_tables) in a try/except ValueError, treating a table without spatialdata_attrs as not matching any element (return None/skip it), optionally with a warning.

Environment

uv run repro.py with the PEP 723 metadata in the script (fresh, isolated environment; spatialdata built from main @ ccf1ea0 (2026-08-28); Python 3.13, latest releases of the dependencies at run time: pandas 3.0, anndata 0.13, zarr 3.3, dask 2026.8, numpy 2.5, geopandas 1.1, shapely 2.1). macOS (arm64).

Possibly related issues

#992


Automatically generated; discovered by an AI agent (Claude) and not yet reviewed by a human.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the provided repro.py with uv, then read _get_filtered_or_unfiltered_tables in src/spatialdata/_core/query/_utils.py and _filter_table_by_elements in src/spatialdata/_core/query/relational_query.py. Check get_table_keys in src/spatialdata/models/models.py and confirm that an orphan table no longer crashes bounding_box_query while the annotating table is still cropped; polygon_query shares the affected path.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.