Add ruff and address miscellaneous ruff issues

Author: mwcraig

.pre-commit-config.yaml

@@ -23,6 +23,17 @@ repos:
       - id: mixed-line-ending
         # Makes all line endings unix-style
         args: [--fix=lf]
+
+
+# Per the ruff documentation, this should be before black
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.11.13
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [--fix]
+
 -   repo: https://github.com/psf/black
     rev: 25.1.0
     hooks:

pyproject.toml

@@ -66,3 +66,22 @@ exclude_lines = [
   "if __name__ == .__main__.:",
   "if TYPE_CHECKING:",
 ]
+
+[tool.black]
+line-length = 88
+
+[tool.ruff]
+# ruff 0.6.0 started automatically linting notebooks. We are not ready for that yet.
+extend-exclude = ["*.ipynb"]
+
+[tool.ruff.lint]
+select = [
+    "E",    # E and W are the checks done by pycodestyle
+    "W",
+    "F",    # pyflakes checks
+    "ARG",  # flake8-unused-arguments
+    "UP",   # language updates
+    "NPY",  # check for numpy deprecations
+    "I",    # isort checks
+    "B",    # flake8-bugbear
+]

src/astro_image_display_api/dummy_viewer.py

@@ -11,15 +11,15 @@
 from astropy.nddata import CCDData, NDData
 from astropy.table import Table, vstack
 from astropy.units import Quantity
-from astropy.wcs import WCS
-from astropy.wcs.utils import proj_plane_pixel_scales
 from astropy.visualization import (
     AsymmetricPercentileInterval,
     BaseInterval,
     BaseStretch,
     LinearStretch,
     ManualInterval,
 )
+from astropy.wcs import WCS
+from astropy.wcs.utils import proj_plane_pixel_scales
 from numpy.typing import ArrayLike
 
 from .interface_definition import ImageViewerInterface
@@ -114,7 +114,8 @@ def _resolve_catalog_label(self, catalog_label: str | None) -> str:
                     catalog_label = user_keys[0]
                 case _:
                     raise ValueError(
-                        "Multiple catalog styles defined. Please specify a catalog_label to get the style."
+                        "Multiple catalog styles defined. Please specify a "
+                        "catalog_label to get the style."
                     )
 
         return catalog_label
@@ -141,7 +142,8 @@ def get_stretch(self, image_label: str | None = None) -> BaseStretch:
     def set_stretch(self, value: BaseStretch, image_label: str | None = None) -> None:
         if not isinstance(value, BaseStretch):
             raise TypeError(
-                f"Stretch option {value} is not valid. Must be an Astropy.visualization Stretch object."
+                f"Stretch option {value} is not valid. Must be an "
+                "`astropy.visualization` Stretch object."
             )
         image_label = self._resolve_image_label(image_label)
         if image_label not in self._images:
