initial tests multi_table design (#405)

* initial tests multi_table design

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add mock new table

* create test class and cleanup

* additional cleanup

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* additional cleanup

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add pseudo methods

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

tests/conftest.py

@@ -2,6 +2,8 @@
 
 # isort: off
 import os
+from typing import Any
+from collections.abc import Sequence
 
 os.environ["USE_PYGEOS"] = "0"
 # isort:on
@@ -288,6 +290,11 @@ def _get_table(
     return TableModel.parse(adata=adata, region=region, region_key=region_key, instance_key=instance_key)
 
 
+def _get_new_table(spatial_element: None | str | Sequence[str], instance_id: None | Sequence[Any]) -> AnnData:
+    adata = AnnData(np.random.default_rng().random(10, 20000))
+    return TableModel.parse(adata=adata, spatial_element=spatial_element, instance_id=instance_id)
+
+
 @pytest.fixture()
 def labels_blobs() -> ArrayLike:
     """Create a 2D labels."""

tests/io/test_multi_table.py

@@ -0,0 +1,197 @@
+from pathlib import Path
+
+import anndata as ad
+import numpy as np
+from anndata import AnnData
+from spatialdata import SpatialData
+
+from tests.conftest import _get_new_table, _get_shapes
+
+# notes on paths: https://github.com/orgs/scverse/projects/17/views/1?pane=issue&itemId=44066734
+# notes for the people (to prettify) https://hackmd.io/wd7K4Eg1SlykKVN-nOP44w
+
+# shapes
+test_shapes = _get_shapes()
+instance_id = np.array([str(i) for i in range(5)])
+table = _get_new_table(spatial_element="test_shapes", instance_id=instance_id)
+adata0 = _get_new_table()
+adata1 = _get_new_table()
+
+
+# shuffle the indices of the dataframe
+np.random.default_rng().shuffle(test_shapes["poly"].index)
+
+# tables is a dict
+SpatialData.tables
+
+# def get_table_keys(sdata: SpatialData) -> tuple[list[str], str, str]:
+#     d = sdata.table.uns[sd.models.TableModel.ATTRS_KEY]
+#     return d['region'], d['region_key'], d['instance_key']
+#
+# @staticmethod
+# def SpatialData.get_key_column(table: AnnData, key_column: str) -> ...:
+#     region, region_key, instance_key = sd.models.get_table_keys()
+#     if key_clumns == 'region_key':
+#     return table.obs[region_key]
+# else: ....
+#
+# @staticmethod
+# def SpatialData.get_region_key_column(table: AnnData | str):
+# return get_key_column(...)
+
+# @staticmethod
+# def SpatialData.get_instance_key_column(table: AnnData | str):
+# return get_key_column(...)
+
+# we need also the two set_...() functions
+
+
+def get_annotation_target_of_table(table: AnnData) -> pd.Series:
+    return SpatialData.get_region_key_column(table)
+
+
+def set_annotation_target_of_table(table: AnnData, spatial_element: str | pd.Series) -> None:
+    SpatialData.set_instance_key_column(table, spatial_element)
+
+
+class TestMultiTable:
+    def test_set_get_tables_from_spatialdata(self, sdata):  # sdata is form conftest
+        sdata["my_new_table0"] = adata0
+        sdata["my_new_table1"] = adata1
+
+    def test_old_accessor_deprecation(self, sdata):
+        # assume no table is present
+        # this prints a deprecation warning
+        sdata.table = adata0  # this gets placed in sdata['table']
+        # this prints a deprecation warning
+        _ = sdata.table  # this returns sdata['table']
+        # this prints a deprecation waring
+        del sdata.table
+
+        sdata["my_new_table0"] = adata0
+        # will fail, because there is no sdata['table'], even if another table is present
+        _ = sdata.table
+
+    def test_single_table(self, tmp_path: str):
+        # shared table
+        tmpdir = Path(tmp_path) / "tmp.zarr"
+
+        test_sdata = SpatialData(
+            shapes={
+                "test_shapes": test_shapes["poly"],
+            },
+            tables={"shape_annotate": table},
+        )
+        test_sdata.write(tmpdir)
+        sdata = SpatialData.read(tmpdir)
+        assert sdata.get("segmentation")
+        assert isinstance(sdata["segmentation"], AnnData)
+        from anndata.tests.helpers import assert_equal
+
+        assert assert_equal(test_sdata["segmentation"], sdata["segmentation"])
+
+        # note (to keep in the code): these tests here should silmulate the interactions from teh users; if the syntax
+        # here we are matching the table to the shapes and viceversa (= subset + reordeing)
+        # there is already a function to do one of these two join operations which is match_table_to_element()
+        # is too verbose/complex we need to adjust the internals to make it smoother
+        # # use case example 1
+        # # sorting the shapes to match the order of the table
+        # alternatively, we can have a helper function (join, and simpler ones "match_table_to_element()"
+        # "match_element_to_table()", "match_annotations_order(...)", "mathc_reference_eleemnt_order??(...)")
+        # sdata["visium0"][SpatialData.get_instance_key_column(sdata.table['visium0'])]
+        # assert ...
+        # # use case example 2
+        # # sorting the table to match the order of the shapes
+        # sdata.table.obs.set_index(keys=["__instance_id__"])
+        # sdata.table.obs[sdata["visium0"]]
+        # assert ...
+
+    def test_paired_elements_tables(self, tmp_path: str):
+        pass
+
+    def test_elements_transfer_annotation(self, tmp_path: str):
+        test_sdata = SpatialData(
+            shapes={"test_shapes": test_shapes["poly"], "test_multipoly": test_shapes["multipoly"]},
+            tables={"segmentation": table},
+        )
+        set_annotation_target_of_table(test_sdata["segmentation"], "test_multipoly")
+        assert get_annotation_target_of_table(test_sdata["segmentation"]) == "test_multipoly"
+
+    def test_single_table_multiple_elements(self, tmp_path: str):
+        tmpdir = Path(tmp_path) / "tmp.zarr"
+
+        test_sdata = SpatialData(
+            shapes={
+                "test_shapes": test_shapes["poly"],
+                "test_multipoly": test_shapes["multi_poly"],
+            },
+            tables={"segmentation": table},
+        )
+        test_sdata.write(tmpdir)
+        # sdata = SpatialData.read(tmpdir)
+
+        # # use case example 1
+        # # sorting the shapes visium0 to match the order of the table
+        # sdata["visium0"][sdata.table.obs["__instance_id__"][sdata.table.obs["__spatial_element__"] == "visium0"]]
+        # assert ...
+        # # use case example 2
+        # # subsetting and sorting the table to match the order of the shapes visium0
+        # sub_table = sdata.table[sdata.table.obs["__spatial_element"] == "visium0"]
+        # sub_table.set_index(keys=["__instance_id__"])
+        # sub_table.obs[sdata["visium0"]]
+        # assert ...
+
+    def test_concatenate_tables(self):
+        table_two = _get_new_table(spatial_element="test_multipoly", instance_id=np.array([str(i) for i in range(2)]))
+        concatenated_table = ad.concat([table, table_two])
+        test_sdata = SpatialData(
+            shapes={
+                "test_shapes": test_shapes["poly"],
+                "test_multipoly": test_shapes["multi_poly"],
+            },
+            tables={"segmentation": concatenated_table},
+        )
+        # use case tests as above (we test only visium0)
+
+    def test_multiple_table_without_element(self):
+        table = _get_new_table()
+        table_two = _get_new_table()
+
+        test_sdata = SpatialData(
+            tables={"table": table, "table_two": table_two},
+        )
+
+    def test_multiple_tables_same_element(self, tmp_path: str):
+        tmpdir = Path(tmp_path) / "tmp.zarr"
+        table_two = _get_new_table(spatial_element="test_shapes", instance_id=instance_id)
+
+        test_sdata = SpatialData(
+            shapes={
+                "test_shapes": test_shapes["poly"],
+            },
+            tables={"segmentation": table, "segmentation_two": table_two},
+        )
+        test_sdata.write(tmpdir)
+
+
+#
+#     # these use cases could be the preferred one for the users; we need to choose one/two preferred ones (either this, either helper function, ...)
+#     # use cases
+#     # use case example 1
+#     # sorting the shapes to match the order of the table
+#     sdata["visium0"][sdata.table.obs["__instance_id__"]]
+#     assert ...
+#     # use case example 2
+#     # sorting the table to match the order of the shapes
+#     sdata.table.obs.set_index(keys=["__instance_id__"])
+#     sdata.table.obs[sdata["visium0"]]
+#     assert ...
+#
+# def test_partial_match():
+#     # the function spatialdata._core.query.relational_query.match_table_to_element(no s) needs to be modified (will be
+#     # simpler), we need also a function match_element_to_table. Maybe we can have just one function doing both the
+#     things,
+#     # called match_table_and_elements test that tables and elements do not need to have the same indices
+#     pass
+#     # the test would check that we cna call SpatiaLData() on such combinations of mismatching elements and that the
+#     # match_table_to_element-like functions return the correct subset of the data