ci: introduce ruff as linter (#381)

This PR introduces to use ruff as python linter in the project, like pre-commit.
It replaces the use of isort, flake8 and related plugins and only use ruff as the only tools to lint the code, while more plugins are introduced, see pyproject.ruff.lint.select for all selected rules set.
As the first time of introducing this tool, a whole fixes to the detected issues are also introduced in this PR. No changes of features or behaviors are introduced.

.pre-commit-config.yaml

@@ -8,6 +8,11 @@ repos:
       - id: check-toml
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.2
+    hooks:
+      - id: ruff
+        args: [--fix]
   # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
   - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 24.4.2
@@ -18,24 +23,6 @@ repos:
         # pre-commit's default_language_version, see
         # https://pre-commit.com/#top_level-default_language_version
         language_version: python3.11
-  # - repo: https://github.com/pycqa/isort
-  #   rev: 5.13.2
-  #   hooks:
-  #     - id: isort
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.1.1
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-bugbear==24.2.6
-          - flake8-comprehensions
-          - flake8-simplify
-  - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: "2.2.1"
-    hooks:
-      - id: pyproject-fmt
-        # https://pyproject-fmt.readthedocs.io/en/latest/#calculating-max-supported-python-version
-        additional_dependencies: ["tox>=4.9"]
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.41.0
     hooks:

pyproject.toml

@@ -43,12 +43,11 @@ dependencies = [
 optional-dependencies.dev = [
   "black",
   "coverage",
-  "flake8",
-  "isort",
   "pytest==7.1.2",
   "pytest-asyncio==0.23.8",
   "pytest-mock==3.14",
   "requests-mock",
+  "ruff",
 ]
 urls.Source = "https://github.com/tier4/ota-client"
 
@@ -85,22 +84,6 @@ features = [
   "dev",
 ]
 
-[tool.black]
-line-length = 88
-target-version = [
-  'py38',
-]
-extend-exclude = '''(
-  ^.*(_pb2.pyi?|_pb2_grpc.pyi?)$
-)'''
-
-[tool.isort]
-profile = "black"
-extend_skip_glob = [
-  "*_pb2.py*",
-  "_pb2_grpc.py*",
-]
-
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
 log_auto_indent = true
@@ -111,6 +94,18 @@ testpaths = [
   "./tests",
 ]
 
+[tool.black]
+line-length = 88
+target-version = [
+  'py38',
+  'py39',
+  'py310',
+  'py311',
+]
+extend-exclude = '''(
+  ^.*(_pb2.pyi?|_pb2_grpc.pyi?)$
+)'''
+
 [tool.coverage.run]
 branch = false
 relative_files = true
@@ -142,7 +137,40 @@ exclude = [
   "**/__pycache__",
 ]
 ignore = [
+  "proto/**",
   "**/*_pb2.py*",
   "**/*_pb2_grpc.py*",
 ]
 pythonVersion = "3.8"
+
+[tool.ruff]
+target-version = "py38"
+# NOTE: not include tests and tools for now
+include = [
+  "tests/**/*.py",
+  "src/**/*.py",
+  "pyproject.toml",
+]
+extend-exclude = [
+  "*_pb2.py*",
+  "*_pb2_grpc.py*",
+]
+
+[tool.ruff.lint]
+select = [
+  "E4",
+  "E7",
+  "E9",
+  "F",   # pyflakes
+  "Q",   # flake8-quotes
+  "I",   # isort
+  "B",   # flake8-bugbear
+  "A",   # flake8-builtins
+  "ICN", # flake8-import-conventions
+]
+ignore = [
+  "E266", # (too many leading '#'): sometimes we use multiple # for separting sections
+  "E203", # (white space before ':'): this error conflicts with black linting
+  "E701", # (multiple statements on one line)
+  "S101", # (use of assert): mostly we use assert for typing
+]

src/ota_metadata/legacy/parser.py

@@ -197,7 +197,7 @@ def __set__(self, obj, value: Any) -> None:
                 except KeyError:
                     raise ValueError(
                         f"invalid metafile field {self.field_name}: {value}"
-                    )
+                    ) from None
             # normal key-value field
             else:
                 try:
@@ -208,7 +208,7 @@ def __set__(self, obj, value: Any) -> None:
                 except KeyError:
                     raise ValueError(
                         f"invalid metafile field {self.field_name}: {value}"
-                    )
+                    ) from None
         raise ValueError(f"attempt to assign invalid {value=} to {self.field_name=}")
 
     def __set_name__(self, owner: type, name: str):

src/otaclient/app/ota_client_stub.py

@@ -28,9 +28,8 @@
 
 from typing_extensions import Self
 
-from ota_proxy import OTAProxyContextProto
+from ota_proxy import OTAProxyContextProto, subprocess_otaproxy_launcher
 from ota_proxy import config as local_otaproxy_cfg
