style: fix auto-fixable PTH issues

machshev · machshev · commit cc26b342c8fa · 2025-09-25T14:35:15.000+01:00
Remove the CI lint rule exclusions for the rules that now pass.

Signed-off-by: James McCorrie &lt;james.mccorrie@lowrisc.org&gt;
diff --git a/ruff-ci.toml b/ruff-ci.toml
@@ -81,15 +81,9 @@ ignore = [
     "PLW2901",
     "PT009",
     "PT011",
-    "PTH100",
-    "PTH101",
     "PTH103",
-    "PTH107",
-    "PTH109",
-    "PTH110",
     "PTH116",
     "PTH118",
-    "PTH120",
     "PTH123",
     "PYI024",
     "RUF001",
diff --git a/src/dvsim/cli.py b/src/dvsim/cli.py
@@ -218,7 +218,7 @@ def copy_repo(src, dest) -> None:
 
     # Supply `.gitignore` from the src area to skip temp files.
     ignore_patterns_file = os.path.join(src, ".gitignore")
-    if os.path.exists(ignore_patterns_file):
+    if Path(ignore_patterns_file).exists():
         # TODO: hack - include hw/foundry since it is excluded in .gitignore.
         rsync_cmd += [
             "--include=hw/foundry",
@@ -831,7 +831,7 @@ def main() -> None:
         log_level = log.DEBUG
     log.basicConfig(format=log_format, level=log_level)
 
-    if not os.path.exists(args.cfg):
+    if not Path(args.cfg).exists():
         log.fatal("Path to config file %s appears to be invalid.", args.cfg)
         sys.exit(1)
 
@@ -849,7 +849,7 @@ def main() -> None:
     # core files.
     (Path(args.scratch_root) / "FUSESOC_IGNORE").touch()
 
-    args.cfg = os.path.abspath(args.cfg)
+    args.cfg = Path(args.cfg).resolve()
     if args.remote:
         cfg_path = args.cfg.replace(proj_root_src + "/", "")
         args.cfg = os.path.join(proj_root, cfg_path)
diff --git a/src/dvsim/flow/base.py b/src/dvsim/flow/base.py
@@ -102,7 +102,7 @@ def __init__(self, flow_cfg_file, hjson_data, args, mk_config) -> None:
         self.revision = ""
         self.results_server_prefix = ""
         self.results_server_cmd = ""
-        self.css_file = os.path.join(os.path.dirname(os.path.realpath(__file__)), "style.css")
+        self.css_file = os.path.join(Path(os.path.realpath(__file__)).parent, "style.css")
         # `self.results_*` below will be updated after `self.rel_path` and
         # `self.scratch_base_root` variables are updated.
         self.results_dir = ""
@@ -140,7 +140,7 @@ def __init__(self, flow_cfg_file, hjson_data, args, mk_config) -> None:
                 self._load_child_cfg(entry, mk_config)
 
         if self.rel_path == "":
-            self.rel_path = os.path.dirname(self.flow_cfg_file).replace(self.proj_root + "/", "")
+            self.rel_path = Path(self.flow_cfg_file).parent.replace(self.proj_root + "/", "")
 
         # Process overrides before substituting wildcards
         self._process_overrides()
diff --git a/src/dvsim/flow/factory.py b/src/dvsim/flow/factory.py
@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import logging as log
-import os
+import pathlib
 import sys
 
 from dvsim.flow.cdc import CdcCfg
@@ -27,7 +27,7 @@ def _load_cfg(path, initial_values):
     # Set the `self_dir` template variable to the path of the currently
     # processed Hjson file.
     assert "self_dir" in initial_values
-    initial_values["self_dir"] = os.path.dirname(path)
+    initial_values["self_dir"] = pathlib.Path(path).parent
 
     # Start by loading up the hjson file and any included files
     hjson_data = load_hjson(path, initial_values)
@@ -105,7 +105,7 @@ def make_cfg(path, args, proj_root):
     """
     initial_values = {
         "proj_root": proj_root,
-        "self_dir": os.path.dirname(path),
+        "self_dir": pathlib.Path(path).parent,
     }
     if args.tool is not None:
         initial_values["tool"] = args.tool
diff --git a/src/dvsim/launcher/base.py b/src/dvsim/launcher/base.py
@@ -201,8 +201,7 @@ def _dump_env_vars(self, exports) -> None:
             encoding="UTF-8",
             errors="surrogateescape",
         ) as f:
-            for var in sorted(exports.keys()):
-                f.write(f"{var}={exports[var]}\n")
+            f.writelines(f"{var}={exports[var]}\n" for var in sorted(exports.keys()))
 
     def _pre_launch(self) -> None:
         """Do pre-launch activities.
diff --git a/src/dvsim/launcher/nc.py b/src/dvsim/launcher/nc.py
@@ -5,6 +5,7 @@
 import datetime
 import logging as log
 import os
+import pathlib
 import subprocess
 import sys
 
@@ -43,7 +44,7 @@ def create_run_sh(self, full_path, cmd) -> None:
         ]
         with open(run_file, "w") as f:
             f.write("\n".join(lines))
-        os.chmod(run_file, 0o755)
+        pathlib.Path(run_file).chmod(0o755)
 
     def get_submit_cmd(self):
         exetool = self.deploy.sim_cfg.tool
diff --git a/src/dvsim/launcher/sge/engine.py b/src/dvsim/launcher/sge/engine.py
@@ -13,8 +13,6 @@
 import subprocess
 import time
 
-from dvsim.launcher.sge.qsubopts import QSubOptions
-
 
 class _JobData:
     """Internal helper class to manage job data from qstat."""
diff --git a/src/dvsim/launcher/sge/launcher.py b/src/dvsim/launcher/sge/launcher.py
@@ -5,6 +5,7 @@
 """SgeLauncher Class."""
 
 import os
+import pathlib
 import shlex
 import subprocess
 from subprocess import PIPE, Popen
@@ -101,15 +102,14 @@ def poll(self):
             return "D"
         # -------------------------------------
         # copy SGE jobb results to log file
-        if os.path.exists(self.deploy.get_log_path() + ".sge"):
+        if pathlib.Path(self.deploy.get_log_path() + ".sge").exists():
             file1 = open(self.deploy.get_log_path() + ".sge", errors="replace")
             lines = file1.readlines()
             file1.close()
             f = open(self.deploy.get_log_path(), "a", encoding="UTF-8", errors="surrogateescape")
-            for line in lines:
-                f.write(line)
+            f.writelines(lines)
             f.flush()
-            os.remove(self.deploy.get_log_path() + ".sge")
+            pathlib.Path(self.deploy.get_log_path() + ".sge").unlink()
             f.close()
         # -------------------------------------
 
diff --git a/src/dvsim/launcher/sge/qsubopts.py b/src/dvsim/launcher/sge/qsubopts.py
@@ -14,6 +14,7 @@
 """
 
 import argparse
+import pathlib
 
 
 class QSubOptions:
@@ -1933,7 +1934,7 @@ def execute(self, mode="local", path=""):
         args = getattr(self.args, "command_args", [])
         args = getattr(self.args, "xterm_args", args)
         # ---------------- command file -------------
-        cwd = os.getcwd()
+        cwd = pathlib.Path.cwd()
         command_file = cwd + "/command_file_" + str(os.getpid()) + "_" + test_id
         try:
             with open(command_file, "w") as f_command:
@@ -1944,7 +1945,7 @@ def execute(self, mode="local", path=""):
             error_msg = "Error: problem with open File: " + str(f_command)
             raise OSError(error_msg)
 
-        os.chmod(command_file, 0o0777)
+        pathlib.Path(command_file).chmod(0o0777)
         exestring = " ".join([program, *options, command_file, *args])
         exestring = exestring.replace("-pe lammpi 1", "")
         exestring = exestring.replace("-slot", "-pe make")
diff --git a/src/dvsim/launcher/slurm.py b/src/dvsim/launcher/slurm.py
@@ -4,6 +4,7 @@
 
 import logging as log
 import os
+import pathlib
 import shlex
 import shutil
 import subprocess
@@ -96,7 +97,7 @@ def poll(self):
             return "D"
 
         # Copy slurm job results to log file
-        if os.path.exists(self.slurm_log_file):
+        if pathlib.Path(self.slurm_log_file).exists():
             try:
                 with open(self.slurm_log_file) as slurm_file:
                     try:
@@ -108,7 +109,7 @@ def poll(self):
                             msg,
                         )
                 # Remove the temporary file from the slurm process
-                os.remove(self.slurm_log_file)
+                pathlib.Path(self.slurm_log_file).unlink()
             except OSError as e:
                 msg = f"File Error: {e} when handling {self.slurm_log_file}"
                 raise LauncherError(msg)
diff --git a/src/dvsim/modes.py b/src/dvsim/modes.py
@@ -17,6 +17,7 @@ class Mode:
     """
 
     def __init__(self, type_name: str, mdict) -> None:
+        """Initialise mode."""
         keys = mdict.keys()
         attrs = self.__dict__.keys()
 
@@ -27,17 +28,20 @@ def __init__(self, type_name: str, mdict) -> None:
         for key in keys:
             if key not in attrs:
                 log.error(
-                    f"Key {key} in {mdict} is invalid. Supported "
-                    f"attributes for a {type_name} are {attrs}",
+                    "Key %s in %s is invalid. Supported attributes for a %s are %s",
+                    key,
+                    mdict,
+                    type_name,
+                    attrs,
                 )
                 sys.exit(1)
             setattr(self, key, mdict[key])
 
-    def get_sub_modes(self) -> list[str]:
+    def get_sub_modes(self) -> Sequence[str]:
         # Default behaviour is not to have sub-modes
         return []
 
-    def set_sub_modes(self, sub_modes: list[str]) -> None:
+    def set_sub_modes(self, sub_modes: Sequence[str]) -> None:
         # Default behaviour is not to have sub-modes
         return None
 
@@ -50,8 +54,9 @@ def merge_mode(self, mode: "Mode") -> None:
         # then something has gone wrong. Generate an error.
         if mode.name != self.name and not is_sub_mode:
             log.error(
-                f"Cannot merge mode {self.name} with {mode.name}: "
-                f"it is not a sub-mode and they are not equal.",
+                "Cannot merge mode %s with %s: it is not a sub-mode and they are not equal.",
+                self.name,
+                mode.name,
             )
             sys.exit(1)
 
@@ -81,9 +86,11 @@ def merge_mode(self, mode: "Mode") -> None:
             # that the values are compatible.
             if not isinstance(mode_attr_val, type(self_attr_val)):
                 log.error(
-                    f"Cannot merge {self.name} with mode {mode.name}: "
-                    f"the incoming values for attribute {attr} are not "
-                    f"of the same type.",
+                    "Cannot merge %s with mode %s: the incoming values for "
+                    "attribute %s are not of the same type.",
+                    self.name,
+                    mode.name,
+                    attr,
                 )
                 sys.exit(1)
 
@@ -115,9 +122,13 @@ def merge_mode(self, mode: "Mode") -> None:
             # they are not equal. Raise an error because we don't know how to
             # merge them.
             log.error(
-                f"Cannot merge mode {mode.name} into {self.name} "
-                f"because they have conflicting values for attribute "
-                f"{attr}: {mode_attr_val} and {self_attr_val}.",
+                "Cannot merge mode %s into %s because they have conflicting "
+                "values for attribute %s: %s and %s.",
+                mode.name,
+                self.name,
+                attr,
+                mode_attr_val,
+                self_attr_val,
             )
             sys.exit(1)
 
@@ -211,7 +222,7 @@ def get_default_mode(mode_type) -> None:
         return None
 
 
-def find_mode(mode_name: str, modes: list[Mode]) -> Mode | None:
+def find_mode(mode_name: str, modes: Sequence[Mode]) -> Mode | None:
     """Search through a list of modes and return the one with the given name.
 
     Return None if nothing was found.
@@ -222,14 +233,16 @@ def find_mode(mode_name: str, modes: list[Mode]) -> Mode | None:
     return None
 
 
-def find_mode_list(mode_names: list[str], modes: list[Mode]) -> list[Mode]:
+def find_mode_list(mode_names: Sequence[str], modes: Sequence[Mode]) -> Sequence[Mode]:
     """Find modes matching a list of names."""
     found_list = []
     for mode_name in mode_names:
         mode = find_mode(mode_name, modes)
         if mode is None:
             log.error(
-                f"Cannot find requested mode ({mode_name}) in list. Known names: {[m.name for m in modes]}",
+                "Cannot find requested mode (%s) in list. Known names: %s",
+                mode_name,
+                [m.name for m in modes],
             )
             sys.exit(1)
 
@@ -261,10 +274,10 @@ def __init__(self, bdict) -> None:
         super().__init__("build mode", bdict)
         self.en_build_modes = list(set(self.en_build_modes))
 
-    def get_sub_modes(self) -> list[str]:
+    def get_sub_modes(self) -> Sequence[str]:
         return self.en_build_modes
 
-    def set_sub_modes(self, sub_modes: list[str]) -> None:
+    def set_sub_modes(self, sub_modes: Sequence[str]) -> None:
         self.en_build_modes = sub_modes
 
     @staticmethod
@@ -300,7 +313,7 @@ def __init__(self, rdict) -> None:
     def get_sub_modes(self) -> list[str]:
         return self.en_run_modes
 
-    def set_sub_modes(self, sub_modes: list[str]) -> None:
+    def set_sub_modes(self, sub_modes: Sequence[str]) -> None:
         self.en_run_modes = sub_modes
 
     @staticmethod
diff --git a/src/dvsim/testplan.py b/src/dvsim/testplan.py
@@ -504,8 +504,10 @@ def write_testplan_doc(self, output: TextIO) -> None:
 
         if self.covergroups:
             output.write("## Covergroups\n\n")
-            for covergroup in self.covergroups:
-                output.write(f"### {covergroup.name}\n\n{covergroup.desc.strip()}\n\n")
+            output.writelines(
+                f"### {covergroup.name}\n\n{covergroup.desc.strip()}\n\n"
+                for covergroup in self.covergroups
+            )
 
     def map_test_results(self, test_results) -> None:
         """Map test results to testpoints."""
