Add kwargs to every method in AIDA and test that implementations allow kwargs

src/astro_image_display_api/api_test.py

@@ -1,4 +1,5 @@
 import numbers
+import os
 
 import numpy as np
 import pytest
@@ -822,3 +823,101 @@ def test_get_image(self, data):
 
         with pytest.raises(ValueError, match="[Ii]mage label.*not found"):
             self.image.get_image(image_label="not a valid label")
+
+    def test_all_methods_accept_additional_kwargs(self, data, catalog, tmp_path):
+        """
+        Make sure all methods accept additional keyword arguments
+        that are not defined in the protocol.
+        """
+        # Run in a temperature directory since we are saving an image
+        os.chdir(tmp_path)
+        from astro_image_display_api import ImageViewerInterface
+
+        all_methods_and_attributes = ImageViewerInterface.__protocol_attrs__
+
+        all_methods = [
+            method
+            for method in all_methods_and_attributes
+            if callable(getattr(self.image, method))
+        ]
+
+        # Make a small dictionary keys that are random characters
+        additional_kwargs = {k: f"value{k}" for k in ["fsda", "urioeh", "m898h]"]}
+
+        # Make a dictionary of the required arguments for any methods that have required
+        # argument
+        required_args = dict(
+            load_image=data,
+            set_cuts=(10, 100),
+            set_stretch=LogStretch(),
+            set_colormap="viridis",
+            save="test.png",
+            load_catalog=catalog,
+        )
+
+        failed_methods = []
+
+        # Take out the loading methods because they must happen first and take out
+        # remove_catalog because it must happen last.
+        all_methods = list(
+            set(all_methods) - set(["load_image", "load_catalog", "remove_catalog"])
+        )
+
+        # Load an image and a catalog first since other methods require these
+        # have been done
+        try:
+            self.image.load_image(required_args["load_image"], **additional_kwargs)
+        except TypeError as e:
+            if "required positional argument" not in str(e):
+                # If the error is not about a missing required argument, we
+                # consider it a failure.
+                failed_methods.append("load_image")
+            else:
+                raise e
+
+        try:
+            self.image.load_catalog(required_args["load_catalog"], **additional_kwargs)
+        except TypeError as e:
+            if "required positional argument" not in str(e):
+                # If the error is not about a missing required argument, we
+                # consider it a failure.
+                failed_methods.append("load_catalog")
+            else:
+                raise e
+
+        print("\n".join(all_methods))
+
+        if not failed_methods:
+            # No point in running some of these if setting image or catalog has failed.
+            # Run remove_catalog last so that it does not interfere with the
+            # other methods that require an image or catalog to be loaded.
+            for method in all_methods + ["remove_catalog"]:
+                # Call each method with the required arguments and additional kwargs
+                # Accumulate the failures and report them at the end
+                try:
+                    if method in required_args:
+                        # If the method has required arguments, call it with those
+                        getattr(self.image, method)(
+                            required_args[method], **additional_kwargs
+                        )
+                    else:
+                        # If the method does not have required arguments, just call it
+                        # with additional kwargs
+                        getattr(self.image, method)(**additional_kwargs)
+                except TypeError as e:
+                    if "required positional argument" not in str(e):
+                        # If the error is not about a missing required argument, we
+                        # consider it a failure.
+                        failed_methods.append(method)
+                    else:
+                        raise e
+
+        else:
+            failed_methods.append(
+                "No other methods were tests because the ones above failed."
+            )
+
+        assert not failed_methods, (
+            "The following methods failed when called with additional kwargs:\n\t"
+            f"{'\n\t'.join(failed_methods)}"
+        )

src/astro_image_display_api/image_viewer_logic.py

@@ -129,15 +129,24 @@ def _default_catalog_style(self) -> dict[str, Any]:
             "size": 5,
         }
 
-    def get_stretch(self, image_label: str | None = None) -> BaseStretch:
+    def get_stretch(
+        self,
+        image_label: str | None = None,
+        **kwargs,  # noqa: ARG002
+    ) -> BaseStretch:
         image_label = self._resolve_image_label(image_label)
         if image_label not in self._images:
             raise ValueError(
                 f"Image label '{image_label}' not found. Please load an image first."
             )
         return self._images[image_label].stretch
 
-    def set_stretch(self, value: BaseStretch, image_label: str | None = None) -> None:
+    def set_stretch(
+        self,
+        value: BaseStretch,
+        image_label: str | None = None,
+        **kwargs,  # noqa: ARG002
+    ) -> None:
         if not isinstance(value, BaseStretch):
             raise TypeError(
                 f"Stretch option {value} is not valid. Must be an "
@@ -150,7 +159,11 @@ def set_stretch(self, value: BaseStretch, image_label: str | None = None) -> Non
             )
         self._images[image_label].stretch = value
 
