Update ruff lint select rules

Author: saudzahirr

pyproject.toml

@@ -72,13 +72,13 @@ output-format = "grouped"
 isort.lines-after-imports = 2
 select = [
     "C",   # Complexity checks (e.g., McCabe complexity, comprehensions)
-    # "ANN001", "ANN201", "ANN401", # flake8-annotations (required strict type annotations for public functions)
+    "ANN001", "ANN201", "ANN401", # flake8-annotations (required strict type annotations for public functions)
     "S",   # flake8-bandit (checks basic security issues in code)
-    # "BLE", # flake8-blind-except (checks the except blocks that do not specify exception)
-    # "FBT", # flake8-boolean-trap (ensure that boolean args can be used with kw only)
+    "BLE", # flake8-blind-except (checks the except blocks that do not specify exception)
+    "FBT", # flake8-boolean-trap (ensure that boolean args can be used with kw only)
     "E",   # pycodestyle errors (PEP 8 style guide violations)
     "W",   # pycodestyle warnings (e.g., extra spaces, indentation issues)
-    # "DOC", # pydoclint issues (e.g., extra or missing return, yield, warnings)
+    "DOC", # pydoclint issues (e.g., extra or missing return, yield, warnings)
     "A",   # flake8-buitins (check variable and function names to not shadow builtins)
     "N",   # Naming convention checks (e.g., PEP 8 variable and function names)
     "F",   # Pyflakes errors (e.g., unused imports, undefined variables)
@@ -87,10 +87,11 @@ select = [
     "TID", # flake8-tidy-imports (Checks for banned or misplaced imports)
     "UP",  # pyupgrade (Automatically updates old Python syntax)
     "YTT", # flake8-2020 (Detects outdated Python 2/3 compatibility issues)
+    "PTH", # flake8-use-pathlib (Suggests using pathlib over os.path, open, etc.)
     "FLY", # flynt (Converts old-style string formatting to f-strings)
     "PIE", # flake8-pie
-    # "PL",  # pylint
-    # "RUF", # Ruff-specific rules (Additional optimizations and best practices)
+    "PL",  # pylint
+    "RUF", # Ruff-specific rules (Additional optimizations and best practices)
 ]
 
 ignore = [

src/lasso/diffcrash/diffcrash_run.py

@@ -9,6 +9,7 @@
 import sys
 import time
 import typing
+from collections.abc import Sequence
 from concurrent import futures
 from pathlib import Path
 from typing import Union
@@ -38,7 +39,7 @@
 ]
 
 
-def get_application_header():
+def get_application_header() -> str:
     """Prints the header of the command line tool"""
 
     return """
@@ -49,7 +50,7 @@ def get_application_header():
     """
 
 
-def str2bool(value) -> bool:
+def str2bool(value: str) -> bool:
     """Converts some value from the cmd line to a boolean
 
     Parameters
@@ -64,14 +65,14 @@ def str2bool(value) -> bool:
 
     if isinstance(value, bool):
         return value
-    if value.lower() in ("yes", "true", "t", "y", "1"):
+    if value.lower() in {"yes", "true", "t", "y", "1"}:
         return True
-    if value.lower() in ("no", "false", "f", "n", "0"):
+    if value.lower() in {"no", "false", "f", "n", "0"}:
         return False
     raise argparse.ArgumentTypeError("Boolean value expected.")
 
 
-def parse_diffcrash_args():
+def parse_diffcrash_args() -> argparse.Namespace:
     """Parse the arguments from the command line
 
     Returns
@@ -166,7 +167,7 @@ def parse_diffcrash_args():
     return parser.parse_args(sys.argv[1:])
 
 
-def run_subprocess(args):
+def run_subprocess(args: Union[list[str], str]) -> int:
     """Run a subprocess with the specified arguments
 
     Parameters:
@@ -200,10 +201,10 @@ def __init__(
         exclude_runs: typing.Sequence[str],
         diffcrash_home: str = "",
         use_id_mapping: bool = False,
-        config_file: str = None,
-        parameter_file: str = None,
+        config_file: typing.Optional[str] = None,
+        parameter_file: typing.Optional[str] = None,
         n_processes: int = 1,
-        logfile_dir: str = None,
+        logfile_dir: typing.Optional[str] = None,
     ):
         """Object handling a diffcrash run
 
@@ -251,7 +252,7 @@ def __init__(
 
         # diffcrash home
         self.diffcrash_home = Path(self._parse_diffcrash_home(diffcrash_home))
-        self.diffcrash_home = self.diffcrash_home / "bin"
+        self.diffcrash_home /= "bin"
         self.diffcrash_lib = self.diffcrash_home.parent / "lib"
 
         if platform.system() == "Linux":
@@ -310,7 +311,7 @@ def _setup_logger(self) -> logging.Logger:
 
         return logger
 
-    def _parse_diffcrash_home(self, diffcrash_home) -> str:
+    def _parse_diffcrash_home(self, diffcrash_home: str) -> str:
         diffcrash_home_ok = len(diffcrash_home) != 0
 
         msg = self._msg_option.format("diffcrash-home", diffcrash_home)
@@ -327,7 +328,7 @@ def _parse_diffcrash_home(self, diffcrash_home) -> str:
 
         return diffcrash_home
 
-    def _parse_crash_code(self, crash_code) -> str:
+    def _parse_crash_code(self, crash_code: str) -> str:
         # these guys are allowed
         valid_crash_codes = ["dyna", "radioss", "pam"]
 
@@ -344,12 +345,12 @@ def _parse_crash_code(self, crash_code) -> str:
 
         return crash_code
 
-    def _parse_reference_run(self, reference_run) -> str:
-        reference_run_ok = Path(reference_run).is_file()
+    def _parse_reference_run(self, reference_run: str) -> str:
+        reference_run_ok: bool = Path(reference_run).is_file()
 
         msg = self._msg_option.format("reference-run", reference_run)
-        print(str_info(msg))
-        self.logger.info(msg)
+        print(str_info(msg=msg))
+        self.logger.info(msg=msg)
 
         if not reference_run_ok:
             err_msg = f"Filepath '{reference_run}' is not a file."
@@ -358,14 +359,14 @@ def _parse_reference_run(self, reference_run) -> str:
 
         return reference_run
 
-    def _parse_use_id_mapping(self, use_id_mapping) -> bool:
+    def _parse_use_id_mapping(self, use_id_mapping: bool) -> bool:
         msg = self._msg_option.format("use-id-mapping", use_id_mapping)
         print(str_info(msg))
         self.logger.info(msg)
 
         return use_id_mapping
 
-    def _parse_project_dir(self, project_dir):
+    def _parse_project_dir(self, project_dir: str) -> Path:
         project_dir = Path(project_dir).resolve()
 
         msg = self._msg_option.format("project-dir", project_dir)
@@ -376,9 +377,9 @@ def _parse_project_dir(self, project_dir):
 
     def _parse_simulation_runs(
         self,
-        simulation_run_patterns: typing.Sequence[str],
+        simulation_run_patterns: Sequence[str],
         reference_run: str,
-        exclude_runs: typing.Sequence[str],
+        exclude_runs: Sequence[str],
     ):
         # search all denoted runs
         simulation_runs = []
@@ -403,10 +404,10 @@ def _parse_simulation_runs(
             simulation_runs.remove(reference_run)
 
         # sort it because we can!
-        def atoi(text):
+        def atoi(text: str) -> Union[int, str]:
             return int(text) if text.isdigit() else text
 
-        def natural_keys(text):
+        def natural_keys(text: str) -> list[Union[int, str]]:
             return [atoi(c) for c in re.split(r"(\d+)", text)]
 
         simulation_runs = sorted(simulation_runs, key=natural_keys)
@@ -435,37 +436,37 @@ def natural_keys(text):
         return simulation_runs
 
     def _parse_config_file(self, config_file) -> Union[str, None]:
-        _msg_config_file = ""
+        msg_config_file = ""
         if len(config_file) > 0 and not Path(config_file).is_file():
             config_file = None
-            _msg_config_file = f"Can not find config file '{config_file}'"
+            msg_config_file = f"Can not find config file '{config_file}'"
 
         # missing config file
         else:
             config_file = None
-            _msg_config_file = (
+            msg_config_file = (
                 "Config file missing. Consider specifying the path with the option '--config-file'."
             )
 
         msg = self._msg_option.format("config-file", config_file)
         print(str_info(msg))
         self.logger.info(msg)
 
-        if _msg_config_file:
-            print(str_warn(_msg_config_file))
-            self.logger.warning(_msg_config_file)
+        if msg_config_file:
+            print(str_warn(msg_config_file))
+            self.logger.warning(msg_config_file)
 
         return config_file
 
     def _parse_parameter_file(self, parameter_file) -> Union[None, str]:
-        _msg_parameter_file = ""
+        msg_parameter_file = ""
         if len(parameter_file) > 0 and not Path(parameter_file).is_file():
             parameter_file = None
-            _msg_parameter_file = f"Can not find parameter file '{parameter_file}'"
+            msg_parameter_file = f"Can not find parameter file '{parameter_file}'"
         # missing parameter file
         else:
             parameter_file = None
-            _msg_parameter_file = (
+            msg_parameter_file = (
                 "Parameter file missing. Consider specifying the "
                 "path with the option '--parameter-file'."
             )
@@ -474,9 +475,9 @@ def _parse_parameter_file(self, parameter_file) -> Union[None, str]:
         print(str_info(msg))
         self.logger.info(msg)
 
-        if _msg_parameter_file:
-            print(str_warn(_msg_parameter_file))
-            self.logger.warning(_msg_parameter_file)
+        if msg_parameter_file:
+            print(str_warn(msg_parameter_file))
+            self.logger.warning(msg_parameter_file)
 
         return parameter_file
 
@@ -490,7 +491,7 @@ def _parse_n_processes(self, n_processes) -> int:
 
         return n_processes
 
-    def create_project_dirs(self):
+    def create_project_dirs(self) -> None:
         """Creates all project relevant directores
 
         Notes
@@ -502,7 +503,7 @@ def create_project_dirs(self):
         os.makedirs(self.project_dir, exist_ok=True)
         os.makedirs(self.logfile_dir, exist_ok=True)
 
-    def run_setup(self, pool: futures.ThreadPoolExecutor):
+    def run_setup(self, pool: futures.ThreadPoolExecutor) -> None:
         """Run diffcrash setup
 
         Parameters
@@ -606,7 +607,7 @@ def run_setup(self, pool: futures.ThreadPoolExecutor):
         print(str_success(msg))
         self.logger.info(msg)
 
-    def run_import(self, pool: futures.ThreadPoolExecutor):
+    def run_import(self, pool: futures.ThreadPoolExecutor) -> None:
         """Run diffcrash import of runs
 
         Parameters
@@ -707,11 +708,11 @@ def run_import(self, pool: futures.ThreadPoolExecutor):
             n_failed_runs = 0
             for i_run, return_code in enumerate(return_codes):
                 if return_code != 0:
-                    _err_msg = str_error(
+                    err_msg_ = str_error(
                         f"Run {i_run} failed to import with error code '{return_code}'."
                     )
-                    print(str_error(_err_msg))
-                    self.logger.error(_err_msg)
+                    print(str_error(err_msg_))
+                    self.logger.error(err_msg_)
                     n_failed_runs += 1
 
             err_msg = f"Running Imports ... done in {time.time() - start_time:.2f}s   "
@@ -744,7 +745,7 @@ def run_import(self, pool: futures.ThreadPoolExecutor):
         # print success
         print(str_success(f"Running Imports ... done in {time.time() - start_time:.2f}s   "))
 
-    def run_math(self, pool: futures.ThreadPoolExecutor):
+    def run_math(self, pool: futures.ThreadPoolExecutor) -> None:
         """Run diffcrash math
 
         Parameters
@@ -798,7 +799,7 @@ def run_math(self, pool: futures.ThreadPoolExecutor):
         print(str_success(msg))
         self.logger.info(msg)
 
-    def run_export(self, pool: futures.ThreadPoolExecutor):
+    def run_export(self, pool: futures.ThreadPoolExecutor) -> None:
         """Run diffcrash export
 
         Parameters
@@ -890,7 +891,7 @@ def run_export(self, pool: futures.ThreadPoolExecutor):
         print(str_success(msg))
         self.logger.info(msg)
 
-    def run_matrix(self, pool: futures.ThreadPoolExecutor):
+    def run_matrix(self, pool: futures.ThreadPoolExecutor) -> None:
         """Run diffcrash matrix
 
         Parameters
@@ -954,7 +955,7 @@ def run_matrix(self, pool: futures.ThreadPoolExecutor):
         print(str_success(msg))
         self.logger.info(msg)
 
-    def run_eigen(self, pool: futures.ThreadPoolExecutor):
+    def run_eigen(self, pool: futures.ThreadPoolExecutor) -> None:
         """Run diffcrash eigen
 
         Parameters
@@ -1016,7 +1017,7 @@ def run_eigen(self, pool: futures.ThreadPoolExecutor):
         print(str_success(msg))
         self.logger.info(msg)
 
-    def run_merge(self, pool: futures.ThreadPoolExecutor):
+    def run_merge(self, pool: futures.ThreadPoolExecutor) -> None:
         """Run diffcrash merge
 
         Parameters
@@ -1167,7 +1168,7 @@ def _create_matrix_input_file(self, directory: Path) -> Path:
 
         return filepath
 
-    def clear_project_dir(self):
+    def clear_project_dir(self) -> None:
         """Clears the entire project dir"""
 
         # disable logging
@@ -1318,11 +1319,11 @@ def check_if_logfiles_show_success(self, pattern: str) -> list[str]:
             list with messages of failed log checks
         """
 
-        _msg_logfile_nok = str_error("Logfile '{0}' reports no success.")
+        msg_logfile_nok = str_error("Logfile '{0}' reports no success.")
         messages = []
 
         for filepath in self.logfile_dir.glob(pattern):
             if not self.is_logfile_successful(filepath):
-                messages.append(_msg_logfile_nok.format(filepath))
+                messages.append(msg_logfile_nok.format(filepath))
 
         return messages

src/lasso/diffcrash/run.py

@@ -39,7 +39,7 @@ def _parse_stages(start_stage: str, end_stage: str):
     return start_stage_index, end_stage_index
 
 
-def main():
+def main() -> None:
     """Main function for running diffcrash"""
 
     # parse command line stuff