Update ruff linters

.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

doc/source/index.rst

@@ -8,7 +8,6 @@ shell-logger
 
    shell_logger
    shell
-   abstract_method
    stats_collector
    trace_collector
    html_utilities

pyproject.toml

@@ -67,32 +67,62 @@ 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",
+    "I",
+    "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",
+    "UP",
     "W",
+    "YTT",
 ]
 ignore = [
     "D212",
@@ -106,14 +136,24 @@ extend-allowed-calls = [
 
 
 [tool.ruff.lint.per-file-ignores]
-"**/test_*.py" = ["S101"]
+"**/test_*.py" = [
+    "S101",
+    "SLF001",
+    "T201",
+]
+"doc/source/conf.py" = ["INP001"]
+"example/*.py" = ["T201"]
 "html_utilities.py" = ["PLR2004"]
 
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
 
 
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
+
 
 [tool.semantic_release]
 build_command = "python3 -m pip install poetry && poetry build"

shell_logger/html_utilities.py

@@ -9,11 +9,11 @@
 import pkgutil
 import re
 import textwrap
-from collections.abc import Iterable, Mapping
+from collections.abc import Iterable, Iterator, Mapping
 from datetime import datetime
 from pathlib import Path
 from types import SimpleNamespace
-from typing import Iterator, TextIO, Union
+from typing import TextIO, Union
 
 
 def nested_simplenamespace_to_dict(
@@ -851,7 +851,7 @@ def sgr_4bit_color_and_style_to_html(sgr: str) -> str:
         "39": "color: inherit;",
         "49": "background-color: inherit;",
     }
-    return f'<span style="{sgr_to_css.get(sgr) or str()}">'
+    return f'<span style="{sgr_to_css.get(sgr) or ""}">'
 
 
 def sgr_8bit_color_to_html(sgr_params: list[str]) -> str:  # noqa: PLR0911

shell_logger/shell.py

@@ -20,7 +20,6 @@
 from types import SimpleNamespace
 from typing import IO, Optional, TextIO
 
-
 END_OF_READ = 4
 
 
@@ -118,7 +117,7 @@ def __del__(self) -> None:
         ]:
             try:
                 os.close(fd)
-            except OSError as e:
+            except OSError as e:  # noqa: PERF203
                 if "Bad file descriptor" not in e.strerror:
                     raise
 
@@ -185,12 +184,12 @@ def run(self, command: str, **kwargs) -> SimpleNamespace:
 
         # Set the `RET_CODE` environment variable, such that we can
         # access it later.
-        os.write(self.aux_stdin_wfd, "RET_CODE=$?\n".encode())
+        os.write(self.aux_stdin_wfd, b"RET_CODE=$?\n")
 
         # Because these writes are non-blocking, tell the shell that the
         # writes are complete.
-        os.write(self.aux_stdin_wfd, "printf '\\4'\n".encode())
-        os.write(self.aux_stdin_wfd, "printf '\\4' 1>&2\n".encode())
+        os.write(self.aux_stdin_wfd, b"printf '\\4'\n")
+        os.write(self.aux_stdin_wfd, b"printf '\\4' 1>&2\n")
 
         # Tee the output to multiple sinks (files, strings,
         # `stdout`/`stderr`).

shell_logger/shell_logger.py

@@ -14,13 +14,13 @@
 import shutil
 import string
 import tempfile
-from collections.abc import Iterable, Mapping
+from collections.abc import Iterable, Iterator, Mapping
 from datetime import datetime, timedelta
 from distutils import dir_util
 from pathlib import Path
 from tempfile import NamedTemporaryFile
 from types import SimpleNamespace
-from typing import Iterator, Optional, Union
+from typing import Optional, Union
 
 from .html_utilities import (
     append_html,
@@ -248,7 +248,7 @@
         """
         self.done_time = datetime.now()
 
-    def __update_duration(self) -> None:
+    def update_duration(self) -> None:
         """
         Update the :attr:`duration` attribute.
 
@@ -385,7 +385,7 @@
             msg:  The message to print and save to the log.
             end:  The string appended after the message:
         """
-        print(msg, end=end)
+        print(msg, end=end)  # noqa: T201
         log = {"msg": msg, "timestamp": str(datetime.now()), "cmd": None}
         self.log_book.append(log)
 
@@ -427,7 +427,7 @@
             if isinstance(log, ShellLogger):
                 # Update the duration of this ShellLogger's commands.
                 if log.duration is None:
-                    log.__update_duration()
+                    log.update_duration()
                 html.append(child_logger_card(log))
 
             # Otherwise, if this is a message being logged...
@@ -559,7 +559,7 @@
         # Print the command to be executed.
         with stdout_path.open("a"), stderr_path.open("a"):
             if verbose:
-                print(cmd)
+                print(cmd)  # noqa: T201
 
         # Initialize the log information.
         log = {
@@ -737,7 +737,7 @@
         """
         if isinstance(obj, ShellLogger):
             return {
-                **{"__type__": "ShellLogger"},
+                "__type__": "ShellLogger",
                 **{k: self.default(v) for k, v in obj.__dict__.items()},
             }
         if isinstance(obj, (int, float, str, bytes)):

shell_logger/stats_collector.py

@@ -15,8 +15,6 @@
 from time import sleep, time
 from typing import TYPE_CHECKING
 
-from .abstract_method import AbstractMethod
-
 if TYPE_CHECKING:
     from multiprocessing.managers import SyncManager
 
@@ -41,14 +39,15 @@ def stats_collectors(**kwargs) -> list[StatsCollector]:
     Returns:
         A collection of instances of :class:`StatsCollector` subclasses.
     """
-    collectors = []
     if "measure" in kwargs:
         interval = kwargs.get("interval", 1.0)
         manager = Manager()
-        for collector in StatsCollector.subclasses:
-            if collector.stat_name in kwargs["measure"]:
-                collectors.append(collector(interval, manager))
-    return collectors
+        return [
+            collector(interval, manager)
+            for collector in StatsCollector.subclasses
+            if collector.stat_name in kwargs["measure"]
+        ]
+    return []
 
 
 class StatsCollector:
@@ -117,11 +116,7 @@ def collect(self):
         Instantaneously collect a statistic.
 
         This is meant to be called repeatedly after some time interval.
-
-        Raises:
-            AbstractMethod:  This must be overridden by subclasses.
         """
-        raise AbstractMethod
 
     @abstractmethod
     def unproxied_stats(self):
@@ -130,11 +125,7 @@ def unproxied_stats(self):
 
         Convert from Python's Manager's data structures to base Python
         data structures.
-
-        Raises:
-            AbstractMethod:  This must be overridden by subclasses.
         """
-        raise AbstractMethod
 
     def finish(self):
         """
@@ -317,7 +308,6 @@ def __init__(self, interval: float, manager: SyncManager) -> None:
 
         def collect(self) -> None:
             """Don't collect any disk statistics."""
-            pass
 
         def unproxied_stats(self) -> None:
             """
@@ -352,7 +342,6 @@ def __init__(self, interval: float, manager: SyncManager) -> None:
 
         def collect(self) -> None:
             """Don't collect any CPU statistics."""
-            pass
 
         def unproxied_stats(self) -> None:
             """
@@ -387,7 +376,6 @@ def __init__(self, interval: float, manager: SyncManager) -> None:
 
         def collect(self) -> None:
             """Don't collect any memory statistics."""
-            pass
 
         def unproxied_stats(self) -> None:
             """

shell_logger/trace_collector.py

@@ -11,8 +11,6 @@
 from abc import abstractmethod
 from pathlib import Path
 
-from .abstract_method import AbstractMethod
-
 
 def trace_collector(**kwargs) -> TraceCollector:
     """
@@ -87,11 +85,7 @@ def trace_args(self) -> str:
 
         The trace command and the arguments you pass to it, but not the
         command you're tracing.  E.g., return `strace -f -c -e "open"`.
-
-        Raises:
-            AbstractMethod:  This needs to be overridden by subclasses.
         """
-        raise AbstractMethod
 
     def command(self, command: str):
         """

test/__init__.py

@@ -0,0 +1,13 @@
+"""
+Create the ``test`` package.
+
+This ``__init__.py`` file creates the ``test`` package, such that tests
+can relative-import from modules in the sibling ``shell_logger``
+directory.
+"""
+
+# © 2023 National Technology & Engineering Solutions of Sandia, LLC
+# (NTESS).  Under the terms of Contract DE-NA0003525 with NTESS, the
+# U.S. Government retains certain rights in this software.
+
+# SPDX-License-Identifier: BSD-3-Clause