-from ota_proxy import subprocess_otaproxy_launcher
 from otaclient import log_setting
 from otaclient.boot_control._common import CMDHelperFuncs
 from otaclient.configs.ecu_info import ECUContact

src/otaclient/boot_control/_common.py

@@ -764,7 +764,9 @@ def preserve_ota_folder_to_standby(self):
             _dst = self.standby_slot_mount_point / Path(cfg.OTA_DIR).relative_to("/")
             shutil.copytree(_src, _dst, dirs_exist_ok=True)
         except Exception as e:
-            raise ValueError(f"failed to copy /boot/ota from active to standby: {e!r}")
+            raise ValueError(
+                f"failed to copy /boot/ota from active to standby: {e!r}"
+            ) from e
 
     def prepare_standby_dev(
         self,

src/otaclient/boot_control/_grub.py

@@ -267,7 +267,7 @@ def grub_mkconfig() -> str:
         except CalledProcessError as e:
             raise ValueError(
                 f"grub-mkconfig failed: {e.returncode=}, {e.stderr=}, {e.stdout=}"
-            )
+            ) from None
 
     @staticmethod
     def grub_reboot(idx: int):

src/otaclient/boot_control/_jetson_cboot.py

@@ -99,7 +99,9 @@ def is_unified_enabled(cls) -> bool | None:
                 return False
             elif e.returncode == 69:
                 return
-            raise ValueError(f"{cmd} returns unexpected result: {e.returncode=}, {e!r}")
+            raise ValueError(
+                f"{cmd} returns unexpected result: {e.returncode=}, {e!r}"
+            ) from None
 
 
 class NVUpdateEngine:
@@ -189,7 +191,7 @@ def __init__(self):
         except Exception as e:
             _err_msg = f"failed to detect BSP version: {e!r}"
             logger.error(_err_msg)
-            raise JetsonCBootContrlError(_err_msg)
+            raise JetsonCBootContrlError(_err_msg) from None
         logger.info(f"{bsp_version=}")
 
         # ------ sanity check, jetson-cboot is not used after BSP R34 ------ #
@@ -218,7 +220,7 @@ def __init__(self):
             except subprocess.CalledProcessError:
                 _err_msg = "rootfs A/B is not enabled!"
                 logger.error(_err_msg)
-                raise JetsonCBootContrlError(_err_msg)
+                raise JetsonCBootContrlError(_err_msg) from None
         self.unified_ab_enabled = unified_ab_enabled
 
         if unified_ab_enabled:

src/otaclient/boot_control/_rpi_boot.py

@@ -152,7 +152,7 @@ def __init__(self) -> None:
         except Exception as e:
             _err_msg = f"failed to detect partition layout: {e!r}"
             logger.error(_err_msg)
-            raise _RPIBootControllerError(_err_msg)
+            raise _RPIBootControllerError(_err_msg) from None
 
         # check system-boot partition mount
         system_boot_partition = device_tree[1]
@@ -185,7 +185,7 @@ def __init__(self) -> None:
         except ValueError:
             raise _RPIBootControllerError(
                 f"active slot dev not found: {active_slot_dev=}, {rootfs_partitions=}"
-            )
+            ) from None
 
         if idx == 0:  # slot_a
             self.active_slot = SLOT_A
@@ -335,7 +335,7 @@ def update_firmware(self, *, target_slot: SlotID, target_slot_mp: StrOrPath):
         except subprocess.CalledProcessError as e:
             _err_msg = f"flash-kernel failed: {e!r}\nstderr: {e.stderr.decode()}\nstdout: {e.stdout.decode()}"
             logger.error(_err_msg)
-            raise _RPIBootControllerError(_err_msg)
+            raise _RPIBootControllerError(_err_msg) from None
 
         try:
             # flash-kernel will install the kernel and initrd.img files from /boot to /boot/firmware
@@ -359,7 +359,7 @@ def update_firmware(self, *, target_slot: SlotID, target_slot_mp: StrOrPath):
         except Exception as e:
             _err_msg = f"failed to apply new kernel,initrd.img for {target_slot}: {e!r}"
             logger.error(_err_msg)
-            raise _RPIBootControllerError(_err_msg)
+            raise _RPIBootControllerError(_err_msg) from None
 
     # exposed API methods/properties
 

src/otaclient_api/v2/api_caller.py

