Feature/pyright check (#1845)

* ✨ 新增Pyright Lint工作流 * ✨ 新增Ruff Lint工作流 * 👷 添加pydanitc矩阵 * 👷 添加手动触发支持 --------- Co-authored-by: BalconyJH <balconyjh@gmail.com>
2025-12-14 21:52:56 +08:00 · 2025-03-25 00:23:34 +08:00 · 2025-03-25 00:23:34 +08:00 · 737a740968
commit 737a740968
parent 629b4256af
13 changed files with 10162 additions and 195 deletions
--- a/.github/actions/setup-python/action.yml
+++ b/.github/actions/setup-python/action.yml
@ -0,0 +1,40 @@
+name: Setup Python
+description: Setup Python
+
+inputs:
+  python-version:
+    description: Python version
+    required: false
+    default: "3.10"
+  env-dir:
+    description: Environment directory
+    required: false
+    default: "."
+  no-root:
+    description: Do not install package in the environment
+    required: false
+    default: "false"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install poetry
+      run: pipx install poetry
+      shell: bash
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+        cache: "poetry"
+        cache-dependency-path: |
+          ./poetry.lock
+          ${{ inputs.env-dir }}/poetry.lock
+
+    - run: |
+        cd ${{ inputs.env-dir }}
+        if [ "${{ inputs.no-root }}" = "true" ]; then
+          poetry install --all-extras --no-root
+        else
+          poetry install --all-extras
+        fi
+      shell: bash
--- a/.github/workflows/linting.yml
+++ b/.github/workflows/linting.yml
@ -0,0 +1,11 @@
+name: Sequential Lint and Type Check
+
+on: [push, pull_request]
+
+jobs:
+  ruff-call:
+    uses: ./.github/workflows/ruff.yml
+
+  pyright-call:
+    needs: ruff-call
+    uses: ./.github/workflows/pyright.yml
--- a/.github/workflows/pyright.yml
+++ b/.github/workflows/pyright.yml
@ -0,0 +1,55 @@
+name: Pyright Lint
+
+on:
+  workflow_call:
+
+  workflow_dispatch:
+    inputs:
+      python-version:
+        description: "Python version"
+        required: false
+        type: choice
+        options:
+          - "all"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+        default: "all"
+      debug-mode:
+        description: "enable debug mode"
+        required: false
+        type: boolean
+        default: false
+
+jobs:
+  pyright:
+    name: Pyright Lint
+    runs-on: ubuntu-latest
+    concurrency:
+      group: pyright-${{ github.ref }}-${{ matrix.env }}
+      cancel-in-progress: true
+    strategy:
+      matrix:
+        env: [pydantic-v1, pydantic-v2]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python environment
+        uses: ./.github/actions/setup-python
+        with:
+          env-dir: ./envs/${{ matrix.env }}
+          no-root: true
+
+      - run: |
+          (cd ./envs/${{ matrix.env }} && echo "$(poetry env info --path)/bin" >> $GITHUB_PATH)
+          if [ "${{ matrix.env }}" = "pydantic-v1" ]; then
+            sed -i 's/PYDANTIC_V2 = true/PYDANTIC_V2 = false/g' ./pyproject.toml
+          fi
+        shell: bash
+
+      - name: Run Pyright Check
+        uses: jakebailey/pyright-action@v2
+        with:
+          pylance-version: latest-release
--- a/.github/workflows/ruff.yml
+++ b/.github/workflows/ruff.yml
@ -0,0 +1,20 @@
+name: Ruff Lint
+
+on:
+  workflow_call:
+
+jobs:
+  ruff:
+    name: Ruff Lint
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ruff-${{ github.ref }}
+      cancel-in-progress: true
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Ruff
+        uses: astral-sh/ruff-action@v3
+      - name: Run Ruff Check
+        run: ruff check
--- a/.vscode/extensions.json
+++ b/.vscode/extensions.json
@ -2,8 +2,6 @@
  "recommendations": [
    "charliermarsh.ruff",
    "esbenp.prettier-vscode",
-    "ms-python.black-formatter",
-    "ms-python.isort",
    "ms-python.python",
    "ms-python.vscode-pylance"
  ]
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@ -33,10 +33,10 @@
  "python.testing.unittestEnabled": false,
  "python.testing.pytestEnabled": true,
  "[python]": {
-    "editor.defaultFormatter": "charliermarsh.ruff", // 默认使用 Ruff 格式化
+    "editor.defaultFormatter": "charliermarsh.ruff",
    "editor.wordBasedSuggestions": "allDocuments",
    "editor.formatOnType": true,
-    "editor.formatOnSave": true, // 保存时自动格式化
+    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.fixAll.ruff": "explicit",
      "source.organizeImports": "explicit"
--- a/envs/pydantic-v1/poetry.lock
+++ b/envs/pydantic-v1/poetry.lock
--- a/envs/pydantic-v1/pyproject.toml
+++ b/envs/pydantic-v1/pyproject.toml
@ -0,0 +1,140 @@
+[tool.poetry]
+name = "zhenxun_bot"
+version = "0.2.4"
+description = "基于 Nonebot2 和 go-cqhttp 开发，以 postgresql 作为数据库，非常可爱的绪山真寻bot"
+authors = ["HibiKier <775757368@qq.com>"]
+license = "AGPL"
+package-mode = false
+
+[[tool.poetry.source]]
+name = "aliyun"
+url = "https://mirrors.aliyun.com/pypi/simple/"
+priority = "primary"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+playwright = "^1.41.1"
+nonebot-adapter-onebot = "^2.3.1"
+nonebot-plugin-apscheduler = "^0.5"
+tortoise-orm = { extras = ["asyncpg"], version = "^0.20.0" }
+cattrs = "^23.2.3"
+ruamel-yaml = "^0.18.5"
+strenum = "^0.4.15"
+nonebot-plugin-session = "^0.2.3"
+ujson = "^5.9.0"
+nb-cli = "^1.3.0"
+nonebot2 = { extras = ["fastapi"], version = "^2.3.3" }
+pillow = "^10.0.0"
+retrying = "^1.3.4"
+aiofiles = "^23.2.1"
+nonebot-plugin-htmlrender = ">=0.6.0,<1.0.0"
+pypinyin = "^0.51.0"
+beautifulsoup4 = "^4.12.3"
+lxml = "^5.1.0"
+psutil = "^5.9.8"
+feedparser = "^6.0.11"
+imagehash = "^4.3.1"
+cn2an = "^0.5.22"
+dateparser = "^1.2.0"
+bilireq = "0.2.3post0"
+python-jose = { extras = ["cryptography"], version = "^3.3.0" }
+python-multipart = "^0.0.9"
+aiocache = "^0.12.2"
+py-cpuinfo = "^9.0.0"
+nonebot-plugin-alconna = "^0.54.0"
+tenacity = "^9.0.0"
+nonebot-plugin-uninfo = ">0.4.1"
+pydantic = "1.10.18"
+
+[tool.poetry.group.dev.dependencies]
+nonebug = "^0.4"
+pytest-cov = "^5.0.0"
+pytest-mock = "^3.6.1"
+pytest-asyncio = "^0.25"
+pytest-xdist = "^3.3.1"
+respx = "^0.21.1"
+ruff = "^0.8.0"
+pre-commit = "^4.0.0"
+
+
+[tool.nonebot]
+plugins = [
+    "nonebot_plugin_apscheduler",
+    "nonebot_plugin_session",
+    "nonebot_plugin_htmlrender",
+    "nonebot_plugin_alconna",
+]
+plugin_dirs = ["zhenxun/services", "zhenxun/builtin_plugins", "zhenxun/plugins"]
+adapters = [
+    { name = "OneBot V11", module_name = "nonebot.adapters.onebot.v11" },
+    #    { name = "DoDo", module_name = "nonebot.adapters.dodo" },
+    #    { name = "开黑啦", module_name = "nonebot.adapters.kaiheila" },
+]
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+
+[tool.ruff.format]
+line-ending = "lf"
+
+[tool.ruff.lint]
+select = [
+    "F", # Pyflakes
+    "W", # pycodestyle warnings
+    "E", # pycodestyle errors
+    "I", # isort
+    "UP", # pyupgrade
+    "ASYNC", # flake8-async
+    "C4", # flake8-comprehensions
+    "T10", # flake8-debugger
+    "T20", # flake8-print
+    "PYI", # flake8-pyi
+    "PT", # flake8-pytest-style
+    "Q", # flake8-quotes
+    "TID", # flake8-tidy-imports
+    "RUF", # Ruff-specific rules
+]
+ignore = [
+    "E402", # module-import-not-at-top-of-file
+    "UP037", # quoted-annotation
+    "RUF001", # ambiguous-unicode-character-string
+    "RUF002", # ambiguous-unicode-character-docstring
+    "RUF003", # ambiguous-unicode-character-comment
+    "TID252", # relative-imports
+]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+known-first-party = ["zhenxun", "tests/*"]
+extra-standard-library = ["typing_extensions"]
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false
+
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
+[tool.pyright]
+pythonVersion = "3.10"
+pythonPlatform = "All"
+defineConstant = { PYDANTIC_V2 = true }
+executionEnvironments = [
+    { root = "./tests", extraPaths = [
+        "./",
+    ] },
+    { root = "./" },
+]
+
+typeCheckingMode = "standard"
+reportShadowedImports = false
+disableBytesTypePromotions = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
--- a/envs/pydantic-v2/poetry.lock
+++ b/envs/pydantic-v2/poetry.lock
--- a/envs/pydantic-v2/pyproject.toml
+++ b/envs/pydantic-v2/pyproject.toml
@ -0,0 +1,140 @@
+[tool.poetry]
+name = "zhenxun_bot"
+version = "0.2.4"
+description = "基于 Nonebot2 和 go-cqhttp 开发，以 postgresql 作为数据库，非常可爱的绪山真寻bot"
+authors = ["HibiKier <775757368@qq.com>"]
+license = "AGPL"
+package-mode = false
+
+[[tool.poetry.source]]
+name = "aliyun"
+url = "https://mirrors.aliyun.com/pypi/simple/"
+priority = "primary"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+playwright = "^1.41.1"
+nonebot-adapter-onebot = "^2.3.1"
+nonebot-plugin-apscheduler = "^0.5"
+tortoise-orm = { extras = ["asyncpg"], version = "^0.20.0" }
+cattrs = "^23.2.3"
+ruamel-yaml = "^0.18.5"
+strenum = "^0.4.15"
+nonebot-plugin-session = "^0.2.3"
+ujson = "^5.9.0"
+nb-cli = "^1.3.0"
+nonebot2 = { extras = ["fastapi"], version = "^2.3.3" }
+pillow = "^10.0.0"
+retrying = "^1.3.4"
+aiofiles = "^23.2.1"
+nonebot-plugin-htmlrender = ">=0.6.0,<1.0.0"
+pypinyin = "^0.51.0"
+beautifulsoup4 = "^4.12.3"
+lxml = "^5.1.0"
+psutil = "^5.9.8"
+feedparser = "^6.0.11"
+imagehash = "^4.3.1"
+cn2an = "^0.5.22"
+dateparser = "^1.2.0"
+bilireq = "0.2.3post0"
+python-jose = { extras = ["cryptography"], version = "^3.3.0" }
+python-multipart = "^0.0.9"
+aiocache = "^0.12.2"
+py-cpuinfo = "^9.0.0"
+nonebot-plugin-alconna = "^0.54.0"
+tenacity = "^9.0.0"
+nonebot-plugin-uninfo = ">0.4.1"
+pydantic = "2.10.6"
+
+[tool.poetry.group.dev.dependencies]
+nonebug = "^0.4"
+pytest-cov = "^5.0.0"
+pytest-mock = "^3.6.1"
+pytest-asyncio = "^0.25"
+pytest-xdist = "^3.3.1"
+respx = "^0.21.1"
+ruff = "^0.8.0"
+pre-commit = "^4.0.0"
+
+
+[tool.nonebot]
+plugins = [
+    "nonebot_plugin_apscheduler",
+    "nonebot_plugin_session",
+    "nonebot_plugin_htmlrender",
+    "nonebot_plugin_alconna",
+]
+plugin_dirs = ["zhenxun/services", "zhenxun/builtin_plugins", "zhenxun/plugins"]
+adapters = [
+    { name = "OneBot V11", module_name = "nonebot.adapters.onebot.v11" },
+    #    { name = "DoDo", module_name = "nonebot.adapters.dodo" },
+    #    { name = "开黑啦", module_name = "nonebot.adapters.kaiheila" },
+]
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+
+[tool.ruff.format]
+line-ending = "lf"
+
+[tool.ruff.lint]
+select = [
+    "F", # Pyflakes
+    "W", # pycodestyle warnings
+    "E", # pycodestyle errors
+    "I", # isort
+    "UP", # pyupgrade
+    "ASYNC", # flake8-async
+    "C4", # flake8-comprehensions
+    "T10", # flake8-debugger
+    "T20", # flake8-print
+    "PYI", # flake8-pyi
+    "PT", # flake8-pytest-style
+    "Q", # flake8-quotes
+    "TID", # flake8-tidy-imports
+    "RUF", # Ruff-specific rules
+]
+ignore = [
+    "E402", # module-import-not-at-top-of-file
+    "UP037", # quoted-annotation
+    "RUF001", # ambiguous-unicode-character-string
+    "RUF002", # ambiguous-unicode-character-docstring
+    "RUF003", # ambiguous-unicode-character-comment
+    "TID252", # relative-imports
+]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+known-first-party = ["zhenxun", "tests/*"]
+extra-standard-library = ["typing_extensions"]
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false
+
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
+[tool.pyright]
+pythonVersion = "3.10"
+pythonPlatform = "All"
+defineConstant = { PYDANTIC_V2 = true }
+executionEnvironments = [
+    { root = "./tests", extraPaths = [
+        "./",
+    ] },
+    { root = "./" },
+]
+
+typeCheckingMode = "standard"
+reportShadowedImports = false
+disableBytesTypePromotions = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
--- a/poetry.lock
+++ b/poetry.lock
--- a/zhenxun/builtin_plugins/web_ui/api/init.py
+++ b/zhenxun/builtin_plugins/web_ui/api/init.py
@ -1,2 +0,0 @@
-from .menu import *  # noqa: F403f
-from .tabs import *  # noqa: F403f
--- a/zhenxun/builtin_plugins/web_ui/api/tabs/database/init.py
+++ b/zhenxun/builtin_plugins/web_ui/api/tabs/database/init.py
@ -142,4 +142,4 @@ async def _(query: QueryModel) -> Result[BaseResultModel]:
 async def _(plugin_name: str | None = None) -> Result[dict]:
    if plugin_name:
        return Result.ok(ApiDataSource.SQL_DICT.get(plugin_name))
-    return Result.ok(str(ApiDataSource.SQL_DICT))
+    return Result.ok(ApiDataSource.SQL_DICT)