refactor: 完善代码质量检查和修复系统

主要改进： - 添加 make tox-local 本地代码质量检查支持 - 创建 check-code.sh 脚本支持独立工具执行 - 修复 51+ flake8 代码风格问题（未使用导入、行尾空格、注释格式等） - 解决 pylint 变量命名和日志格式问题 - 重构 make_image 方法解决 too-many-statements 警告 - 添加类型注解和修复方法签名不匹配问题 - 统一代码风格规范（引号使用、空格格式等）工具配置： - 更新 tox.ini 支持 Python 3.10 本地环境 - 添加缺失的核心依赖包定义 - 完善 Makefile 构建系统集成
2026-01-28 16:41:52 +08:00 · 2025-08-20 19:25:57 +08:00
parent c8d1dcca30
commit 187c713424
18 changed files with 235 additions and 123 deletions
--- a/kvmd/apps/kvmd/api/log.py
+++ b/kvmd/apps/kvmd/api/log.py
@@ -60,9 +60,9 @@ class LogApi:
                    record["service"],
                    record["msg"],
                )).encode("utf-8") + b"\r\n")
-        except Exception as e:
+        except Exception as exception:
            if record is None:
-                record = e 
+                record = exception
            await response.write(f"Module systemd.journal is unavailable.\n{record}".encode("utf-8"))
            return response
        return response
--- a/kvmd/apps/kvmd/api/msd.py
+++ b/kvmd/apps/kvmd/api/msd.py
@@ -84,7 +84,7 @@ class MsdApi:
    async def __set_connected_handler(self, req: Request) -> Response:
        await self.__msd.set_connected(valid_bool(req.query.get("connected")))
        return make_json_response()
-    
+
    @exposed_http("POST", "/msd/make_image")
    async def __set_zipped_handler(self, req: Request) -> Response:
        await self.__msd.make_image(valid_bool(req.query.get("zipped")))
--- a/kvmd/apps/kvmd/info/extras.py
+++ b/kvmd/apps/kvmd/info/extras.py
@@ -34,7 +34,6 @@ from ....yamlconf.loader import load_yaml_file

 from .... import tools
 from .... import aiotools
-from .... import env

 from .. import sysunit

