.pre-commit: move from isort/black to ruff/ty

- Ruff combines and extends capabilities of both of those tools,
- add `ty` type checker hook - would likely work even better if the
  type hinting improved in the codebase, currently there are too many
  Any/Unknowns detected. Maybe consider using MonkeyType to generate
  stub files from types detected at runtime.

Signed-off-by: iwanicki92 <iwanicki92@gmail.com>

Author: iwanicki92

.codespellrc

@@ -1,3 +1,3 @@
 [codespell]
 exclude-file = .codespellx
-ignore-words-list = "FPT,FTP,fpt,ftp,checkin"
+ignore-words-list = FPT,FTP,fpt,ftp,checkin

.pre-commit-config.yaml

@@ -49,17 +49,11 @@ repos:
       - id: shellcheck
         args: ["--severity=warning"]
 
-  - repo: https://github.com/pycqa/isort
-    rev: 9.0.0b1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.0
     hooks:
-      - id: isort
-        name: isort (python)
-
-  - repo: https://github.com/psf/black
-    rev: 26.5.1
-    hooks:
-      - id: black
-        args: ["--line-length", "79"]
+      - id: ruff-check
+      - id: ruff-format
 
   - repo: https://github.com/MarketSquare/robotframework-robocop
     rev: v8.4.1
@@ -70,3 +64,9 @@ repos:
       - id: robocop-format
         additional_dependencies:
           - typing_extensions
+
+  - repo: https://github.com/astral-sh/ty-pre-commit
+    rev: v0.0.65
+    hooks:
+      - id: ty
+        args: [--isolated, --group, test, --project, osfv_cli]

osfv_cli/pyproject.toml

@@ -31,3 +31,6 @@ osfv_cli = "osfv.cli.cli:main"
 
 [tool.poetry]
 include = ["src/models/*.yml"]
+
+[tool.ruff]
+line-length = 80

osfv_cli/src/osfv/__main__.py

@@ -1,6 +1,6 @@
 import sys
 
 if __name__ == "__main__":
-    from osfv.osfv_cli.osfv_cli import main
+    from osfv.cli.cli import main
 
     sys.exit(main())

osfv_cli/src/osfv/cli/cli.py

@@ -13,13 +13,14 @@
 import pexpect
 import requests
 import typer
+from typer import Argument, Context, Option
+
 from osfv.libs import utils
 from osfv.libs.models import Models
 from osfv.libs.rte import RTE
 from osfv.libs.snipeit_api import SnipeIT
 from osfv.libs.sonoff_api import SonoffDevice
 from osfv.libs.zabbix import Zabbix
-from typer import Argument, Context, Option
 
 
 class API:
@@ -461,9 +462,7 @@ def update_zabbix_assets():
             for s in forbidden_symbols:
                 new_key = new_key.replace(s, "_")
 
-            snipeit_assets[new_key] = snipeit_assets.pop(
-                snipeit_assets_keys[i]
-            )
+            snipeit_assets[new_key] = snipeit_assets.pop(snipeit_assets_keys[i])
 
     if snipeit_configuration_error:
         print(
@@ -486,9 +485,7 @@ def update_zabbix_assets():
     ):
         update_available = True
 
-    common_keys = set(snipeit_assets.keys()) & set(
-        current_zabbix_assets.keys()
-    )
+    common_keys = set(snipeit_assets.keys()) & set(current_zabbix_assets.keys())
 
     if keys_not_present_in_zabbix.__len__() > 0:
         print("Assets not present in Zabbix (these will be added):")
