refine: apply pre-commit fixes (#298)

This PR applies the changes suggested by the following pre-commit hooks:
1. (autofix applied) pre-commit-hooks(end-of-file-fixer and trailing-whitespace)
2. (autofix applied) black
3. (manual fixes) flake8
4. (autofix applied) isort
5. (autofix applied) pyproject-fmt
6. (autofix applied) markdownlint-cli
The pre-commit.ci check is green after all the fixes applied. The already available configurations for each tools are respected.

.flake8

@@ -7,5 +7,8 @@ max-line-length = 88
 #       this error conflicts with black linting
 #   E501(line is too long):
 #       TODO: deal with it in the future
-extend-ignore = E266, E501, E203
+#   E701(multiple statements on one line)
+extend-ignore = E266, E501, E203, E701
 extend-exclude = *_pb2.py*, *_pb2_grpc.py*
+# TODO: ignore tools and tests for now
+exclude = tools/**, tests/**, proto/**

.github/PULL_REQUEST_TEMPLATE.md

@@ -8,4 +8,4 @@ This is the main entry for selecting a template for your PR.
 
 If PR type is not in the above list, feel free to start from blank PR body.
 
-** DON'T INCLUDE THIS PAGE'S CONTENTS IN YOUR PR BODY. **
+**DON'T INCLUDE THIS PAGE'S CONTENTS IN YOUR PR BODY.**

.github/PULL_REQUEST_TEMPLATE/feature.md

@@ -14,7 +14,6 @@ For better understanding, adding reason/motivation of this PR are also recommend
 - [ ] local test is passed.
 - [ ] design docs/implementation docs are prepared.
 
-
 ## Documents
 
 <!-- For feature PR, design document is required. -->
@@ -42,6 +41,7 @@ Does this PR introduce behavior change(s)?
 ## Breaking change
 
 Does this PR introduce breaking change?
+
 - [ ] Yes.
 - [ ] No.
 

.github/PULL_REQUEST_TEMPLATE/refinement.md

@@ -35,6 +35,7 @@ Does this PR introduce behavior change(s)?
 ## Breaking change
 
 Does this PR introduce breaking change?
+
 - [ ] Yes.
 - [ ] No.
 

.github/workflows/test.yaml

@@ -4,10 +4,6 @@ on:
   pull_request:
     branches:
       - main
-    paths:
-      - "otaclient/**"
-      - "tests/**"
-      - ".github/workflows/test.yaml"
   push:
     branches:
       - main
@@ -47,42 +43,3 @@ jobs:
         with:
           pytest-xml-coverage-path: test_result/coverage.xml
           junitxml-path: test_result/pytest.xml
-
-  python_lint_check:
-    runs-on: ubuntu-20.04
-    timeout-minutes: 3
-    strategy:
-      matrix:
-        python-version: [3.8]
-    steps:
-      - name: Checkout commit
-        uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install test dependencies
-        run: |
-          python -m pip install -q --upgrade pip
-          python -m pip install -q -r tests/requirements.txt
-      - name: Lint codes without modification
-        run: |
-          $pythonLocation/bin/python -m black ./otaclient --check
-      - name: Lint codes for syntax check
-        run: |
-          $pythonLocation/bin/python -m flake8 ./otaclient
-
-  markdown_lint_check:
-    runs-on: ubuntu-20.04
-    timeout-minutes: 3
-    steps:
-      - name: Checkout commit
-        uses: actions/checkout@v3
-      - name: markdownlint-cli
-        uses: nosborn/[email protected]
-        with:
-          files: .
-          config_file: .markdownlint.yaml
-          ignore_files: .markdownlintignore
-          #ignore_path: examples/.markdownlintignore
-          #rules: examples/rules/custom.js

.markdownlint.yaml

@@ -1,3 +1,4 @@
 "MD013": false
+"MD041": false
 "MD024":
   "siblings_only": true

.pre-commit-config.yaml

@@ -2,14 +2,8 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
     hooks:
-      - id: detect-private-key
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.10.0
-    hooks:
-      - id: python-check-mock-methods
-      - id: python-use-type-annotations
   # 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
@@ -38,5 +32,16 @@ repos:
       - id: pyproject-fmt
         # https://pyproject-fmt.readthedocs.io/en/latest/#calculating-max-supported-python-version
         additional_dependencies: ["tox>=4.9"]
+  # - repo: https://github.com/codespell-project/codespell
+  #   rev: v2.2.4
+  #   hooks:
+  #     - id: codespell
+  #       additional_dependencies:
+  #         - tomli
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.40.0
+    hooks:
+      - id: markdownlint
+        args: ["-c", ".markdownlint.yaml", "--fix"]
 ci:
   autoupdate_schedule: monthly

otaclient/app/boot_control/_common.py

@@ -16,15 +16,20 @@
 
 from __future__ import annotations
 
+import contextlib
 import logging
 import shutil
 import sys
 from pathlib import Path
 from subprocess import CalledProcessError
 from typing import Callable, Literal, NoReturn, Optional, Union
 
-from ..common import (read_str_from_file, subprocess_call,
-                      subprocess_check_output, write_str_to_file_sync)
+from ..common import (
+    read_str_from_file,
+    subprocess_call,
+    subprocess_check_output,
+    write_str_to_file_sync,
+)
 from ..configs import config as cfg
 from ..proto import wrapper
 
@@ -554,10 +559,9 @@ def _load_current_status(self) -> Optional[wrapper.StatusOta]:
         if _status_str := read_str_from_file(
             self.current_ota_status_dir / cfg.OTA_STATUS_FNAME
         ).upper():
-            try:
+            with contextlib.suppress(KeyError):
+                # invalid status string
                 return wrapper.StatusOta[_status_str]
-            except KeyError:
-                pass  # invalid status string
 
     # version control
 

otaclient/app/boot_control/_grub.py

@@ -43,11 +43,20 @@
 from typing import ClassVar, Dict, Generator, List, Optional, Tuple
 
 from .. import errors as ota_errors
-from ..common import (re_symlink_atomic, read_str_from_file, subprocess_call,
-                      subprocess_check_output, write_str_to_file_sync)
+from ..common import (
+    re_symlink_atomic,
+    read_str_from_file,
+    subprocess_call,
+    subprocess_check_output,
+    write_str_to_file_sync,
+)
 from ..proto import wrapper
-from ._common import (CMDHelperFuncs, OTAStatusFilesControl, SlotMountHelper,
-                      cat_proc_cmdline)
+from ._common import (
+    CMDHelperFuncs,
+    OTAStatusFilesControl,
+    SlotMountHelper,
+    cat_proc_cmdline,
+)
 from .configs import grub_cfg as cfg
 from .protocol import BootControllerProtocol
 
@@ -160,20 +169,19 @@ def update_entry_rootfs(
             entry_l, entry_r = entry.span()
             entry_block = entry.group()
             # parse the entry block
-            if _linux := cls.linux_pa.search(entry_block):
-                if _linux.group("ver") == kernel_ver:
-                    linux_line_l, linux_line_r = _linux.span()
-                    _new_linux_line, _count = cls.rootfs_pa.subn(
-                        rootfs_str, _linux.group()
+            if (_linux := cls.linux_pa.search(entry_block)) and _linux.group(
+                "ver"
+            ) == kernel_ver:
+                linux_line_l, linux_line_r = _linux.span()
+                _new_linux_line, _count = cls.rootfs_pa.subn(rootfs_str, _linux.group())
+                if _count == 1:
+                    # replace rootfs string
+                    new_entry_block = (
+                        f"{entry_block[:linux_line_l]}"
+                        f"{_new_linux_line}"
+                        f"{entry_block[linux_line_r:]}"
                     )
-                    if _count == 1:
-                        # replace rootfs string
-                        new_entry_block = (
-                            f"{entry_block[:linux_line_l]}"
-                            f"{_new_linux_line}"
-                            f"{entry_block[linux_line_r:]}"
-                        )
-                        break
+                    break
 
         if new_entry_block is not None:
             updated_grub_cfg = (
@@ -200,9 +208,10 @@ def get_entry(cls, grub_cfg: str, *, kernel_ver: str) -> Tuple[int, _GrubMenuEnt
               recovery entry).
         """
         for index, entry_ma in enumerate(cls.menuentry_pa.finditer(grub_cfg)):
-            if _linux := cls.linux_pa.search(entry_ma.group()):
-                if kernel_ver == _linux.group("ver"):
-                    return index, _GrubMenuEntry(entry_ma)
+            if (
+                _linux := cls.linux_pa.search(entry_ma.group())
+            ) and kernel_ver == _linux.group("ver"):
+                return index, _GrubMenuEntry(entry_ma)
 
         raise ValueError(f"requested entry for {kernel_ver} not found")
 
@@ -331,13 +340,12 @@ def _get_sibling_dev(self, active_dev: str) -> str:
         # FSTYPE="ext4" and
         # not (parent_device_file, root_device_file and boot_device_file)
         for blk in output:
-            if m := re.search(r'NAME="(.*)"\s+FSTYPE="(.*)"', blk):
-                if (
-                    m.group(1) != active_dev
-                    and m.group(1) != boot_dev
-                    and m.group(2) == "ext4"
-                ):
-                    return m.group(1)
+            if (m := re.search(r'NAME="(.*)"\s+FSTYPE="(.*)"', blk)) and (
+                m.group(1) != active_dev
+                and m.group(1) != boot_dev
+                and m.group(2) == "ext4"
+            ):
+                return m.group(1)
 
         _err_msg = f"{parent=} has unexpected partition layout: {output=}"
         logger.error(_err_msg)

otaclient/app/boot_control/_jetson_cboot.py

@@ -28,8 +28,11 @@
 from typing_extensions import Annotated, Self
 
 from otaclient.app import errors as ota_errors
-from otaclient.app.common import (copytree_identical, subprocess_run_wrapper,
-                                  write_str_to_file_sync)
+from otaclient.app.common import (
+    copytree_identical,
+    subprocess_run_wrapper,
+    write_str_to_file_sync,
+)
 from otaclient.app.proto import wrapper
 
 from ._common import CMDHelperFuncs, OTAStatusFilesControl, SlotMountHelper

otaclient/app/boot_control/_rpi_boot.py

@@ -26,8 +26,12 @@
 from .. import errors as ota_errors
 from ..common import replace_atomic, subprocess_call, subprocess_check_output
 from ..proto import wrapper
-from ._common import (CMDHelperFuncs, OTAStatusFilesControl, SlotMountHelper,
-                      write_str_to_file_sync)
+from ._common import (
+    CMDHelperFuncs,
+    OTAStatusFilesControl,
+    SlotMountHelper,
+    write_str_to_file_sync,
+)
 from .configs import rpi_boot_cfg as cfg
 from .protocol import BootControllerProtocol
 
@@ -118,12 +122,10 @@ def _init_slots_info(self):
 
             try:
                 # NOTE: exclude the first 2 lines(parent and system-boot)
-                _child_partitions = list(
-                    map(
-                        lambda _raw: _raw.split("=")[-1].strip('"'),
-                        _raw_child_partitions.splitlines()[2:],
-                    )
-                )
+                _child_partitions = [
+                    raw.split("=")[-1].strip('"')
+                    for raw in _raw_child_partitions.splitlines()[2:]
+                ]
                 if (
                     len(_child_partitions) != 2
                     or self._active_slot_dev not in _child_partitions

otaclient/app/common.py

@@ -29,14 +29,28 @@
 from hashlib import sha256
 from pathlib import Path
 from queue import Queue
-from typing import (Any, Callable, Generator, Generic, Iterable, NamedTuple,
-                    Optional, Set, TypeVar, Union)
+from typing import (
+    Any,
+    Callable,
+    Generator,
+    Generic,
+    Iterable,
+    NamedTuple,
+    Optional,
+    Set,
+    TypeVar,
+    Union,
+)
 from urllib.parse import urljoin
 
 import requests
 
-from otaclient._utils.linux import (ParsedGroup, ParsedPasswd,
-                                    map_gid_by_grpnam, map_uid_by_pwnam)
+from otaclient._utils.linux import (
+    ParsedGroup,
+    ParsedPasswd,
+    map_gid_by_grpnam,
+    map_uid_by_pwnam,
+)
 
 from .configs import config as cfg
 

otaclient/app/configs.py

@@ -17,10 +17,8 @@
 from logging import INFO
 from typing import Dict, Tuple
 
-from otaclient.configs.ecu_info import ecu_info
-from otaclient.configs.proxy_info import proxy_info
-
-ecu_info, proxy_info = ecu_info, proxy_info  # to prevent static check warnings
+from otaclient.configs.ecu_info import ecu_info  # noqa
+from otaclient.configs.proxy_info import proxy_info  # noqa
 
 
 class CreateStandbyMechanism(Enum):