Merge pull request #162 from lsst/tickets/DM-39785

DM-39785: Package modernization and ruff

.github/workflows/lint.yaml

@@ -9,3 +9,8 @@ on:
 jobs:
   call-workflow:
     uses: lsst/rubin_workflows/.github/workflows/lint.yaml@main
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: chartboost/ruff-action@v1

.pre-commit-config.yaml

@@ -21,7 +21,8 @@ repos:
     hooks:
       - id: isort
         name: isort (python)
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.0.275
     hooks:
-      - id: flake8
+      - id: ruff

pyproject.toml

@@ -126,3 +126,43 @@ exclude_lines = [
     "if __name__ == .__main__.:",
     "if TYPE_CHECKING:",
 ]
+
+[tool.ruff]
+exclude = [
+    "__init__.py",
+]
+ignore = [
+    "N802",
+    "N803",
+    "N806",
+    "N812",
+    "N815",
+    "N816",
+    "N999",
+    "D107",
+    "D105",
+    "D102",
+    "D104",
+    "D100",
+    "D200",
+    "D205",
+    "D400",
+]
+line-length = 110
+select = [
+    "E",  # pycodestyle
+    "F",  # pyflakes
+    "N",  # pep8-naming
+    "W",  # pycodestyle
+    "D",  # pydocstyle
+]
+target-version = "py310"
+extend-select = [
+    "RUF100", # Warn about unused noqa
+]
+
+[tool.ruff.pycodestyle]
+max-doc-length = 79
+
+[tool.ruff.pydocstyle]
+convention = "numpy"

python/lsst/utils/_packaging.py

@@ -11,6 +11,8 @@
 
 """Functions to help find packages."""
 
+from __future__ import annotations
+
 __all__ = ("getPackageDir",)
 
 import os

python/lsst/utils/classes.py

@@ -18,7 +18,8 @@
 __all__ = ["Singleton", "cached_getter", "immutable"]
 
 import functools
-from typing import Any, Callable, Dict, Type, TypeVar
+from collections.abc import Callable
+from typing import Any, Type, TypeVar
 
 
 class Singleton(type):
@@ -32,14 +33,14 @@ class Singleton(type):
     adjust state of the singleton.
     """
 
-    _instances: Dict[Type, Any] = {}
+    _instances: dict[type, Any] = {}
 
     # Signature is intentionally not substitutable for type.__call__ (no *args,
     # **kwargs) to require classes that use this metaclass to have no
     # constructor arguments.
     def __call__(cls) -> Any:
         if cls not in cls._instances:
-            cls._instances[cls] = super(Singleton, cls).__call__()
+            cls._instances[cls] = super().__call__()
         return cls._instances[cls]
 
 

python/lsst/utils/deprecated.py

@@ -9,18 +9,21 @@
 # Use of this source code is governed by a 3-clause BSD-style
 # license that can be found in the LICENSE file.
 
+from __future__ import annotations
+
 __all__ = ["deprecate_pybind11", "suppress_deprecations"]
 
 import functools
 import unittest.mock
 import warnings
+from collections.abc import Iterator
 from contextlib import contextmanager
-from typing import Any, Iterator, Type
+from typing import Any
 
 import deprecated.sphinx
 
 
-def deprecate_pybind11(obj: Any, reason: str, version: str, category: Type[Warning] = FutureWarning) -> Any:
+def deprecate_pybind11(obj: Any, reason: str, version: str, category: type[Warning] = FutureWarning) -> Any:
     """Deprecate a pybind11-wrapped C++ interface function, method or class.
 
     This needs to use a pass-through Python wrapper so that
@@ -73,7 +76,7 @@ def internal(*args: Any, **kwargs: Any) -> Any:
 
 
 @contextmanager
-def suppress_deprecations(category: Type[Warning] = FutureWarning) -> Iterator[None]:
+def suppress_deprecations(category: type[Warning] = FutureWarning) -> Iterator[None]:
     """Suppress warnings generated by `deprecated.sphinx.deprecated`.
 
     Naively, one might attempt to suppress these warnings by using

python/lsst/utils/doImport.py

@@ -9,14 +9,15 @@
 # Use of this source code is governed by a 3-clause BSD-style
 # license that can be found in the LICENSE file.
 
+from __future__ import annotations
+
 __all__ = ("doImport", "doImportType")
 
 import importlib
 import types
-from typing import List, Optional, Type, Union
 
 
-def doImport(importable: str) -> Union[types.ModuleType, Type]:
+def doImport(importable: str) -> types.ModuleType | type:
     """Import a python object given an importable string and return it.
 
     Parameters