@@ -1068,9 +1065,7 @@ def flash_write(
     ] = Path("write.rom"),
     bios: Annotated[
         bool,
-        Option(
-            "--bios", "-b", help='Adds "-i bios --ifd" to flashrom command'
-        ),
+        Option("--bios", "-b", help='Adds "-i bios --ifd" to flashrom command'),
     ] = False,
     dry_mecheck: Annotated[
         bool,
@@ -1119,23 +1114,17 @@ def flash_erase(ctx):
 ## sonoff commands
 
 
-def sonoff_setup(
-    sonoff_ip: str | None, rte_ip: str | None
-) -> tuple[bool, int]:
+def sonoff_setup(sonoff_ip: str | None, rte_ip: str | None) -> tuple[bool, int]:
     if not sonoff_ip:
         if not rte_ip:
             print("Either sonoff_ip or rte_ip is required")
             raise typer.Exit(1)
-        sonoff_ip = apis.get_or_create_snipeit().get_sonoff_ip_by_rte_ip(
-            rte_ip
-        )
+        sonoff_ip = apis.get_or_create_snipeit().get_sonoff_ip_by_rte_ip(rte_ip)
         if not sonoff_ip:
             print(f"No Sonoff Device found with RTE IP: {rte_ip}")
             raise typer.Exit(1)
 
-    asset_id = apis.get_or_create_snipeit().get_asset_id_by_sonoff_ip(
-        sonoff_ip
-    )
+    asset_id = apis.get_or_create_snipeit().get_asset_id_by_sonoff_ip(sonoff_ip)
     if asset_id is None:
         print(f"No asset found with Sonoff IP: {sonoff_ip}")
         raise typer.Exit(1)
@@ -1382,9 +1371,7 @@ def get_zabbix_compatible_assets_from_asset(asset):
             if field_name in ["RTE IP", "Sonoff IP", "PiKVM IP"]:
                 field_value = field_data.get("value")
                 if field_value:
-                    key = f"{asset['asset_tag']}_{field_name}".replace(
-                        " ", "_"
-                    )
+                    key = f"{asset['asset_tag']}_{field_name}".replace(" ", "_")
                     result[key] = field_value
     return result
 

osfv_cli/src/osfv/libs/flash_image.py

@@ -1,12 +1,12 @@
 import os
 import struct
-import sys
+from collections.abc import Sequence
 from itertools import repeat
 
 
 class FlashImage:
     # based on flashrom/utils/ich_descriptor_tool.c
-    REGION_INDICES = [
+    REGION_INDICES: Sequence[str] = (
         "fd",
         "bios",
         "me",
@@ -23,7 +23,7 @@ class FlashImage:
         "reg13",
         "reg14",
         "reg15",
-    ]
+    )
     NUMBER_OF_REGIONS = len(REGION_INDICES)
     FLVALSIG = 0x0FF0A55A
 
@@ -40,7 +40,7 @@ def get_exit_code(self):
         return self.EXIT_CODE
 
     def get_image_data(self):
-        return imageData
+        return self.imageData
 
     def get_region_index(self, region_name):
         try:
@@ -85,9 +85,7 @@ def load_image_file(self, image_path):
 
             FLMAP0 = struct.unpack(
                 "<I",
-                self.imageData[
-                    (valsig_offset + 0x04) : (valsig_offset + 0x08)
-                ],
+                self.imageData[(valsig_offset + 0x04) : (valsig_offset + 0x08)],
             )[0x00]
             FRBA = (FLMAP0 >> 0x0C) & 0x00000FF0
 
@@ -98,9 +96,7 @@ def load_image_file(self, image_path):
             region_format = f"<{self.NUMBER_OF_REGIONS}I"
             self.REGIONS = struct.unpack(
                 region_format,
-                self.imageData[
-                    FRBA : (FRBA + (0x04 * self.NUMBER_OF_REGIONS))
-                ],
+                self.imageData[FRBA : (FRBA + (0x04 * self.NUMBER_OF_REGIONS))],
             )
             return True
 

osfv_cli/src/osfv/libs/models.py

@@ -1,8 +1,8 @@
 import os
 import sys
-import time
 from pathlib import Path
 
+import voluptuous
 import yaml
 from importlib_resources import files
 from voluptuous import Any, Optional, Required, Schema
@@ -13,7 +13,7 @@ def __init__(self):
         pass
 
     def list_models(self):
-        print(f"Supported DUT models:")
+        print("Supported DUT models:")
         file_path = os.path.join(files("osfv"), "models")
 
         for roots, dirs, filenames in os.walk(file_path):
@@ -44,9 +44,7 @@ def load_model_data(self, dut_model, exit_on_failure=True):
         if not os.path.isfile(file_path):
             if exit_on_failure:
                 raise UnsupportedDUTModel(
-                    "The {file_path} model is not yet supported".format(
-                        file_path=dut_model
-                    )
+                    f"The {dut_model} model is not yet supported"
                 )
             else:
                 model_YML_status = False
@@ -95,9 +93,9 @@ def load_model_data(self, dut_model, exit_on_failure=True):
 
         try:
             schema(data)
-        except Exception as e:
+        except voluptuous.Error as e:
             if exit_on_failure:
-                exit(f"Model file is invalid: {e}")
+                sys.exit(f"Model file is invalid: {e}")
             else:
                 model_YML_status = False
 
@@ -119,9 +117,8 @@ def load_model_data(self, dut_model, exit_on_failure=True):
                     current_field = current_field[key]
                 else:
                     if exit_on_failure:
-                        exit(
-                            f"Required field '{field}' is missing in model "
-                            f"config."
+                        sys.exit(
+                            f"Required field '{field}' is missing in model config."
                         )
                     else:
                         model_YML_status = False

osfv_cli/src/osfv/libs/rte.py

@@ -4,11 +4,10 @@
 
 import paramiko
 import requests
-import yaml
-from importlib_resources import files
+
 from osfv.libs.models import Models
 from osfv.libs.rtectrl_api import rtectrl
-from voluptuous import Any, Optional, Required, Schema
+from osfv.libs.utils import OSFVException
 
 
 class RTE(rtectrl):
@@ -46,9 +45,8 @@ def __init__(self, rte_ip, dut_model, sonoff):
         self.sonoff = sonoff
         if not self.sonoff_sanity_check():
             raise SonoffNotFound(
-                exit(
-                    f"Missing value for 'sonoff_ip' or Sonoff not found "
-                    f"in SnipeIT"
+                sys.exit(
+                    "Missing value for 'sonoff_ip' or Sonoff not found in SnipeIT"
                 )
             )
 
@@ -202,12 +200,12 @@ def psu_on(self):
             self.sonoff.turn_on()
             state = self.sonoff.get_state()
             if state != self.PSU_STATE_ON:
-                raise Exception("Failed to power control ON")
+                raise OSFVException("Failed to power control ON")
         elif self.dut_data["pwr_ctrl"]["relay"] is True:
             self.relay_set(self.PSU_STATE_ON)
             state = self.relay_get()
             if state != self.PSU_STATE_ON:
-                raise Exception("Failed to power control ON")
+                raise OSFVException("Failed to power control ON")
         time.sleep(5)
 
     def psu_off(self):
@@ -226,12 +224,12 @@ def psu_off(self):
             self.sonoff.turn_off()
             state = self.sonoff.get_state()
             if state != self.PSU_STATE_OFF:
-                raise Exception("Failed to power control OFF")
+                raise OSFVException("Failed to power control OFF")
         elif self.dut_data["pwr_ctrl"]["relay"] is True:
             self.relay_set(self.PSU_STATE_OFF)
             state = self.relay_get()
             if state != self.PSU_STATE_OFF:
-                raise Exception("Failed to power control OFF")
+                raise OSFVException("Failed to power control OFF")
         time.sleep(2)
 
     def psu_get(self):
@@ -302,7 +300,7 @@ def pwr_ctrl_before_flash(self, programmer, power_state):
             if self.dut_data["pwr_ctrl"]["discharge_psu"]:
                 self.discharge_psu()
         else:
-            exit(
+            sys.exit(
                 f"Power state: '{power_state}' is not supported. Please check "
                 f"model config."
             )
@@ -341,11 +339,11 @@ def create_layout_file(self):
             layout_content += f"{region['range']} {region['name']}\n"
 
         # Create temporary file
-        temp_file = tempfile.NamedTemporaryFile(
+        with tempfile.NamedTemporaryFile(
             mode="w", suffix=".txt", delete=False
-        )
-        temp_file.write(layout_content)
-        temp_file.close()
+        ) as temp_file:
+            temp_file.write(layout_content)
+            temp_file.close()
 
         return temp_file.name
 
@@ -476,12 +474,14 @@ def flash_create_args(self, extra_args=""):
         args = ""
 
         # Set chip explicitly, if defined in model configuration
-        if "flash_chip" in self.dut_data:
-            if "model" in self.dut_data["flash_chip"]:
-                args = " ".join(["-c", self.dut_data["flash_chip"]["model"]])
+        if (
+            "flash_chip" in self.dut_data
+            and "model" in self.dut_data["flash_chip"]
+        ):
+            args = " ".join(["-c", self.dut_data["flash_chip"]["model"]])
 
         if extra_args:
-            args = " ".join([args, extra_args])
+            args = f"{args} {extra_args}"
 
         return args
 
@@ -522,7 +522,7 @@ def flash_erase(self):
         Returns:
             int: The return code from the flashrom command execution.
         """
-        args = self.flash_create_args(f"-E")
+        args = self.flash_create_args("-E")
         return self.flash_cmd(args)
 
     def flash_write(self, write_file, bios=False):
@@ -557,9 +557,11 @@ def flash_write(self, write_file, bios=False):
         rc = self.flash_cmd(args, write_file=write_file)
         time.sleep(2)
 
-        if "reset_cmos" in self.dut_data:
-            if self.dut_data["reset_cmos"] == True:
-                self.reset_cmos()
+        if (
+            "reset_cmos" in self.dut_data
+            and self.dut_data["reset_cmos"] == True
+        ):
+            self.reset_cmos()
         return rc
 
     def sonoff_sanity_check(self):