Added error handling for non-existent elements (#305)

Author: LucaMarconato

CHANGELOG.md

@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning][].
 -   Performance bug when plotting shapes (#298)
 -   scale parameter was ignored for single-scale images (#301)
 -   Changes to support for dask-expr (#283)
+-   Added error handling for non-existent elements (#305)
 
 ## [0.2.3] - 2024-07-03
 

src/spatialdata_plot/pl/utils.py

@@ -1472,12 +1472,12 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
 
     if element_type == "images":
         param_dict["element"] = [element] if element is not None else list(param_dict["sdata"].images.keys())
-    if element_type == "labels":
+    elif element_type == "labels":
         param_dict["element"] = [element] if element is not None else list(param_dict["sdata"].labels.keys())
-    if element_type == "shapes":
-        param_dict["element"] = [element] if element is not None else list(param_dict["sdata"].shapes.keys())
-    if element_type == "points":
+    elif element_type == "points":
         param_dict["element"] = [element] if element is not None else list(param_dict["sdata"].points.keys())
+    elif element_type == "shapes":
+        param_dict["element"] = [element] if element is not None else list(param_dict["sdata"].shapes.keys())
 
     if (channel := param_dict.get("channel")) is not None and not isinstance(channel, (list, str, int)):
         raise TypeError("Parameter 'channel' must be a string, an integer, or a list of strings or integers.")
@@ -1493,10 +1493,14 @@ def _type_check_params(param_dict: dict[str, Any], element_type: str) -> dict[st
     if (contour_px := param_dict.get("contour_px")) and not isinstance(contour_px, int):
         raise TypeError("Parameter 'contour_px' must be an integer.")
 
-    if (color := param_dict.get("color")) and element_type in ["shapes", "points", "labels"]:
+    if (color := param_dict.get("color")) and element_type in {
+        "shapes",
+        "points",
+        "labels",
+    }:
         if not isinstance(color, str):
             raise TypeError("Parameter 'color' must be a string.")
-        if element_type in ["shapes", "points"]:
+        if element_type in {"shapes", "points"}:
             if colors.is_color_like(color):
                 logger.info("Value for parameter 'color' appears to be a color, using it as such.")
                 param_dict["col_for_color"] = None
@@ -1667,6 +1671,10 @@ def _validate_label_render_params(
 
     element_params: dict[str, dict[str, Any]] = {}
     for el in param_dict["element"]:
+
+        # ensure that the element exists in the SpatialData object
+        _ = param_dict["sdata"][el]
+
         element_params[el] = {}
         element_params[el]["na_color"] = param_dict["na_color"]
         element_params[el]["cmap"] = param_dict["cmap"]
@@ -1721,6 +1729,10 @@ def _validate_points_render_params(
 
     element_params: dict[str, dict[str, Any]] = {}
     for el in param_dict["element"]:
+
+        # ensure that the element exists in the SpatialData object
+        _ = param_dict["sdata"][el]
+
         element_params[el] = {}
         element_params[el]["na_color"] = param_dict["na_color"]
         element_params[el]["cmap"] = param_dict["cmap"]
@@ -1784,6 +1796,10 @@ def _validate_shape_render_params(
 
     element_params: dict[str, dict[str, Any]] = {}
     for el in param_dict["element"]:
+
+        # ensure that the element exists in the SpatialData object
+        _ = param_dict["sdata"][el]
+
         element_params[el] = {}
         element_params[el]["fill_alpha"] = param_dict["fill_alpha"]
         element_params[el]["na_color"] = param_dict["na_color"]

tests/pl/test_render.py

@@ -28,9 +28,35 @@ def test_render_images_can_plot_multiple_cyx_images(share_coordinate_system: str
 
     if share_coordinate_system == "all":
         assert len(axs) == 1
-
-    if share_coordinate_system == "two":
+    elif share_coordinate_system == "none":
+        assert len(axs) == 3
+    elif share_coordinate_system == "two":
         assert len(axs) == 2
 
-    if share_coordinate_system == "none":
-        assert len(axs) == 3
+
+def test_keyerror_when_image_element_does_not_exist(request):
+    sdata = request.getfixturevalue("sdata_blobs")
+
+    with pytest.raises(KeyError):
+        sdata.pl.render_images(element="not_found").pl.show()
+
+
+def test_keyerror_when_label_element_does_not_exist(request):
+    sdata = request.getfixturevalue("sdata_blobs")
+
+    with pytest.raises(KeyError):
+        sdata.pl.render_labels(element="not_found").pl.show()
+
+
+def test_keyerror_when_point_element_does_not_exist(request):
+    sdata = request.getfixturevalue("sdata_blobs")
+
+    with pytest.raises(KeyError):
+        sdata.pl.render_points(element="not_found").pl.show()
+
+
+def test_keyerror_when_shape_element_does_not_exist(request):
+    sdata = request.getfixturevalue("sdata_blobs")
+
+    with pytest.raises(KeyError):
+        sdata.pl.render_shapes(element="not_found").pl.show()