@@ -44,7 +44,7 @@ async def status_call(
                 return types.StatusResponse.convert(resp)
         except Exception as e:
             _msg = f"{ecu_id=} failed to respond to status request on-time: {e!r}"
-            raise ECUNoResponse(_msg)
+            raise ECUNoResponse(_msg) from e
 
     @staticmethod
     async def update_call(
@@ -63,7 +63,7 @@ async def update_call(
                 return types.UpdateResponse.convert(resp)
         except Exception as e:
             _msg = f"{ecu_id=} failed to respond to update request on-time: {e!r}"
-            raise ECUNoResponse(_msg)
+            raise ECUNoResponse(_msg) from e
 
     @staticmethod
     async def rollback_call(
@@ -82,4 +82,4 @@ async def rollback_call(
                 return types.RollbackResponse.convert(resp)
         except Exception as e:
             _msg = f"{ecu_id=} failed to respond to rollback request on-time: {e!r}"
-            raise ECUNoResponse(_msg)
+            raise ECUNoResponse(_msg) from e

src/otaclient_common/__init__.py

@@ -72,4 +72,4 @@ def import_from_file(path: Path) -> tuple[str, ModuleType]:
         _spec.loader.exec_module(_module)  # type: ignore
         return _module_name, _module
     except Exception:
-        raise ImportError(f"failed to import module from {path=}.")
+        raise ImportError(f"failed to import module from {path=}.") from None

src/otaclient_common/common.py

@@ -91,13 +91,13 @@ def read_str_from_file(path: Union[Path, str], *, missing_ok=True, default="") -
         raise
 
 
-def write_str_to_file(path: Path, input: str):
-    path.write_text(input)
+def write_str_to_file(path: Path, _input: str):
+    path.write_text(_input)
 
 
-def write_str_to_file_sync(path: Union[Path, str], input: str):
+def write_str_to_file_sync(path: Union[Path, str], _input: str):
     with open(path, "w") as f:
-        f.write(input)
+        f.write(_input)
         f.flush()
         os.fsync(f.fileno())
 

src/otaclient_common/downloader.py

@@ -110,7 +110,7 @@ def iter_chunk(self, src_stream: IO[bytes] | ByteString) -> Iterator[bytes]:
         except zstandard.ZstdError as e:
             raise BrokenDecompressionError(
                 f"failure during decompressing file stream: {e!r}"
-            )
+            ) from e
 
 
 # ------ OTA-Cache-File-Control protocol implementation ------ #
@@ -557,7 +557,7 @@ def shutdown(self) -> None:
         """Close all the downloader instances."""
         # at final, trigger an update to the total_downloaded_bytes, in case
         #   we still need the total_downloaded_bytes data after pool shutdown.
-        self.total_downloaded_bytes
+        _ = self.total_downloaded_bytes
 
         with self._instance_map_lock:
             for _instance in self._instances:

src/otaclient_common/linux.py

@@ -30,7 +30,7 @@
 
 
 def create_swapfile(
-    swapfile_fpath: str | Path, size_in_MiB: int, *, timeout=900
+    swapfile_fpath: str | Path, size_in_mibytes: int, *, timeout=900
 ) -> Path:
     """Create swapfile at <swapfile_fpath> with <size_in_MiB>MiB.
 
@@ -62,7 +62,7 @@ def create_swapfile(
             "if=/dev/zero",
             f"of={str(swapfile_fpath)}",
             "bs=1M",
-            f"count={size_in_MiB}",
+            f"count={size_in_mibytes}",
         ],
         timeout=timeout,
     )
@@ -106,7 +106,7 @@ def __init__(self, passwd_fpath: str | Path) -> None:
                     self._by_name[_name] = _uid
             self._by_uid = {v: k for k, v in self._by_name.items()}
         except Exception as e:
-            raise ValueError(f"invalid or missing {passwd_fpath=}: {e!r}")
+            raise ValueError(f"invalid or missing {passwd_fpath=}: {e!r}") from None
 
 
 class ParsedGroup:
@@ -131,7 +131,7 @@ def __init__(self, group_fpath: str | Path) -> None:
                     self._by_name[_raw_list[0]] = int(_raw_list[2])
             self._by_gid = {v: k for k, v in self._by_name.items()}
         except Exception as e:
-            raise ValueError(f"invalid or missing {group_fpath=}: {e!r}")
+            raise ValueError(f"invalid or missing {group_fpath=}: {e!r}") from None
 
 
 def map_uid_by_pwnam(*, src_db: ParsedPasswd, dst_db: ParsedPasswd, uid: int) -> int:
@@ -143,7 +143,7 @@ def map_uid_by_pwnam(*, src_db: ParsedPasswd, dst_db: ParsedPasswd, uid: int) ->
     try:
         return dst_db._by_name[src_db._by_uid[uid]]
     except KeyError:
-        raise ValueError(f"failed to find mapping for {uid}")
+        raise ValueError(f"failed to find mapping for {uid}") from None
 
 
 def map_gid_by_grpnam(*, src_db: ParsedGroup, dst_db: ParsedGroup, gid: int) -> int:
@@ -155,7 +155,7 @@ def map_gid_by_grpnam(*, src_db: ParsedGroup, dst_db: ParsedGroup, gid: int) ->
     try:
         return dst_db._by_name[src_db._by_gid[gid]]
     except KeyError:
-        raise ValueError(f"failed to find mapping for {gid}")
+        raise ValueError(f"failed to find mapping for {gid}") from None
 
 
 #