docs: 完善README文档与架构图,修复全量注释与日志问题

- README: 补充项目概述、技术栈、架构图(Mermaid)、插件生命周期时序图
- build.py: 补充模块和函数 docstring
- core/__init__.py: 修正模块说明(工具箱→插件系统)
- log.py: 修复过时注释,清理死代码,抑制第三方库日志刷屏
- plugin_registry.py: 修正矛盾注释,补充缺失日志,隐藏远程路径
- plugins.py: 修正过时注释,清理死代码和无用导入
- plugins_card.py: 修正错误类名注释,补充全量 docstring
- main.py: 修正错误注释,补充启动/退出/插件加载日志
This commit is contained in:
2026-07-21 17:04:34 +08:00
parent 0efaf2946b
commit 1b6796ec43
8 changed files with 282 additions and 138 deletions
+34 -18
View File
@@ -1,15 +1,8 @@
import os
import time
import logging
import threading
from .plugin_registry import Event
from PySide6.QtWidgets import QFrame
from PySide6.QtCore import Signal
from .plugins_card_ui import Ui_FramePluginsCard
logger = logging.getLogger(__name__)
def parse_version(version: str) -> tuple:
"""将版本字符串解析为可比较的元组,如 '1.10.0' -> (1, 10, 0)。
@@ -34,13 +27,27 @@ def parse_version(version: str) -> tuple:
class PluginsCard(QFrame, Ui_FramePluginsCard):
"""工具卡片类
"""插件卡片组件。
继承自 QFrameQt 帧基类)和 Ui_FrameToolCardQt Designer 生成的 UI 界面)
负责显示工具的卡片界面,包含工具的图标、名称和描述
继承自 QFrame 和 Ui_FramePluginsCardQt Designer 生成的 UI 界面)
负责展示单个插件的图标、名称、版本和描述,并提供安装/更新/卸载按钮
Attributes:
name: 插件名称
info: 插件元数据字典,含 local version / remote version / description 等
"""
send_event_signal = Signal(Event,str)
def __init__(self, name: str, info:dict, parent=None) -> None:
# 按钮点击信号,携带事件类型和插件名称
send_event_signal = Signal(Event, str)
def __init__(self, name: str, info: dict, parent=None) -> None:
"""初始化插件卡片。
Args:
name: 插件名称
info: 插件元数据字典
parent: 父组件,默认为 None
"""
super().__init__(parent)
self.setupUi(self)
@@ -49,7 +56,8 @@ class PluginsCard(QFrame, Ui_FramePluginsCard):
self.initUI()
def initUI(self):
def initUI(self) -> None:
"""初始化卡片 UI:刷新显示内容并绑定按钮事件。"""
self.refresh()
self.textBrowser.setReadOnly(True)
self.pushButtonUpdate.clicked.connect(self.on_update_event)
@@ -69,7 +77,12 @@ class PluginsCard(QFrame, Ui_FramePluginsCard):
else:
self.pushButtonUpdate.setEnabled(False)
def to_card(self):
def to_card(self) -> str:
"""将插件信息渲染为 Markdown 卡片文本。
Returns:
格式化的 Markdown 字符串,包含名称、版本和描述。
"""
remote_ver = self.info.get('remote version')
local_ver = self.info.get('local version')
desc = self.info.get('remote description') or self.info.get('local description') or '暂无'
@@ -83,11 +96,14 @@ class PluginsCard(QFrame, Ui_FramePluginsCard):
card += f"**描述:** {desc}"
return card
def on_install_event(self):
def on_install_event(self) -> None:
"""触发安装事件。"""
self.send_event_signal.emit(Event.Install, self.name)
def on_uninstall_event(self):
def on_uninstall_event(self) -> None:
"""触发卸载事件。"""
self.send_event_signal.emit(Event.Uninstall, self.name)
def on_update_event(self):
def on_update_event(self) -> None:
"""触发更新事件。"""
self.send_event_signal.emit(Event.Update, self.name)