@@ -43,26 +44,24 @@ def doImport(importable: str) -> Union[types.ModuleType, Type]:
     if not isinstance(importable, str):
         raise TypeError(f"Unhandled type of importable, val: {importable}")
 
-    def tryImport(
-        module: str, fromlist: List[str], previousError: Optional[str]
-    ) -> Union[types.ModuleType, Type]:
+    def tryImport(module: str, fromlist: list[str], previousError: str | None) -> types.ModuleType | type:
         pytype = importlib.import_module(module)
         # Can have functions inside classes inside modules
         for f in fromlist:
             try:
                 pytype = getattr(pytype, f)
-            except AttributeError:
+            except AttributeError as e:
                 extra = f"({previousError})" if previousError is not None else ""
                 raise ImportError(
                     f"Could not get attribute '{f}' from '{module}' when importing '{importable}' {extra}"
-                )
+                ) from e
         return pytype
 
     # Go through the import path attempting to load the module
     # and retrieve the class or function as an attribute. Shift components
     # from the module list to the attribute list until something works.
     moduleComponents = importable.split(".")
-    infileComponents: List[str] = []
+    infileComponents: list[str] = []
     previousError = None
 
     while moduleComponents:
@@ -88,7 +87,7 @@ def tryImport(
     raise ModuleNotFoundError(f"Unable to import {importable!r} {extra}")
 
 
-def doImportType(importable: str) -> Type:
+def doImportType(importable: str) -> type:
     """Import a python type given an importable string and return it.
 
     Parameters

python/lsst/utils/get_caller_name.py

@@ -9,6 +9,8 @@
 # Use of this source code is governed by a 3-clause BSD-style
 # license that can be found in the LICENSE file.
 
+from __future__ import annotations
+
 __all__ = ["get_caller_name"]
 
 from deprecated.sphinx import deprecated

python/lsst/utils/inheritDoc.py

@@ -9,12 +9,14 @@
 # Use of this source code is governed by a 3-clause BSD-style
 # license that can be found in the LICENSE file.
 
+from __future__ import annotations
+
 __all__ = ("inheritDoc",)
 
-from typing import Callable, Type
+from collections.abc import Callable
 
 
-def inheritDoc(klass: Type) -> Callable:
+def inheritDoc(klass: type) -> Callable:
     """Extend existing documentation for a method that exists in another
     class and extend it with any additional documentation defined.
 
@@ -34,7 +36,7 @@ class and extend it with any additional documentation defined.
         Intermediate decorator used in the documentation process.
     """
 
-    def tmpDecorator(method: Type) -> Callable:
+    def tmpDecorator(method: type) -> Callable:
         """Update the documentation from a class with the same method."""
         methodName = method.__name__
         if not hasattr(klass, methodName):

python/lsst/utils/introspection.py

@@ -9,11 +9,10 @@
 # Use of this source code is governed by a 3-clause BSD-style
 # license that can be found in the LICENSE file.
 #
+"""Utilities relating to introspection in python."""
 
 from __future__ import annotations
 
-"""Utilities relating to introspection in python."""
-
 __all__ = [
     "get_class_of",
     "get_full_type_name",
@@ -25,7 +24,7 @@
 import builtins
 import inspect
 import types
-from typing import Any, Type, Union
+from typing import Any
 
 from .doImport import doImport, doImportType
 
@@ -84,7 +83,7 @@ def get_full_type_name(cls: Any) -> str:
     return cleaned_name
 
 
-def get_class_of(typeOrName: Union[Type, str]) -> Type:
+def get_class_of(typeOrName: type | str | types.ModuleType) -> type:
     """Given the type name or a type, return the python type.
 
     If a type name is given, an attempt will be made to import the type.
@@ -112,13 +111,13 @@ def get_class_of(typeOrName: Union[Type, str]) -> Type:
     if isinstance(typeOrName, str):
         cls = doImportType(typeOrName)
     else:
-        cls = typeOrName
-        if isinstance(cls, types.ModuleType):
+        if isinstance(typeOrName, types.ModuleType):
             raise TypeError(f"Can not get class of module {get_full_type_name(typeOrName)}")
+        cls = typeOrName
     return cls
 
 
-def get_instance_of(typeOrName: Union[Type, str], *args: Any, **kwargs: Any) -> Any:
+def get_instance_of(typeOrName: type | str, *args: Any, **kwargs: Any) -> Any:
     """Given the type name or a type, instantiate an object of that type.
 
     If a type name is given, an attempt will be made to import the type.

python/lsst/utils/iteration.py

@@ -10,18 +10,18 @@
 # license that can be found in the LICENSE file.
 #
 
-from __future__ import annotations
-
 """Utilities relating to iterators."""
 
+from __future__ import annotations
+
 __all__ = ["chunk_iterable", "ensure_iterable", "isplit"]
 
 import itertools
-from collections.abc import Mapping
-from typing import Any, Iterable, Iterator, Tuple, TypeVar
+from collections.abc import Iterable, Iterator, Mapping
+from typing import Any, TypeVar
 
 
-def chunk_iterable(data: Iterable[Any], chunk_size: int = 1_000) -> Iterator[Tuple[Any, ...]]:
+def chunk_iterable(data: Iterable[Any], chunk_size: int = 1_000) -> Iterator[tuple[Any, ...]]:
     """Return smaller chunks of an iterable.
 
     Parameters

python/lsst/utils/logging.py

@@ -24,9 +24,10 @@
 import logging
 import sys
 import time
+from collections.abc import Generator
 from contextlib import contextmanager
 from logging import LoggerAdapter
-from typing import Any, Generator, List, Optional, Union
+from typing import Any, Union
 
 try:
     import lsst.log.utils as logUtils
@@ -172,7 +173,7 @@ class LsstLogAdapter(LoggerAdapter):
     _stacklevel = _calculate_base_stacklevel(2, 1)
 
     @contextmanager
-    def temporary_log_level(self, level: Union[int, str]) -> Generator:
+    def temporary_log_level(self, level: int | str) -> Generator:
         """Temporarily set the level of this logger.
 
         Parameters
@@ -253,7 +254,7 @@ def trace(self, fmt: str, *args: Any, **kwargs: Any) -> None:
         stacklevel = self._process_stacklevel(kwargs)
         self.log(TRACE, fmt, *args, **kwargs, stacklevel=stacklevel)
 
-    def setLevel(self, level: Union[int, str]) -> None:
+    def setLevel(self, level: int | str) -> None:
         """Set the level for the logger, trapping lsst.log values.
 
         Parameters
@@ -272,7 +273,7 @@ def setLevel(self, level: Union[int, str]) -> None:
         self.logger.setLevel(level)
 
     @property
-    def handlers(self) -> List[logging.Handler]:
+    def handlers(self) -> list[logging.Handler]:
         """Log handlers associated with this logger."""
         return self.logger.handlers
 
@@ -288,7 +289,7 @@ def removeHandler(self, handler: logging.Handler) -> None:
         self.logger.removeHandler(handler)
 
 
-def getLogger(name: Optional[str] = None, logger: Optional[logging.Logger] = None) -> LsstLogAdapter:
+def getLogger(name: str | None = None, logger: logging.Logger | None = None) -> LsstLogAdapter:
     """Get a logger compatible with LSST usage.
 
     Parameters
@@ -323,7 +324,7 @@ def getLogger(name: Optional[str] = None, logger: Optional[logging.Logger] = Non
 LsstLoggers = Union[logging.Logger, LsstLogAdapter]
 
 
-def getTraceLogger(logger: Union[str, LsstLoggers], trace_level: int) -> LsstLogAdapter:
+def getTraceLogger(logger: str | LsstLoggers, trace_level: int) -> LsstLogAdapter:
     """Get a logger with the appropriate TRACE name.
 
     Parameters
@@ -367,7 +368,7 @@ class PeriodicLogger:
     LOGGING_INTERVAL = 600.0
     """Default interval between log messages."""
 
-    def __init__(self, logger: LsstLoggers, interval: Optional[float] = None, level: int = VERBOSE):
+    def __init__(self, logger: LsstLoggers, interval: float | None = None, level: int = VERBOSE):
         self.logger = logger
         self.interval = interval if interval is not None else self.LOGGING_INTERVAL
         self.level = level