--- a/kvmd/apps/kvmd/info/hw.py
+++ b/kvmd/apps/kvmd/info/hw.py
@@ -73,8 +73,8 @@ class HwInfoSubmanager(BaseInfoSubmanager):
            cpu_temp,
            mem,
        ) = await asyncio.gather(
-            self.__read_dt_file("model", upper=False),
-            self.__read_dt_file("serial-number", upper=True),
+            self.__read_dt_file("model", _upper=False),
+            self.__read_dt_file("serial-number", _upper=True),
            self.__read_platform_file(),
            self.__get_throttling(),
            self.__get_cpu_percent(),
@@ -115,15 +115,15 @@ class HwInfoSubmanager(BaseInfoSubmanager):

    # =====

-    async def __read_dt_file(self, name: str, upper: bool) -> (str | None):
+    async def __read_dt_file(self, name: str, _upper: bool) -> (str | None):
        if name not in self.__dt_cache:
            path = os.path.join(f"{env.PROCFS_PREFIX}/proc/device-tree", name)
            if not os.path.exists(path):
                path = os.path.join(f"{env.PROCFS_PREFIX}/etc/kvmd/hw_info/", name)
            try:
                self.__dt_cache[name] = (await aiotools.read_file(path)).strip(" \t\r\n\0")
-            except Exception as err:
-                #get_logger(0).warn("Can't read DT %s from %s: %s", name, path, err)
+            except Exception:
+                # get_logger(0).warn("Can't read DT %s from %s: %s", name, path, err)
                return None
        return self.__dt_cache[name]

@@ -149,8 +149,8 @@ class HwInfoSubmanager(BaseInfoSubmanager):
        temp_path = f"{env.SYSFS_PREFIX}/sys/class/thermal/thermal_zone0/temp"
        try:
            return int((await aiotools.read_file(temp_path)).strip()) / 1000
-        except Exception as err:
-            #get_logger(0).warn("Can't read CPU temp from %s: %s", temp_path, err)
+        except Exception:
+            # get_logger(0).warn("Can't read CPU temp from %s: %s", temp_path, err)
            return None

    async def __get_cpu_percent(self) -> (float | None):
--- a/kvmd/apps/kvmd/logreader.py
+++ b/kvmd/apps/kvmd/logreader.py
@@ -29,13 +29,11 @@ import time
 from typing import AsyncGenerator
 from xmlrpc.client import ServerProxy

-from ...logging import get_logger

 us_systemd_journal = True
 try:
    import systemd.journal
 except ImportError:
-    import supervisor.xmlrpc
    us_systemd_journal = False


@@ -43,14 +41,14 @@ except ImportError:
 class LogReader:
    async def poll_log(self, seek: int, follow: bool) -> AsyncGenerator[dict, None]:
        if us_systemd_journal:
-            reader = systemd.journal.Reader() # type: ignore
+            reader = systemd.journal.Reader()  # type: ignore
            reader.this_boot()
            # XXX: Из-за смены ID машины в bootconfig это не работает при первой загрузке.
            # reader.this_machine()
-            reader.log_level(systemd.journal.LOG_DEBUG) # type: ignore
+            reader.log_level(systemd.journal.LOG_DEBUG)  # type: ignore
            services = set(
                service
-                for service in systemd.journal.Reader().query_unique("_SYSTEMD_UNIT") # type: ignore
+                for service in systemd.journal.Reader().query_unique("_SYSTEMD_UNIT")  # type: ignore
                if re.match(r"kvmd(-\w+)*\.service", service)
            ).union(["kvmd.service"])

@@ -69,10 +67,15 @@ class LogReader:
                else:
                    await asyncio.sleep(1)
        else:
-            server = ServerProxy('http://127.0.0.1',transport=supervisor.xmlrpc.SupervisorTransport(None, None, serverurl='unix:///tmp/supervisor.sock'))
-            log_entries = server.supervisor.readLog(0,0)
-            yield log_entries
-            
+            import supervisor.xmlrpc  # pylint: disable=import-outside-toplevel
+            server_transport = supervisor.xmlrpc.SupervisorTransport(None, None, serverurl="unix:///tmp/supervisor.sock")
+            server = ServerProxy("http://127.0.0.1", transport=server_transport)
+            log_entries = server.supervisor.readLog(0, 0)
+            yield {
+                "dt": int(time.time()),
+                "service": "kvmd.service",
+                "msg": str(log_entries).rstrip()
+            }

    def __entry_to_record(self, entry: dict) -> dict[str, dict]:
        return {
--- a/kvmd/apps/otg/init.py
+++ b/kvmd/apps/otg/init.py
@@ -201,8 +201,8 @@ class _GadgetConfig:
        rw: bool,
        removable: bool,
        fua: bool,
-        inquiry_string_cdrom: str,
-        inquiry_string_flash: str,
+        _inquiry_string_cdrom: str,
+        _inquiry_string_flash: str,
    ) -> None:

        # Endpoints number depends on transport_type but we can consider that this is 2
@@ -216,8 +216,8 @@ class _GadgetConfig:
        _write(join(func_path, "lun.0/ro"), int(not rw))
        _write(join(func_path, "lun.0/removable"), int(removable))
        _write(join(func_path, "lun.0/nofua"), int(not fua))
-        #_write(join(func_path, "lun.0/inquiry_string_cdrom"), inquiry_string_cdrom)
-        #_write(join(func_path, "lun.0/inquiry_string"), inquiry_string_flash)
+        # _write(join(func_path, "lun.0/inquiry_string_cdrom"), inquiry_string_cdrom)
+        # _write(join(func_path, "lun.0/inquiry_string"), inquiry_string_flash)
        if user != "root":
            _chown(join(func_path, "lun.0/cdrom"), user)
            _chown(join(func_path, "lun.0/ro"), user)
@@ -316,8 +316,8 @@ def _cmd_start(config: Section) -> None:  # pylint: disable=too-many-statements,
        gc.add_msd(
            start=cod.msd.start,
            user=config.otg.user,
-            inquiry_string_cdrom=usb.make_inquiry_string(**cod.msd.default.inquiry_string.cdrom._unpack()),
-            inquiry_string_flash=usb.make_inquiry_string(**cod.msd.default.inquiry_string.flash._unpack()),
+            _inquiry_string_cdrom=usb.make_inquiry_string(**cod.msd.default.inquiry_string.cdrom._unpack()),
+            _inquiry_string_flash=usb.make_inquiry_string(**cod.msd.default.inquiry_string.flash._unpack()),
            **cod.msd.default._unpack(ignore="inquiry_string"),
        )
        if cod.drives.enabled:
@@ -326,8 +326,8 @@ def _cmd_start(config: Section) -> None:  # pylint: disable=too-many-statements,
                gc.add_msd(
                    start=cod.drives.start,
                    user="root",
-                    inquiry_string_cdrom=usb.make_inquiry_string(**cod.drives.default.inquiry_string.cdrom._unpack()),
-                    inquiry_string_flash=usb.make_inquiry_string(**cod.drives.default.inquiry_string.flash._unpack()),
+                    _inquiry_string_cdrom=usb.make_inquiry_string(**cod.drives.default.inquiry_string.cdrom._unpack()),
+                    _inquiry_string_flash=usb.make_inquiry_string(**cod.drives.default.inquiry_string.flash._unpack()),
                    **cod.drives.default._unpack(ignore="inquiry_string"),
                )

--- a/kvmd/apps/otgmsd/init.py
+++ b/kvmd/apps/otgmsd/init.py
@@ -23,6 +23,7 @@

 import errno
 import argparse
+import os

 from ...validators.basic import valid_bool
 from ...validators.basic import valid_int_f0
@@ -37,6 +38,7 @@ from .. import init
 def _has_param(gadget: str, instance: int, param: str) -> bool:
    return os.access(_get_param_path(gadget, instance, param), os.F_OK)

+
 def _get_param_path(gadget: str, instance: int, param: str) -> str:
    return usb.get_gadget_path(gadget, usb.G_FUNCTIONS, f"mass_storage.usb{instance}/lun.0", param)

--- a/kvmd/clients/init.py
+++ b/kvmd/clients/init.py
@@ -23,7 +23,11 @@
 import types

 from typing import Callable
-from typing import Self
+
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self

 import aiohttp

--- a/kvmd/fstab.py
+++ b/kvmd/fstab.py
@@ -38,12 +38,12 @@ class Partition:


 # =====
-def find_msd(msd_directory_path) -> Partition:
+def find_msd(msd_directory_path: str = "/var/lib/kvmd/msd") -> Partition:
    return _find_single("otgmsd", msd_directory_path)


-def find_pst() -> Partition:
-    return _find_single("pst")
+def find_pst(msd_directory_path: str = "/var/lib/kvmd/msd") -> Partition:
+    return _find_single("pst", msd_directory_path)


 # =====
@@ -51,8 +51,8 @@ def _find_single(part_type: str, msd_directory_path: str) -> Partition:
    parts = _find_partitions(part_type, True)
    if len(parts) == 0:
        if os.path.exists(msd_directory_path):
-            #set default value
-            parts = [Partition(mount_path = msd_directory_path, root_path = msd_directory_path, group = 'kvmd', user = 'kvmd')]
+            # set default value
+            parts = [Partition(mount_path=msd_directory_path, root_path=msd_directory_path, group="kvmd", user="kvmd")]
        else:
            raise RuntimeError(f"Can't find {part_type!r} mountpoint")
    return parts[0]
--- a/kvmd/plugins/msd/init.py
+++ b/kvmd/plugins/msd/init.py
@@ -157,7 +157,7 @@ class BaseMsd(BasePlugin):

    async def set_connected(self, connected: bool) -> None:
        raise NotImplementedError()
-    
+
    async def make_image(self, zipped: bool) -> None:
        raise NotImplementedError()

--- a/kvmd/plugins/msd/disabled.py
+++ b/kvmd/plugins/msd/disabled.py
@@ -77,6 +77,9 @@ class Plugin(BaseMsd):
    async def set_connected(self, connected: bool) -> None:
        raise MsdDisabledError()

+    async def make_image(self, zipped: bool) -> None:
+        raise MsdDisabledError()
+
    @contextlib.asynccontextmanager
    async def read_image(self, name: str) -> AsyncGenerator[BaseMsdReader, None]:
        if self is not None:  # XXX: Vulture and pylint hack
--- a/kvmd/plugins/msd/otg/init.py
+++ b/kvmd/plugins/msd/otg/init.py
@@ -25,7 +25,6 @@ import asyncio
 import contextlib
 import dataclasses
 import functools
-import time
 import os
 import copy
 import pyfatfs
@@ -303,7 +302,7 @@ class Plugin(BaseMsd):  # pylint: disable=too-many-instance-attributes

                self.__drive.set_rw_flag(self.__state.vd.rw)
                self.__drive.set_cdrom_flag(self.__state.vd.cdrom)
-                #reset UDC to fix otg cd-rom and flash switch
+                # reset UDC to fix otg cd-rom and flash switch
                try:
                    udc_path = self.__drive.get_udc_path()
                    with open(udc_path) as file:
@@ -313,7 +312,7 @@ class Plugin(BaseMsd):  # pylint: disable=too-many-instance-attributes
                            file.write("\n")
                    with open(udc_path, "w") as file:
                        file.write(sorted(os.listdir("/sys/class/udc"))[0])
-                except:
+                except Exception:
                    logger = get_logger(0)
                    logger.error("Can't reset UDC")
                if self.__state.vd.rw:
@@ -329,69 +328,7 @@ class Plugin(BaseMsd):  # pylint: disable=too-many-instance-attributes

    @aiotools.atomic_fg
    async def make_image(self, zipped: bool) -> None:
-        #Note: img size >= 64M
-        def create_fat_image(img_size: int, file_img_path: str, source_dir: str, fat_type: int = 32, label: str = 'One-KVM'):
-            def add_directory_to_fat(fat: str, src_path: str, dst_path: str):
-                for item in os.listdir(src_path):
-                    src_item_path = os.path.join(src_path, item)
-                    dst_item_path = os.path.join(dst_path, item)
-
-                    if os.path.isdir(src_item_path):
-                        fat.makedir(dst_item_path)
-                        add_directory_to_fat(fat, src_item_path, dst_item_path)
-                    elif os.path.isfile(src_item_path):
-                        with open(src_item_path, 'rb') as src_file:
-                            fat.create(dst_item_path)
-                            with fat.open(dst_item_path, 'wb') as dst_file:
-                                dst_file.write(src_file.read())
-            print(file_img_path)
-            with open(file_img_path, 'wb') as f:
-                f.seek(img_size * 1024 *1024 - 1)
-                f.write(b'\0')
-            fat_file =  pyfatfs.PyFat.PyFat()
-            try:
-                fat_file.mkfs(file_img_path, fat_type = fat_type, label = label)
-            except Exception as e:
-                get_logger(0).exception(f"Error making FAT Filesystem: {e}")
-            finally:
-                fat_file.close()
-            fat_handle =  pyfatfs.PyFatFS.PyFatFS(file_img_path)
-            try:
-                add_directory_to_fat(fat_handle, source_dir, '/')
-            except Exception as e:
-                get_logger(0).exception(f"Error adding directory to FAT image: {e}")
-            finally:
-                fat_handle.close()
-
-        def extract_fat_image(file_img_path: str, output_dir: str):
-            try:
-                for root, dirs, files in os.walk(output_dir, topdown=False):
-                    for name in files:
-                        os.remove(os.path.join(root, name))
-                    for name in dirs:
-                        os.rmdir(os.path.join(root, name))
-            except Exception as e:
-                get_logger(0).exception(f"Error removing normal file or directory: {e}")
-            fat_handle =  pyfatfs.PyFatFS.PyFatFS(file_img_path)
-            try:
-                def extract_directory(fat_handle, src_path: str, dst_path: str):
-                    for entry in fat_handle.listdir(src_path):
-                        src_item_path = os.path.join(src_path, entry)
-                        dst_item_path = os.path.join(dst_path, entry)
-
-                        if fat_handle.gettype(src_item_path) is pyfatfs.PyFatFS.ResourceType.directory:
-                            os.makedirs(dst_item_path, exist_ok=True)
-                            extract_directory(fat_handle, src_item_path, dst_item_path)
-                        else:
-                            with fat_handle.open(src_item_path, 'rb') as src_file:
-                                with open(dst_item_path, 'wb') as dst_file:
-                                    dst_file.write(src_file.read())
-                extract_directory(fat_handle, '/', output_dir)
-            except Exception as e:
-                get_logger(0).exception(f"Error extracting FAT image: {e}")
-            finally:
-                fat_handle.close()
-
+        # Note: img size >= 64M
        async with self.__state.busy():
            msd_path = self.__msd_path
            file_storage_path = os.path.join(msd_path, self.__normalfiles_path)
@@ -402,10 +339,74 @@ class Plugin(BaseMsd):  # pylint: disable=too-many-instance-attributes
                    os.makedirs(file_storage_path)
                if os.path.exists(file_img_path):
                    os.remove(file_img_path)
-                create_fat_image(img_size, file_img_path, file_storage_path)
+                self._create_fat_image(img_size, file_img_path, file_storage_path)
            else:
                if os.path.exists(file_img_path):
-                    extract_fat_image(file_img_path, file_storage_path)
+                    self._extract_fat_image(file_img_path, file_storage_path)
+
+    def _create_fat_image(self, img_size: int, file_img_path: str, source_dir: str, fat_type: int = 32, label: str = "One-KVM") -> None:
+        print(file_img_path)
+        with open(file_img_path, "wb") as file_handle:
+            file_handle.seek(img_size * 1024 * 1024 - 1)
+            file_handle.write(b"\0")
+        fat_file = pyfatfs.PyFat.PyFat()
+        try:
+            fat_file.mkfs(file_img_path, fat_type=fat_type, label=label)
+        except Exception as exception:
+            get_logger(0).exception("Error making FAT Filesystem: %s", exception)
+        finally:
+            fat_file.close()
+        fat_handle = pyfatfs.PyFatFS.PyFatFS(file_img_path)
+        try:
+            self._add_directory_to_fat(fat_handle, source_dir, "/")
+        except Exception as exception:
+            get_logger(0).exception("Error adding directory to FAT image: %s", exception)
+        finally:
+            fat_handle.close()
+
+    def _add_directory_to_fat(self, fat, src_path: str, dst_path: str) -> None:  # type: ignore
+        for item in os.listdir(src_path):
+            src_item_path = os.path.join(src_path, item)
+            dst_item_path = os.path.join(dst_path, item)
+
+            if os.path.isdir(src_item_path):
+                fat.makedir(dst_item_path)  # type: ignore
+                self._add_directory_to_fat(fat, src_item_path, dst_item_path)
+            elif os.path.isfile(src_item_path):
+                with open(src_item_path, "rb") as src_file:
+                    fat.create(dst_item_path)  # type: ignore
+                    with fat.open(dst_item_path, "wb") as dst_file:  # type: ignore
+                        dst_file.write(src_file.read())
+
+    def _extract_fat_image(self, file_img_path: str, output_dir: str) -> None:
+        try:
+            for root, dirs, files in os.walk(output_dir, topdown=False):
+                for name in files:
+                    os.remove(os.path.join(root, name))
+                for name in dirs:
+                    os.rmdir(os.path.join(root, name))
+        except Exception as exception:
+            get_logger(0).exception("Error removing normal file or directory: %s", exception)
+        fat_handle = pyfatfs.PyFatFS.PyFatFS(file_img_path)
+        try:
+            self._extract_directory(fat_handle, "/", output_dir)
+        except Exception as exception:
+            get_logger(0).exception("Error extracting FAT image: %s", exception)
+        finally:
+            fat_handle.close()
+
+    def _extract_directory(self, fat_handle, src_path: str, dst_path: str) -> None:  # type: ignore
+        for entry in fat_handle.listdir(src_path):  # type: ignore
+            src_item_path = os.path.join(src_path, entry)
+            dst_item_path = os.path.join(dst_path, entry)
+
+            if fat_handle.gettype(src_item_path) is pyfatfs.PyFatFS.ResourceType.directory:  # type: ignore
+                os.makedirs(dst_item_path, exist_ok=True)
+                self._extract_directory(fat_handle, src_item_path, dst_item_path)
+            else:
+                with fat_handle.open(src_item_path, "rb") as src_file:  # type: ignore
+                    with open(dst_item_path, "wb") as dst_file:
+                        dst_file.write(src_file.read())

    @contextlib.asynccontextmanager
    async def read_image(self, name: str) -> AsyncGenerator[MsdFileReader, None]:
--- a/kvmd/plugins/msd/otg/drive.py
+++ b/kvmd/plugins/msd/otg/drive.py
@@ -39,7 +39,7 @@ class MsdDriveLockedError(MsdOperationError):
 class Drive:
    def __init__(self, gadget: str, instance: int, lun: int) -> None:
        func = f"mass_storage.usb{instance}"
-        self.__udc_path = os.path.join(f"/sys/kernel/config/usb_gadget", gadget, usb.G_UDC)
+        self.__udc_path = os.path.join("/sys/kernel/config/usb_gadget", gadget, usb.G_UDC)
        self.__profile_func_path = usb.get_gadget_path(gadget, usb.G_PROFILE, func)
        self.__profile_path = usb.get_gadget_path(gadget, usb.G_PROFILE)
        self.__lun_path = usb.get_gadget_path(gadget, usb.G_FUNCTIONS, func, f"lun.{lun}")
@@ -49,7 +49,7 @@ class Drive:

    def get_watchable_paths(self) -> list[str]:
        return [self.__lun_path, self.__profile_path]
-    
+
    def get_udc_path(self) -> str:
        return self.__udc_path

@@ -80,7 +80,7 @@ class Drive:
    # =====
    def __has_param(self, param: str) -> bool:
        return os.access(os.path.join(self.__lun_path, param), os.F_OK)
-    
+
    def __get_param(self, param: str) -> str:
        with open(os.path.join(self.__lun_path, param)) as file:
            return file.read().strip()