chore: 使用 Ruff 替代 Black 作为格式化工具 (#102)

Author: st1020

.github/workflows/lint.yml

@@ -12,17 +12,23 @@ on:
   workflow_dispatch:
 
 jobs:
-  black:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: psf/black@stable
-
   ruff:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: chartboost/ruff-action@v1
+
+      - uses: pdm-project/setup-pdm@v3
+        name: Setup PDM
+        with:
+          python-version: 3.9
+          cache: true
+      - name: Install dependencies
+        run: pdm install -G dev -G lint
+
+      - run: |
+          eval $(pdm venv activate)
+          ruff check --output-format=github .
+          ruff format --check .
 
   pylint:
     runs-on: ubuntu-latest

.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
       cancel-in-progress: true
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
         os: [ubuntu-latest, windows-latest, macos-latest]
       fail-fast: false
     env:

.pre-commit-config.yaml

@@ -8,13 +8,12 @@
 
 ### 安装依赖
 
-AliceBot 使用 [PDM](https://pdm.fming.dev/) 管理项目的依赖，并使用 [pre-commit](https://pre-commit.com/) 在提交前执行代码审查。
+AliceBot 使用 [PDM](https://pdm.fming.dev/) 管理项目的依赖。
 
-因此，你需要先根据 [PDM](https://pdm.fming.dev/latest/#installation) 的指引安装 PDM，之后在项目目录中执行以下命令：
+因此，你需要先根据 [PDM](https://pdm-project.org/latest/#installation) 的指引安装 PDM，之后在项目目录中执行以下命令：
 
 ```shell
 pdm install
-pre-commit install
 ```
 
 AliceBot 项目的文档使用 [VitePress](https://vitepress.dev/) 生成，如果你想要贡献 AliceBot 的文档，请额外安装 [pnpm](https://pnpm.io/) 环境，并在项目目录中执行以下命令：
@@ -27,16 +26,15 @@ pnpm install
 
 虽然并非强制，但强烈建议你使用 VSCode 作为编辑器对 AliceBot 项目的代码进行编辑，因为 AliceBot 具有完全的类型注解，VSCode 的 Pylance 插件具有相对较好的静态类型检查效果。
 
-如果你使用 VSCode 作为编辑器，需要安装 **Python**、**Pylance** 和 **isort** 插件，并进行以下配置：
+如果你使用 VSCode 作为编辑器，需要安装 **Python**、**Pylance** 和 **Ruff** 插件，并进行以下配置：
 
 ```json
 {
   "[python]": {
     "editor.formatOnPaste": false,
-    "editor.formatOnSaveMode": "file"
-  },
-  "python.analysis.diagnosticMode": "workspace",
-  "python.formatting.provider": "black"
+    "editor.formatOnSaveMode": "file",
+    "editor.defaultFormatter": "charliermarsh.ruff"
+  }
 }
 ```
 
@@ -50,7 +48,7 @@ pnpm install
 
 AliceBot 的代码风格遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/) 规范。
 
-AliceBot 使用 [Black](https://github.com/psf/black) 作为格式化工具，并使用 [isort](https://github.com/PyCQA/isort) 确保导入顺序，如果你已经按照上文配置了 VSCodo，那么你应该很容易遵循此规范，否则请在提交前手动执行上述格式化工具。
+AliceBot 使用 [Ruff](https://docs.astral.sh/ruff/) 作为格式化工具，如果你已经按照上文配置了 VSCode，那么你应该很容易遵循此规范，否则请在提交前手动执行上述格式化工具。
 
 ### 类型注解
 

CONTRIBUTING.md

@@ -27,7 +27,10 @@
     overload,
 )
 
-from pydantic import ValidationError, create_model
+from pydantic import (
+    ValidationError,
+    create_model,  # pyright: ignore[reportUnknownVariableType]
+)
 
 from alicebot.adapter import Adapter
 from alicebot.config import AdapterConfig, ConfigModel, MainConfig, PluginConfig
@@ -91,8 +94,12 @@ class Bot:
     _restart_flag: bool  # 重新启动标志
     _module_path_finder: ModulePathFinder  # 用于查找 plugins 的模块元路径查找器
     _raw_config_dict: Dict[str, Any]  # 原始配置字典
-    _adapter_tasks: Set["asyncio.Task[None]"]  # 适配器任务集合，用于保持对适配器任务的引用
-    _handle_event_tasks: Set["asyncio.Task[None]"]  # 事件处理任务，用于保持对适配器任务的引用
+    _adapter_tasks: Set[
+        "asyncio.Task[None]"
+    ]  # 适配器任务集合，用于保持对适配器任务的引用
+    _handle_event_tasks: Set[
+        "asyncio.Task[None]"
+    ]  # 事件处理任务，用于保持对适配器任务的引用
 
     # 以下属性不会在重启时清除
     _config_file: Optional[str]  # 配置文件
@@ -102,7 +109,9 @@ class Bot:
     _extend_plugins: List[
         Union[Type[Plugin[Any, Any, Any]], str, Path]
     ]  # 使用 load_plugins() 方法程序化加载的插件列表
-    _extend_plugin_dirs: List[Path]  # 使用 load_plugins_from_dirs() 方法程序化加载的插件路径列表
+    _extend_plugin_dirs: List[
+        Path
+    ]  # 使用 load_plugins_from_dirs() 方法程序化加载的插件路径列表
     _extend_adapters: List[
         Union[Type[Adapter[Any, Any]], str]
     ]  # 使用 load_adapter() 方法程序化加载的适配器列表

alicebot/bot.py

@@ -119,21 +119,17 @@ async def solve_dependencies(
             )
         depend_obj = cast(
             Union[_T, AsyncContextManager[_T], ContextManager[_T]],
-            dependent.__new__(dependent),  # pyright: ignore[reportGeneralTypeIssues]
+            dependent.__new__(dependent),  # pyright: ignore
         )
         for key, value in values.items():
             setattr(depend_obj, key, value)
         depend_obj.__init__()  # type: ignore[misc] # pylint: disable=unnecessary-dunder-call
 
         if isinstance(depend_obj, AsyncContextManager):
-            depend = await stack.enter_async_context(
-                depend_obj  # pyright: ignore[reportUnknownArgumentType]
-            )
+            depend = await stack.enter_async_context(depend_obj)  # pyright: ignore
         elif isinstance(depend_obj, ContextManager):
-            depend = await stack.enter_async_context(
-                sync_ctx_manager_wrapper(
-                    depend_obj  # pyright: ignore[reportUnknownArgumentType]
-                )
+            depend = await stack.enter_async_context(  # pyright: ignore
+                sync_ctx_manager_wrapper(depend_obj)
             )
         else:
             depend = depend_obj
@@ -149,4 +145,4 @@ async def solve_dependencies(
         raise TypeError("dependent is not a class or generator function")
 
     dependency_cache[dependent] = depend
-    return depend
+    return depend  # pyright: ignore

alicebot/dependencies.py

@@ -101,9 +101,9 @@ async def get(
         Raises:
             GetEventTimeout: 超过最大事件数或超时。
         """
-        return await self.adapter.get(
+        return await self.adapter.get(  # pyright: ignore
             self.is_same_sender,
-            event_type=type(self),
+            event_type=type(self),  # pyright: ignore
             max_try_times=max_try_times,
             timeout=timeout,
         )

alicebot/event.py

@@ -92,7 +92,7 @@ def __get_pydantic_core_schema__(
                 core_schema.no_info_after_validator_function(
                     cls,
                     handler.generate_schema(
-                        List[cls.get_segment_class()]  # type: ignore[misc, index]
+                        List[cls.get_segment_class()]  # type: ignore[misc]
                     ),
                 ),
             ]
@@ -459,7 +459,7 @@ def __eq__(self, other: object) -> bool:
             是否相等。
         """
         return (
-            type(other) is self.__class__  # pylint: disable=unidiomatic-typecheck
+            isinstance(other, self.__class__)
             and self.type == other.type
             and self.data == other.data
         )

alicebot/message.py

@@ -229,7 +229,7 @@ async def sync_ctx_manager_wrapper(
 
 
 def wrap_get_func(
-    func: Optional[Callable[[EventT], Union[bool, Awaitable[bool]]]]
+    func: Optional[Callable[[EventT], Union[bool, Awaitable[bool]]]],
 ) -> Callable[[EventT], Awaitable[bool]]:
     """将 `get()` 函数接受的参数包装为一个异步函数。
 
@@ -251,7 +251,7 @@ def wrap_get_func(
 else:  # pragma: no cover
 
     def get_annotations(
-        obj: Union[Callable[..., object], Type[Any], ModuleType]
+        obj: Union[Callable[..., object], Type[Any], ModuleType],
     ) -> Dict[str, Any]:
         """计算一个对象的标注字典。
 

alicebot/utils.py

@@ -12,15 +12,15 @@
   "homepage": "https://docs.alicebot.dev/",
   "license": "MIT",
   "dependencies": {
-    "vitepress": "1.0.0-rc.24",
-    "vue": "^3.3.7"
+    "vitepress": "1.0.0-rc.31",
+    "vue": "^3.3.11"
   },
   "devDependencies": {
-    "@types/node": "^20.8.9",
+    "@types/node": "^20.10.4",
     "conventional-changelog-cli": "^3.0.0",
     "markdownlint-cli2": "^0.8.1",
-    "prettier": "^3.0.3",
-    "pyright": "^1.1.333",
+    "prettier": "^3.1.1",
+    "pyright": "^1.1.339",
     "zhlint": "^0.7.1"
   },
   "scripts": {

package.json

@@ -1,9 +1,9 @@
 """通知事件。"""
 # pyright: reportIncompatibleVariableOverride=false
 
-from typing import Literal, Optional
+from typing import Any, Dict, Literal, Optional
 
-from pydantic import create_model
+from pydantic import create_model  # pyright: ignore[reportUnknownVariableType]
 
 from .base import (
     FriendInfo,
@@ -44,14 +44,15 @@ class FriendInputStatusChangedEvent(FriendEvent):
 
 
 # 因为 from 是 python 关键字，所以不能直接定义
+_temp_dict: Dict[str, Any] = {
+    "from": (str, ...),
+    "to": (str, ...),
+}
 FriendNickChangedEvent = create_model(
     "FriendNickChangedEvent",
     type=(Literal["FriendNickChangedEvent"], ...),
     friend=(FriendInfo, ...),
-    **{
-        "from": (str, ...),
-        "to": (str, ...),
-    },
+    **_temp_dict,
     __config__=None,
     __base__=FriendEvent,
     __module__=__name__,