chore: updated version to 0.3.0

Author: RinLit-233-shiroko

ClassWidgets/SDK/__init__.py

@@ -4,7 +4,7 @@
 import sys
 from typing import TYPE_CHECKING
 
-__version__ = '0.2.0'
+__version__ = '0.3.0'
 __author__ = 'Class Widgets Official'
 
 

ClassWidgets/SDK/__init__.pyi

@@ -8,7 +8,7 @@ You should debug and run plugins in Class Widgets 2.
 from .plugin_base import CW2Plugin
 from .config import ConfigBaseModel
 from .api import PluginAPI
-from .notification import NotificationProvider, NotificationLevel, NotificationData
+from .notification import NotificationProvider, NotificationLevel, NotificationData, NotificationProviderConfig
 
 __version__: str
 __author__: str

ClassWidgets/SDK/notification.pyi

@@ -1,10 +1,10 @@
-from typing import Optional, Union, Any
+from typing import Optional, Union, Any, TYPE_CHECKING
 from pathlib import Path
 from enum import IntEnum
 from pydantic import BaseModel
 
-from .api import QObject
-
+# 为非检查时提供的抽象基类
+class QObject: ...
 
 class NotificationLevel(IntEnum):
     """
@@ -31,6 +31,15 @@ class NotificationData(BaseModel):
     use_system: bool = False
 
 
+class NotificationProviderConfig(BaseModel):
+    """
+    通知提供者配置模型
+    """
+    enabled: bool = True
+    use_system_notify: bool = False
+    use_app_notify: bool = True
+
+
 class NotificationProvider(QObject):
     """
     通知提供者类
@@ -42,19 +51,21 @@ class NotificationProvider(QObject):
     name: str
     icon: Optional[str]
     use_system_notify: bool
-    manager: Any
-
+    
+    # 初始化方法
     def __init__(
         self,
         id: str,
         name: str,
-        icon: Optional[Union[str, Path]] = ...,
-        use_system_notify: bool = ...,
-        manager: Any = ...
+        icon: Optional[Union[str, Path]] = None,
+        use_system_notify: bool = False,
+        manager: Any = None
     ) -> None: ...
 
-    def get_config(self) -> Any: ...
+    # 配置相关方法
+    def get_config(self) -> NotificationProviderConfig: ...
 
+    # 推送通知方法
     def push(
         self,
         level: int,
@@ -67,6 +78,7 @@ class NotificationProvider(QObject):
 
 __all__ = [
     'NotificationLevel',
-    'NotificationData', 
+    'NotificationData',
+    'NotificationProviderConfig',
     'NotificationProvider'
 ]

ClassWidgets/SDK/plugin_base.pyi

@@ -1,52 +1,69 @@
 from typing import Dict, Any, Optional
 from pathlib import Path
-
+from enum import IntEnum
 from pydantic import BaseModel
 
-from .api import PluginAPI, NotificationAPI, QObject
-from .notification import NotificationProvider
+# 为非检查时提供的抽象基类
+class QObject: ...
+
+class Signal:
+    def emit(self, *args) -> None:
+        pass
+
+from .api import PluginAPI
 
 
-class ConfigBaseModel(BaseModel): ...
+class ConfigBaseModel(BaseModel):
+    """
+    插件配置模型的基类
+    继承自Pydantic的BaseModel，提供配置数据验证和管理功能
+    """
+    ...
 
 
 # CW2Plugin
 class CW2Plugin(QObject):
     """
-    :param api: PluginAPI instance
+    所有Class Widgets 2插件的基类
+    
+    提供插件生命周期管理、API访问和插件注册功能
     """
-    PATH: Path
-    meta: Dict[str, Any]
-    pid: Optional[str]
-    api: PluginAPI
+    initialized: Signal
+    
+    # 插件属性
+    PATH: Path  # 插件根目录路径
+    meta: Dict[str, Any]  # 插件元数据
+    pid: Optional[str]  # 插件ID
+    api: PluginAPI  # 插件API实例
 
-    def __init__(self, api: Any) -> None:
+    def __init__(self, api: PluginAPI) -> None:
         """
-        Initialize the plugin.
-
-        :param api: PluginAPI instance for interacting with the host application
+        初始化插件实例
+        
+        :param api: PluginAPI实例，用于与主应用程序交互
         """
         ...
 
     def _load_plugin_libs(self) -> None:
         """
-        Automatically adds the plugin's 'lib' subdirectory to sys.path.
-        This is an internal method.
+        自动将插件的'lib'子目录添加到sys.path
+        这是一个内部方法
         """
         ...
 
     def on_load(self) -> None:
         """
-        Called when the plugin is loaded.
-        Registers the plugin with the backend bridge if meta.id exists.
+        当插件被加载时调用
+        如果存在meta.id，则向后端桥注册插件
         """
         ...
 
     def on_unload(self) -> None:
         """
-        Called when the plugin is unloaded.
+        当插件被卸载时调用
+        插件应该在此方法中清理资源
         """
         ...
 
 
-__all__ = ['CW2Plugin']
+__all__ = ['CW2Plugin', 'ConfigBaseModel']