♻️ refactor: add pyright check

.github/workflows/e2e-test.yml

@@ -30,13 +30,17 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: Gr1N/setup-poetry@v7
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.2.0rc2
+
       - uses: actions/cache@v3
         id: poetry-cache
         with:
           path: |
             **/.venv
-          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.architecture }}-poetry-${{ hashFiles('poetry.lock') }}
 
       - name: Install dependencies
         if: steps.poetry-cache.outputs.cache-hit != 'true'
@@ -52,4 +56,4 @@ jobs:
 
       - name: e2e test
         run: |
-          poetry run pytest -m "e2e and not (ci_skip or ignore)" --workers auto
+          just ci-e2e-test

.github/workflows/lint-and-fmt.yml

@@ -0,0 +1,51 @@
+name: Lint and Format
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  lint-and-fmt:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10"]
+        architecture: ["x64"]
+    name: Python ${{ matrix.python-version }} on ${{ matrix.architecture }} test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: ${{ matrix.architecture }}
+
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.2.0rc2
+
+      - name: Install just
+        uses: extractions/setup-just@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/cache@v3
+        id: poetry-cache
+        with:
+          path: |
+            **/.venv
+          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.architecture }}-poetry-${{ hashFiles('poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.poetry-cache.outputs.cache-hit != 'true'
+        run: |
+          just install
+
+      - name: lint
+        run: |
+          just ci-lint
+
+      - name: format check
+        run: |
+          just ci-fmt-check

.github/workflows/unit-test.yml

@@ -20,19 +20,28 @@ jobs:
           python-version: ${{ matrix.python-version }}
           architecture: ${{ matrix.architecture }}
 
-      - uses: Gr1N/setup-poetry@v7
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.2.0rc2
+
+      - name: Install just
+        uses: extractions/setup-just@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - uses: actions/cache@v3
         id: poetry-cache
         with:
           path: |
             **/.venv
-          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.architecture }}-poetry-${{ hashFiles('poetry.lock') }}
 
       - name: Install dependencies
         if: steps.poetry-cache.outputs.cache-hit != 'true'
         run: |
-          poetry install
+          just install
 
       - name: unit test
         run: |
-          poetry run pytest -m "(api or processor) and not (ci_skip or ignore)" --workers auto
+          just ci-test

justfile

@@ -6,6 +6,9 @@ DOCKER_NAME := "siguremo/yutto"
 run *ARGS:
   poetry run python -m yutto {{ARGS}}
 
+install:
+  poetry install
+
 test:
   poetry run pytest -m '(api or e2e or processor) and not (ci_only or ignore)' --workers auto
   just clean
@@ -14,6 +17,9 @@ fmt:
   poetry run isort .
   poetry run black .
 
+lint:
+  poetry run pyright yutto tests
+
 build:
   poetry build
 
@@ -50,6 +56,21 @@ clean-builds:
   rm -rf dist/
   rm -rf yutto.egg-info/
 
+ci-fmt-check:
+  poetry run isort --check-only .
+  poetry run black --check --diff .
+
+ci-lint:
+  just lint
+
+ci-test:
+  poetry run pytest -m "(api or processor) and not (ci_skip or ignore)" --workers auto
+  just clean
+
+ci-e2e-test:
+  poetry run pytest -m "e2e and not (ci_skip or ignore)" --workers auto
+  just clean
+
 docker-run *ARGS:
   docker run --rm -it -v `pwd`:/app {{DOCKER_NAME}} {{ARGS}}
 

pyproject.toml

@@ -12,6 +12,7 @@ classifiers = [
   "Environment :: Console",
   "Operating System :: OS Independent",
   "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+  "Typing :: Typed",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3.9",
@@ -28,11 +29,12 @@ uvloop = { version = "0.16.0", optional = true }
 dicttoxml = "^1.7.4"
 colorama = { version = "^0.4.5", markers = "sys_platform == 'win32'" }
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 pytest = "^7.0"
 black = "^22.1"
 pytest-parallel = "^0.1.1"
 isort = "^5.10.1"
+pyright = "^1.1.268"
 
 [tool.poetry.extras]
 uvloop = ["uvloop"]
@@ -51,7 +53,14 @@ line-length = 120
 
 [tool.isort]
 profile = "black"
+add_imports = ["from __future__ import annotations"]
+skip = ["setup.py", ".venv"]
+
+[tool.pyright]
+include = ["yutto", "tests"]
+pythonVersion = "3.9"
+typeCheckingMode = "strict"
 
 [build-system]
-requires = ["poetry_core>=1.0.0"]
+requires = ["poetry_core>=1.1.0rc2"]
 build-backend = "poetry.core.masonry.api"

tests/conftest.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import shutil
 from pathlib import Path
 

tests/test_api/test_bangumi.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import aiohttp
 import pytest
 
@@ -10,7 +12,7 @@
     get_season_id_by_media_id,
 )
 from yutto.utils.fetcher import Fetcher
-from yutto.utils.functools import as_sync
+from yutto.utils.funcutils import as_sync
 
 
 @pytest.mark.api

tests/test_api/test_collection.py

@@ -1,10 +1,12 @@
+from __future__ import annotations
+
 import aiohttp
 import pytest
 
 from yutto._typing import BvId, MId, SeriesId
 from yutto.api.collection import get_collection_details
 from yutto.utils.fetcher import Fetcher
-from yutto.utils.functools import as_sync
+from yutto.utils.funcutils import as_sync
 
 
 @pytest.mark.api

tests/test_api/test_danmaku.py

@@ -1,10 +1,12 @@
+from __future__ import annotations
+
 import aiohttp
 import pytest
 
 from yutto._typing import CId
 from yutto.api.danmaku import get_danmaku, get_protobuf_danmaku, get_xml_danmaku
 from yutto.utils.fetcher import Fetcher
-from yutto.utils.functools import as_sync
+from yutto.utils.funcutils import as_sync
 
 
 @pytest.mark.api

tests/test_api/test_space.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import aiohttp
 import pytest
 
@@ -12,7 +14,7 @@
     get_user_space_all_videos_avids,
 )
 from yutto.utils.fetcher import Fetcher
-from yutto.utils.functools import as_sync
+from yutto.utils.funcutils import as_sync
 
 
 @pytest.mark.api

tests/test_api/test_ugc_video.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import aiohttp
 import pytest
 
@@ -9,7 +11,7 @@
     get_ugc_video_subtitles,
 )
 from yutto.utils.fetcher import Fetcher
-from yutto.utils.functools import as_sync
+from yutto.utils.funcutils import as_sync
 
 
 @pytest.mark.api