-    def get_cuts(self, image_label: str | None = None) -> tuple:
+    def get_cuts(
+        self,
+        image_label: str | None = None,
+        **kwargs,  # noqa: ARG002
+    ) -> tuple:
         image_label = self._resolve_image_label(image_label)
         if image_label not in self._images:
             raise ValueError(
@@ -162,6 +175,7 @@ def set_cuts(
         self,
         value: tuple[numbers.Real, numbers.Real] | BaseInterval,
         image_label: str | None = None,
+        **kwargs,  # noqa: ARG002
     ) -> None:
         if isinstance(value, tuple) and len(value) == 2:
             self._cuts = ManualInterval(value[0], value[1])
@@ -179,7 +193,12 @@ def set_cuts(
             )
         self._images[image_label].cuts = self._cuts
 
-    def set_colormap(self, map_name: str, image_label: str | None = None) -> None:
+    def set_colormap(
+        self,
+        map_name: str,
+        image_label: str | None = None,
+        **kwargs,  # noqa: ARG002
+    ) -> None:
         image_label = self._resolve_image_label(image_label)
         if image_label not in self._images:
             raise ValueError(
@@ -189,7 +208,11 @@ def set_colormap(self, map_name: str, image_label: str | None = None) -> None:
 
     set_colormap.__doc__ = ImageViewerInterface.set_colormap.__doc__
 
-    def get_colormap(self, image_label: str | None = None) -> str:
+    def get_colormap(
+        self,
+        image_label: str | None = None,
+        **kwargs,  # noqa: ARG002
+    ) -> str:
         image_label = self._resolve_image_label(image_label)
         if image_label not in self._images:
             raise ValueError(
@@ -201,7 +224,11 @@ def get_colormap(self, image_label: str | None = None) -> str:
 
     # The methods, grouped loosely by purpose
 
-    def get_catalog_style(self, catalog_label=None) -> dict[str, Any]:
+    def get_catalog_style(
+        self,
+        catalog_label=None,
+        **kwargs,  # noqa: ARG002
+    ) -> dict[str, Any]:
         """
         Get the style for the catalog.
 
@@ -295,6 +322,7 @@ def load_image(
         self,
         file: str | os.PathLike | ArrayLike | NDData,
         image_label: str | None = None,
+        **kwargs,  # noqa: ARG002
     ) -> None:
         """
         Load a FITS file into the viewer.
@@ -333,15 +361,20 @@ def load_image(
         # working with the new image.
         self._wcs = self._images[image_label].wcs
 
-    def get_image(self, image_label: str | None = None):
+    def get_image(
+        self, image_label: str | None = None, **kwargs  # noqa: ARG002
+    ) -> ArrayLike | NDData | CCDData:
         image_label = self._resolve_image_label(image_label)
         if image_label not in self._images:
             raise ValueError(
                 f"Image label '{image_label}' not found. Please load an image first."
             )
         return self._images[image_label].data
 
-    def get_image_labels(self):
+    def get_image_labels(
+        self,
+        **kwargs,  # noqa: ARG002
+    ) -> tuple[str, ...]:
         return tuple(self._images.keys())
 
     def _determine_largest_dimension(self, shape: tuple[int, int]) -> int:
@@ -458,7 +491,12 @@ def _load_asdf(self, asdf_file: str | os.PathLike, image_label: str | None) -> N
         )
 
     # Saving contents of the view and accessing the view
-    def save(self, filename: str | os.PathLike, overwrite: bool = False) -> None:
+    def save(
+        self,
+        filename: str | os.PathLike,
+        overwrite: bool = False,
+        **kwargs,  # noqa: ARG002
+    ) -> None:
         """
         Save the current view to a file.
 
@@ -490,6 +528,7 @@ def load_catalog(
         use_skycoord: bool = False,
         catalog_label: str | None = None,
         catalog_style: dict | None = None,
+        **kwargs,  # noqa: ARG002
     ) -> None:
         try:
             coords = table[skycoord_colname]
@@ -549,7 +588,11 @@ def load_catalog(
 
     load_catalog.__doc__ = ImageViewerInterface.load_catalog.__doc__
 
-    def remove_catalog(self, catalog_label: str | None = None) -> None:
+    def remove_catalog(
+        self,
+        catalog_label: str | None = None,
+        **kwargs,  # noqa: ARG002
+    ) -> None:
         """
         Remove markers from the image.
 
@@ -584,6 +627,7 @@ def get_catalog(
         y_colname: str = "y",
         skycoord_colname: str = "coord",
         catalog_label: str | None = None,
+        **kwargs,  # noqa: ARG002
     ) -> Table:
         # Dostring is copied from the interface definition, so it is not
         # duplicated here.
@@ -603,7 +647,10 @@ def get_catalog(
 
     get_catalog.__doc__ = ImageViewerInterface.get_catalog.__doc__
 
-    def get_catalog_names(self) -> list[str]:
+    def get_catalog_names(
+        self,
+        **kwargs,  # noqa: ARG002
+    ) -> list[str]:
         return list(self._user_catalog_labels())
 
     get_catalog_names.__doc__ = ImageViewerInterface.get_catalog_names.__doc__
@@ -614,6 +661,7 @@ def set_viewport(
         center: SkyCoord | tuple[numbers.Real, numbers.Real] | None = None,
         fov: Quantity | numbers.Real | None = None,
         image_label: str | None = None,
+        **kwargs,  # noqa: ARG002
     ) -> None:
         image_label = self._resolve_image_label(image_label)
 
@@ -685,7 +733,10 @@ def set_viewport(
     set_viewport.__doc__ = ImageViewerInterface.set_viewport.__doc__
 
     def get_viewport(
-        self, sky_or_pixel: str | None = None, image_label: str | None = None
+        self,
+        sky_or_pixel: str | None = None,
+        image_label: str | None = None,
+        **kwargs,  # noqa: ARG002
     ) -> dict[str, Any]:
         if sky_or_pixel not in (None, "sky", "pixel"):
             raise ValueError("sky_or_pixel must be 'sky', 'pixel', or None.")