Combine load_ methods into single load method

Author: mwcraig

src/astro_image_display_api/dummy_viewer.py

@@ -125,7 +125,7 @@ def cursor(self, value: str) -> None:
     # The methods, grouped loosely by purpose
 
     # Methods for loading data
-    def load_fits(self, file: str | os.PathLike) -> None:
+    def load(self, file: str | os.PathLike | ArrayLike | NDData) -> None:
         """
         Load a FITS file into the viewer.
 
@@ -135,6 +135,15 @@ def load_fits(self, file: str | os.PathLike) -> None:
             The FITS file to load. If a string, it can be a URL or a
             file path.
         """
+        if isinstance(file, (str, os.PathLike)):
+            self._load_fits(file)
+        elif isinstance(file, NDData):
+            self._load_nddata(file)
+        else:
+            # Assume it is a 2D array
+            self._load_array(file)
+
+    def _load_fits(self, file: str | os.PathLike) -> None:
         ccd = CCDData.read(file)
         self._wcs = ccd.wcs
         self.image_height, self.image_width = ccd.shape
@@ -143,7 +152,7 @@ def load_fits(self, file: str | os.PathLike) -> None:
         self.zoom_level = 1.0
         self.center_on((self.image_width / 2, self.image_height / 2))
 
-    def load_array(self, array: ArrayLike) -> None:
+    def _load_array(self, array: ArrayLike) -> None:
         """
         Load a 2D array into the viewer.
 
@@ -159,7 +168,7 @@ def load_array(self, array: ArrayLike) -> None:
         self.center_on((self.image_width / 2, self.image_height / 2))
 
 
-    def load_nddata(self, data: NDData) -> None:
+    def _load_nddata(self, data: NDData) -> None:
         """
         Load an `astropy.nddata.NDData` object into the viewer.
 

src/astro_image_display_api/interface_definition.py

@@ -57,41 +57,19 @@ class ImageViewerInterface(Protocol):
 
     # The methods, grouped loosely by purpose
 
-    # Methods for loading data
+    # Method for loading data
     @abstractmethod
-    def load_fits(self, file: str | os.PathLike) -> None:
+    def load(self, data: Any) -> None:
         """
-        Load a FITS file into the viewer.
+        Load data into the viewer. At a minimum, this should allow a FITS file
+        to be loaded. Viewers may allow additional data types to be loaded, such as
+        2D arrays or `astropy.nddata.NDData` objects.
 
         Parameters
         ----------
-        file : str or `astropy.io.fits.HDU`
-            The FITS file to load. If a string, it can be a URL or a
-            file path.
-        """
-        raise NotImplementedError
-
-    @abstractmethod
-    def load_array(self, array: ArrayLike) -> None:
-        """
-        Load a 2D array into the viewer.
-
-        Parameters
-        ----------
-        array : array-like
-            The array to load.
-        """
-        raise NotImplementedError
-
-    @abstractmethod
-    def load_nddata(self, data: NDData) -> None:
-        """
-        Load an `astropy.nddata.NDData` object into the viewer.
-
-        Parameters
-        ----------
-        data : `astropy.nddata.NDData`
-            The NDData object to load.
+        data : Any
+            The data to load. This can be a FITS file, a 2D array,
+            or an `astropy.nddata.NDData` object.
         """
         raise NotImplementedError
 

src/astro_image_display_api/widget_api_test.py

@@ -78,19 +78,12 @@ def test_width_height(self):
         assert self.image.image_width == width
         assert self.image.image_height == height
 
-    def test_load_fits(self, data, tmp_path):
+    def test_load(self, data, tmp_path):
         hdu = fits.PrimaryHDU(data=data)
         image_path = tmp_path / 'test.fits'
         hdu.header["BUNIT"] = "adu"
         hdu.writeto(image_path)
-        self.image.load_fits(image_path)
-
-    def test_load_nddata(self, data):
-        nddata = NDData(data)
-        self.image.load_nddata(nddata)
-
-    def test_load_array(self, data):
-        self.image.load_array(data)
+        self.image.load(image_path)
 
     def test_center_on(self):
         self.image.center_on((10, 10))  # X, Y
@@ -102,7 +95,8 @@ def test_offset_by(self, data, wcs):
         # have) taken care of setting up the WCS internally if initialized with
         # an NDData that has a WCS.
         ndd = NDData(data=data, wcs=wcs)
-        self.image.load_nddata(ndd)
+        # TODO: THIS WOULD FAIL ON A VIEWER THAT DOES NOT ALLOW NDDATA OR ARRAY LOADING
+        self.image.load(ndd)
 
         self.image.offset_by(10 * u.arcmin, 10 * u.arcmin)
 
@@ -116,7 +110,8 @@ def test_offset_by(self, data, wcs):
 
     def test_zoom_level(self, data):
         # Set data first, since that is needed to determine zoom level
-        self.image.load_array(data)
+        # TODO: THIS WOULD FAIL ON A VIEWER THAT DOES NOT ALLOW NDDATA OR ARRAY LOADING
+        self.image.load(data)
         self.image.zoom_level = 5
         assert self.image.zoom_level == 5
 
@@ -310,7 +305,8 @@ def test_remove_marker_accepts_list(self):
 
     def test_adding_markers_as_world(self, data, wcs):
         ndd = NDData(data=data, wcs=wcs)
-        self.image.load_nddata(ndd)
+        # TODO: THIS WOULD FAIL ON A VIEWER THAT DOES NOT ALLOW NDDATA OR ARRAY LOADING
+        self.image.load(ndd)
 
         # Add markers using world coordinates
         pixels = np.linspace(0, 100, num=10).reshape(5, 2)
@@ -356,7 +352,8 @@ def test_cuts(self, data):
         assert 'histogram' in self.image.autocut_options
 
         # Setting using histogram requires data
-        self.image.load_array(data)
+        # TODO: THIS WOULD FAIL ON A VIEWER THAT DOES NOT ALLOW NDDATA OR ARRAY LOADING
+        self.image.load(data)
         self.image.cuts = 'histogram'
         assert len(self.image.cuts) == 2