Merge pull request #215 from sandialabs/update-ruff-linters

Update ruff linters

Author: jmgate

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
     - repo: https://github.com/astral-sh/ruff-pre-commit
       rev: v0.12.2
       hooks:
-        - id: ruff
+        - id: ruff-check
         - id: ruff-format
 
     - repo: https://github.com/gitleaks/gitleaks

example/ex_6_creating_retryable_stages.py

@@ -7,6 +7,8 @@
 
 # SPDX-License-Identifier: BSD-3-Clause
 
+from __future__ import annotations
+
 import argparse
 import functools
 import sys
@@ -25,7 +27,7 @@ def __init__(
         console_force_terminal: Optional[bool] = None,
         console_log_path: bool = True,
         print_commands: bool = True,
-    ):
+    ) -> None:
         super().__init__(
             stages,
             console_force_terminal=console_force_terminal,

example/ex_7_customizing_the_summary.py

@@ -7,6 +7,8 @@
 
 # SPDX-License-Identifier: BSD-3-Clause
 
+from __future__ import annotations
+
 import argparse
 import functools
 import platform
@@ -27,7 +29,7 @@ def __init__(
         console_force_terminal: Optional[bool] = None,
         console_log_path: bool = True,
         print_commands: bool = True,
-    ):
+    ) -> None:
         super().__init__(
             stages,
             console_force_terminal=console_force_terminal,

pyproject.toml

@@ -73,40 +73,74 @@ line-length = 79
 [tool.ruff.lint]
 extend-select = [
     "A",
+    "AIR",
+    "ANN",
+    "ARG",
+    "ASYNC",
     "B",
     "BLE",
     "C4",
     "C90",
     "D",
+    "DJ",
     "DTZ",
     "E",
     "EM",
     "ERA",
     "EXE",
+    "F",
+    "FA",
     "FBT",
+    "FIX",
+    "FLY",
+    "FURB",
+    "G",
+    "ICN",
+    "INP",
+    "INT",
+    "ISC",
+    "LOG",
+    "N",
     "NPY",
+    "PD",
+    "PERF",
     "PGH",
+    "PIE",
     "PL",
     "PT",
     "PTH",
+    "PYI",
+    "Q",
     "RET",
     "RSE",
     "RUF",
     "S",
     "SIM",
+    "SLF",
+    "SLOT",
+    "T10",
+    "T20",
+    "TC",
+    "TD",
     "TID",
     "TCH",
     "TRY",
     "UP",
     "W",
+    "YTT",
 ]
 ignore = [
     "D212",
 ]
 
 
 [tool.ruff.lint.per-file-ignores]
-"**/test_*.py" = ["S101"]
+"**/test_*.py" = [
+    "S101",
+    "SLF001",
+    "T201",
+]
+"doc/source/conf.py" = ["INP001"]
 "example/*.py" = [
     "D101",
     "D102",
@@ -121,6 +155,10 @@ ignore = [
 convention = "google"
 
 
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
+
 [tool.semantic_release]
 build_command = "python3 -m pip install poetry && poetry build"
 commit_message = """

staged_script/staged_script.py

@@ -11,6 +11,8 @@
 
 # SPDX-License-Identifier: BSD-3-Clause
 
+from __future__ import annotations
+
 import functools
 import re
 import shlex
@@ -24,7 +26,7 @@
 from datetime import datetime, timedelta, timezone
 from pathlib import Path
 from subprocess import CompletedProcess
-from typing import Callable, NamedTuple, Optional
+from typing import Any, Callable, NamedTuple, NoReturn, Optional
 
 import __main__
 import rich.traceback
@@ -41,6 +43,28 @@
 rich.traceback.install()
 
 
+def validate_stage_name(stage_name: str) -> None:
+    """
+    Validate a stage name.
+
+    Ensure a stage name consists of only lowercase letters.  This is
+    both to simplify implementation details within the
+    :class:`StagedScript` class, and to provide the best user experience
+    for users of your :class:`StagedScript` subclasses.
+
+    Args:
+        stage_name:  The name of the stage.
+
+    Raises:
+        ValueError:  If the stage name is invalid.
+    """
+    if not re.match("^[a-z]+$", stage_name):
+        message = (
+            f"Stage name {stage_name!r} must contain only lowercase letters."
+        )
+        raise ValueError(message)
+
+
 class StagedScript:
     """
     The base class for all staged scripts.
@@ -121,7 +145,7 @@ def __init__(
         console_force_terminal: Optional[bool] = None,
         console_log_path: bool = True,
         print_commands: bool = True,
-    ):
+    ) -> None:
         """
         Initialize a :class:`StagedScript` object.
 
@@ -145,7 +169,7 @@ def __init__(
             and optionally pass in additional arguments.
         """
         for stage in stages:
-            self._validate_stage_name(stage)
+            validate_stage_name(stage)
         self.args = Namespace()
         self.commands_executed: list[str] = []
         self.console = Console(
@@ -163,29 +187,6 @@ def __init__(
         self.stages_to_run: set[str] = set()
         self.start_time = datetime.now(tz=timezone.utc)
 
-    @staticmethod
-    def _validate_stage_name(stage_name: str) -> None:
-        """
-        Validate the stage name.
-
-        Ensure the stage name consists of only lowercase letters.  This
-        is both to simplify implementation details within the class, and
-        to provide the best user experience for users of your
-        :class:`StagedScript` subclasses.
-
-        Args:
-            stage_name:  The name of the stage.
-
-        Raises:
-            ValueError:  If the stage name is invalid.
-        """
-        if not re.match("^[a-z]+$", stage_name):
-            message = (
-                f"Stage name {stage_name!r} must contain only lowercase "
-                "letters."
-            )
-            raise ValueError(message)
-
     #
     # The `stage` decorator.
     #
@@ -243,13 +244,11 @@ def stage(stage_name: str, heading: str) -> Callable:
             heading:  A heading message to print indicating what will
                 happen in the stage.
         """
-        __class__._validate_stage_name(  # type: ignore[name-defined]
-            stage_name
-        )
+        validate_stage_name(stage_name)
 
         def decorator(func: Callable) -> Callable:
             def get_phase_method(  # noqa: D417
-                self,
+                self,  # noqa: ANN001
                 method_name: str,
             ) -> Callable:
                 """
@@ -274,9 +273,9 @@ def get_phase_method(  # noqa: D417
                 )
 
             def run_retryable_phases(  # noqa: D417
-                self,
-                *args,
-                **kwargs,
+                self,  # noqa: ANN001
+                *args: Any,  # noqa: ANN401
+                **kwargs: Any,  # noqa: ANN401
             ) -> None:
                 """
                 Run the retryable phases.
@@ -311,7 +310,7 @@ def run_retryable_phases(  # noqa: D417
                 get_phase_method(self, "_end_stage")()
 
             @functools.wraps(func)
-            def wrapper(self, *args, **kwargs) -> None:
+            def wrapper(self, *args: Any, **kwargs: Any) -> None:  # noqa: ANN001, ANN401
                 """
                 Turn a function into a stage.
 
@@ -365,7 +364,6 @@ def _run_pre_stage_actions(self) -> None:
         were met before attempting the stage, and erroring out
         appropriately if not.
         """
-        pass
 
     def _begin_stage(self, heading: str) -> None:
         """
@@ -495,7 +493,6 @@ def _run_post_stage_actions(self) -> None:
         were met before moving on, and erroring out appropriately if
         not.
         """
-        pass
 
     def _prepare_to_retry_stage(self, retry_state: RetryCallState) -> None:
         """
@@ -762,7 +759,7 @@ def parse_args(self, argv: list[str]) -> None:
             ]:
                 setattr(self, retry_arg, getattr(self.args, retry_arg, None))
 
-    def raise_parser_error(self, message):
+    def raise_parser_error(self, message: str) -> NoReturn:
         """
         Raise a parser error.
 
@@ -791,7 +788,7 @@ def run(
         *,
         pretty_print: bool = False,
         print_command: Optional[bool] = None,
-        **kwargs,
+        **kwargs: Any,  # noqa: ANN401
     ) -> CompletedProcess:
         """
         Run a command in the underlying shell.
@@ -1023,8 +1020,6 @@ class RetryStage(TryAgain):
     that a stage should be retried.
     """
 
-    pass
-
 
 class HelpFormatter(
     ArgumentDefaultsHelpFormatter, RawDescriptionHelpFormatter
@@ -1036,5 +1031,3 @@ class HelpFormatter(
     treats the description as raw text (doesn't do any automatic
     formatting) and shows default values of arguments.
     """
-
-    pass

test/test_staged_script.py

@@ -6,6 +6,8 @@
 
 # SPDX-License-Identifier: BSD-3-Clause
 
+from __future__ import annotations
+
 import shlex
 from datetime import datetime, timedelta, timezone
 from subprocess import CompletedProcess
@@ -16,6 +18,7 @@
 from rich.console import Console
 
 from staged_script import StagedScript, StageDuration
+from staged_script.staged_script import validate_stage_name
 
 
 @pytest.fixture
@@ -37,21 +40,21 @@ def test_print_dry_run_message(
     assert expected in captured.out
 
 
-def test__validate_stage_name() -> None:
-    """Test the :func:`validate_stage_name` method."""
-    StagedScript._validate_stage_name("valid")
+def test_validate_stage_name() -> None:
+    """Test the :func:`validate_stage_name` function."""
+    validate_stage_name("valid")
 
 
 @pytest.mark.parametrize(
     "stage_name", ["Uppercase", "spa ces", "hyphen-ated", "under_scores"]
 )
-def test__validate_stage_name_raises(stage_name: str) -> None:
+def test_validate_stage_name_raises(stage_name: str) -> None:
     """Ensure :func:`validate_stage_name` raises an exception when needed."""
     with pytest.raises(
         ValueError,
         match=f"'{stage_name}' must contain only lowercase letters",
     ):
-        StagedScript._validate_stage_name(stage_name)
+        validate_stage_name(stage_name)
 
 
 def test__begin_stage(
@@ -91,15 +94,15 @@ def test__skip_stage(
 @pytest.mark.parametrize("retry_attempts", [0, 5])
 @patch("tenacity.Retrying")
 def test__handle_stage_retry_error(
-    mock_Retrying: MagicMock,
+    mock_retrying: MagicMock,
     retry_attempts: int,
     script: StagedScript,
     capsys: pytest.CaptureFixture,
 ) -> None:
     """Test the :func:`_handle_stage_retry_error` method."""
     script.current_stage = "test"
     script.test_retry_attempts = retry_attempts  # type: ignore[attr-defined]
-    retry = mock_Retrying()
+    retry = mock_retrying()
     retry.statistics = {
         "delay_since_first_attempt": 1234,
         "attempt_number": retry_attempts,
@@ -121,14 +124,14 @@ def test__handle_stage_retry_error(
 
 @patch("tenacity.RetryCallState")
 def test__prepare_to_retry_stage(
-    mock_RetryCallState: MagicMock,
+    mock_retry_call_state: MagicMock,
     script: StagedScript,
     capsys: pytest.CaptureFixture,
 ) -> None:
     """Test the :func:`_prepare_to_retry_stage` method."""
     script.current_stage = "test"
-    retry_state = mock_RetryCallState()
-    retry_state.__repr__ = lambda self: "mock_RetryCallState.__repr__"
+    retry_state = mock_retry_call_state()
+    retry_state.__repr__ = lambda _self: "mock_RetryCallState.__repr__"
     script._prepare_to_retry_stage(retry_state)
     captured = capsys.readouterr()
     for text in [