chore: 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

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

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
@@ -365,7 +367,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 +496,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:
         """
@@ -1023,8 +1023,6 @@ class RetryStage(TryAgain):
     that a stage should be retried.
     """
 
-    pass
-
 
 class HelpFormatter(
     ArgumentDefaultsHelpFormatter, RawDescriptionHelpFormatter
@@ -1036,5 +1034,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
@@ -91,15 +93,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 +123,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 [

test/test_staged_script_advanced_subclass.py

@@ -42,7 +42,7 @@ def run_test(self, *, retry: bool = False) -> None:
     def _run_pre_stage_actions(self) -> None:
         print("inside '_run_pre_stage_actions' function")
 
-    def _begin_stage(self, heading: str) -> None:
+    def _begin_stage(self, _heading: str) -> None:
         print("inside '_begin_stage' function")
 
     def _skip_stage(self) -> None:
@@ -54,10 +54,10 @@ def _end_stage(self) -> None:
     def _run_post_stage_actions(self) -> None:
         print("inside '_run_post_stage_actions' function")
 
-    def _handle_stage_retry_error(self, retry: Retrying) -> None:
+    def _handle_stage_retry_error(self, _retry: Retrying) -> None:
         print("inside '_handle_stage_retry_error' function")
 
-    def _prepare_to_retry_stage(self, retry_state: RetryCallState) -> None:
+    def _prepare_to_retry_stage(self, _retry_state: RetryCallState) -> None:
         print("inside '_prepare_to_retry_stage' function")
 
 
@@ -125,7 +125,7 @@ def test_stage(  # noqa: PLR0913
         )
     if custom_begin_stage:
         script._begin_stage_test = (  # type: ignore[attr-defined]
-            lambda heading: print("inside '_begin_stage_test' function")
+            lambda _heading: print("inside '_begin_stage_test' function")
         )
     if custom_skip_stage:
         script._skip_stage_test = lambda: print(  # type: ignore[attr-defined]
@@ -178,13 +178,13 @@ def test_stage_retry(
     script.stages_to_run = {"test"}
     if custom_prepare_to_retry:
         script._prepare_to_retry_stage_test = (  # type: ignore[attr-defined]
-            lambda retry_state: print(
+            lambda _retry_state: print(
                 "inside '_prepare_to_retry_stage_test' function"
             )
         )
     if custom_handle_retry_error:
         script._handle_stage_retry_error_test = (  # type: ignore[attr-defined]
-            lambda retry: print(
+            lambda _retry: print(
                 "inside '_handle_stage_retry_error_test' function"
             )
         )