@@ -169,7 +171,8 @@ def set_cuts(
             self._cuts = value
         else:
             raise TypeError(
-                "Cuts must be an Astropy.visualization Interval object or a tuple of two values."
+                "Cuts must be an Astropy.visualization Interval object or a tuple "
+                "of two values."
             )
         image_label = self._resolve_image_label(image_label)
         if image_label not in self._images:
@@ -206,7 +209,8 @@ def cursor(self) -> str:
     def cursor(self, value: str) -> None:
         if value not in self.ALLOWED_CURSOR_LOCATIONS:
             raise ValueError(
-                f"Cursor location {value} is not valid. Must be one of {self.ALLOWED_CURSOR_LOCATIONS}."
+                f"Cursor location {value} is not valid. Must be one of "
+                f"{self.ALLOWED_CURSOR_LOCATIONS}."
             )
         self._cursor = value
 
@@ -296,7 +300,8 @@ def _resolve_image_label(self, image_label: str | None) -> str:
                     image_label = user_keys[0]
                 case _:
                     raise ValueError(
-                        "Multiple image labels defined. Please specify a image_label to get the style."
+                        "Multiple image labels defined. Please specify a image_label "
+                        "to get the style."
                     )
 
         return image_label
@@ -324,9 +329,9 @@ def load_image(
         if image_label in self._images:
             del self._images[image_label]
 
-        if isinstance(file, (str, os.PathLike)):
+        if isinstance(file, str | os.PathLike):
             if isinstance(file, str):
-                is_adsf = file.endswith(".asdf")
+                is_asdf = file.endswith(".asdf")
             else:
                 is_asdf = file.suffix == ".asdf"
             if is_asdf:
@@ -567,8 +572,8 @@ def remove_catalog(self, catalog_label: str | None = None) -> None:
 
         try:
             del self._catalogs[catalog_label]
-        except KeyError:
-            raise ValueError(f"Catalog label {catalog_label} not found.")
+        except KeyError as err:
+            raise ValueError(f"Catalog label {catalog_label} not found.") from err
 
     def get_catalog(
         self,
@@ -623,11 +628,12 @@ def set_viewport(
             fov = current_viewport.fov
 
         # If either center or fov is None these checks will raise an appropriate error
-        if not isinstance(center, (SkyCoord, tuple)):
+        if not isinstance(center, SkyCoord | tuple):
             raise TypeError(
-                "Invalid value for center. Center must be a SkyCoord or tuple of (X, Y)."
+                "Invalid value for center. Center must be a SkyCoord or tuple "
+                "of (X, Y)."
             )
-        if not isinstance(fov, (Quantity, numbers.Real)):
+        if not isinstance(fov, Quantity | numbers.Real):
             raise TypeError(
                 "Invalid value for fov. fov must be an angular Quantity or float."
             )
@@ -640,8 +646,9 @@ def set_viewport(
         # Check that the center and fov are compatible with the current image
         if self._images[image_label].wcs is None:
             if current_viewport.center is not None:
-                # If there is a WCS either input is fine. If there is no WCS then we only
-                # check wther the new center is the same type as the current center.
+                # If there is a WCS either input is fine. If there is no WCS then we
+                # only check wther the new center is the same type as the
+                # current center.
                 if isinstance(center, SkyCoord) and not isinstance(
                     current_viewport.center, SkyCoord
                 ):
@@ -711,7 +718,8 @@ def get_viewport(
                 # was not already sky, so we need to convert them or fail
                 if viewport.wcs is None:
                     raise ValueError(
-                        "WCS is not set. Cannot convert pixel coordinates to sky coordinates."
+                        "WCS is not set. Cannot convert pixel coordinates to "
+                        "sky coordinates."
                     )
                 else:
                     center = viewport.wcs.pixel_to_world(
@@ -726,7 +734,8 @@ def get_viewport(
             if isinstance(viewport.center, SkyCoord):
                 if viewport.wcs is None:
                     raise ValueError(
-                        "WCS is not set. Cannot convert sky coordinates to pixel coordinates."
+                        "WCS is not set. Cannot convert sky coordinates to "
+                        "pixel coordinates."
                     )
                 center = viewport.wcs.world_to_pixel(viewport.center)
             else:

src/astro_image_display_api/interface_definition.py

@@ -1,14 +1,13 @@
-from typing import Protocol, runtime_checkable, Any
-from abc import abstractmethod
 import numbers
 import os
+from abc import abstractmethod
+from typing import Any, Protocol, runtime_checkable
 
 from astropy.coordinates import SkyCoord
 from astropy.table import Table
 from astropy.units import Quantity
 from astropy.visualization import BaseInterval, BaseStretch
 
-
 # Allowed locations for cursor display
 ALLOWED_CURSOR_LOCATIONS = ("top", "bottom", None)
 
@@ -78,8 +77,8 @@ def set_cuts(
         Raises
         ------
         TypeError
-            If the `cuts` parameter is not a tuple or an `astropy.visualization.BaseInterval`
-            object.
+            If the `cuts` parameter is not a tuple or an
+            `astropy.visualization.BaseInterval` object.
 
         ValueError
             If the `image_label` is not provided when there are multiple images loaded,
@@ -204,8 +203,8 @@ def get_colormap(self, image_label: str | None = None) -> str:
         Raises
         ------
         ValueError
-            If the `image_label` is not provided when there are multiple images loaded or if
-            the `image_label` does not correspond to a loaded image.
+            If the `image_label` is not provided when there are multiple images loaded
+            or if the `image_label` does not correspond to a loaded image.
         """
         raise NotImplementedError
 
@@ -287,7 +286,7 @@ def set_catalog_style(
         shape: str = "circle",
         color: str = "red",
         size: float = 5.0,
-        **kwargs
+        **kwargs,
     ):
         """
         Set the style of the catalog markers.
@@ -408,7 +407,8 @@ def get_catalog(
         Raises
         ------
         ValueError
-            If the `catalog_label` is not provided when there are multiple catalogs loaded.
+            If the `catalog_label` is not provided when there are multiple catalogs
+            loaded.
         """
         raise NotImplementedError
 
@@ -441,8 +441,9 @@ def set_viewport(
             The center of the viewport. If not given, the current center is used.
         fov : `astropy.units.Quantity` or float, optional
             The field of view (FOV) of the viewport. If not given, the current FOV
-            is used. If a float is given, it is interpreted a size in pixels. For images that are
-            not square, the FOV is interpreted as the size of the longer side of the image.
+            is used. If a float is given, it is interpreted a size in pixels. For images
+            that are not square, the FOV is interpreted as the size of the longer side
+            of the image.
         image_label : str, optional
             The label of the image to set the viewport for. If not given and there is
             only one image loaded, the viewport for that image is set. If there are
@@ -476,12 +477,12 @@ def get_viewport(
             If 'sky', the center will be returned as a `SkyCoord` object.
             If 'pixel', the center will be returned as a tuple of pixel coordinates.
             If `None`, the default behavior is to return the center as a `SkyCoord` if
-            possible, or as a tuple of floats if the image is in pixel coordinates and has
-            no WCS information.
+            possible, or as a tuple of floats if the image is in pixel coordinates and
+            has no WCS information.
         image_label : str, optional
-            The label of the image to get the viewport for. If not given and there is only one
-            image loaded, the viewport for that image is returned. If there are multiple images
-            and no label is provided, an error is raised.
+            The label of the image to get the viewport for. If not given and there is
+            only one image loaded, the viewport for that image is returned. If there
+            are multiple images and no label is provided, an error is raised.
 
         Returns
         -------
@@ -495,8 +496,8 @@ def get_viewport(
         Raises
         -------
         ValueError
-            If the `sky_or_pixel` parameter is not one of 'sky', 'pixel', or `None`, or if
-            the `image_label` is not provided when there are multiple images loaded, or if
-            the `image_label` does not correspond to a loaded image.
+            If the `sky_or_pixel` parameter is not one of 'sky', 'pixel', or `None`,
+            or if the `image_label` is not provided when there are multiple images
+            loaded, or if the `image_label` does not correspond to a loaded image.
         """
         raise NotImplementedError

src/astro_image_display_api/widget_api_test.py

@@ -1,22 +1,20 @@
 import numbers
 
-import pytest
-
 import numpy as np
-
+import pytest
+from astropy import units as u
 from astropy.coordinates import SkyCoord
 from astropy.io import fits
 from astropy.nddata import CCDData, NDData
 from astropy.table import Table
-from astropy import units as u
-from astropy.wcs import WCS
 from astropy.visualization import (
     AsymmetricPercentileInterval,
     BaseInterval,
     BaseStretch,
     LogStretch,
     ManualInterval,
 )
+from astropy.wcs import WCS
 
 from .interface_definition import ImageViewerInterface
 
@@ -49,7 +47,7 @@ def wcs(self):
         return w
 
     @pytest.fixture
-    def catalog(self, setup: None, wcs: WCS) -> Table:
+    def catalog(self, wcs: WCS) -> Table:
         """
         A catalog fixture that returns an empty table with the
         expected columns.
@@ -177,7 +175,8 @@ def test_set_get_viewport_errors(self, data, wcs):
                 center=(10, 10), fov=100, image_label="not a valid label"
             )
 
-        # Getting a viewport for an image_label that does not exist should raise an error
+        # Getting a viewport for an image_label that does not exist should
+        # raise an error
         with pytest.raises(ValueError, match="[Ii]mage label.*not found"):
             self.image.get_viewport(image_label="not a valid label")
 
@@ -464,7 +463,7 @@ def test_load_get_single_catalog_with_without_label(self, catalog, catalog_label
             retrieved_catalog = self.image.get_catalog(catalog_label=catalog_label)
             assert (retrieved_catalog == catalog).all()
 
-    def test_load_catalog_does_not_modify_input_catalog(self, catalog, data):
+    def test_load_catalog_does_not_modify_input_catalog(self, catalog):
         # Adding a catalog should not modify the input data table.
         orig_tab = catalog.copy()
         self.image.load_catalog(catalog)

tests/test_astro_image_display_api.py

@@ -24,9 +24,12 @@ def test_api_test_class_completeness():
         attr_present.append(f"{image_viewer_name}.{attr}" in widget_api_test_content)
 
     missing_attributes = [
-        attr for attr, present in zip(required_attributes, attr_present) if not present
+        attr
+        for attr, present in zip(required_attributes, attr_present, strict=False)
+        if not present
     ]
     missing_attributes_msg = "\n".join(missing_attributes)
-    assert all(
-        attr_present
-    ), f"ImageWidgetAPITest does not access these attributes/methods:\n{missing_attributes_msg}\n"
+    assert all(attr_present), (
+        "ImageWidgetAPITest does not access these "
+        f"attributes/methods:\n{missing_attributes_msg}\n"
+    )

tests/test_dummy_viewer.py

@@ -1,6 +1,5 @@
+from astro_image_display_api import ImageViewerInterface, ImageWidgetAPITest
 from astro_image_display_api.dummy_viewer import ImageViewer
-from astro_image_display_api import ImageViewerInterface
-from astro_image_display_api import ImageWidgetAPITest
 
 
 def test_instance():