Add fomat action and run format.

ChenPi11 · ChenPi11 · commit 1ee5cc534023 · 2024-09-17T10:53:27.000+08:00
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12"]
 
     steps:
 
@@ -26,8 +26,7 @@ jobs:
     - name: 📁 Collect dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install -r requirements-dev.txt
+        pip install -r requirements.txt -r requirements-dev.txt
 
     #---------------------------------------------lint----------------------------------------------
     - name: 🛠️ Run lint
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,7 @@ __pycache__/
 *.so
 
 # Distribution / packaging
+rubisco-**
 .Python
 build/
 develop-eggs/
@@ -98,6 +99,7 @@ venv.bak/
 .vscode
 .cache
 .idea
+.ruff_cache
 
 # Spyder project settings
 .spyderproject
@@ -117,6 +119,9 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+# Pytype type checker
+.pytype/
+
 # Patterns for all subdirectories: all kinds of automatic backup files.
 *.orig
 *.rej
@@ -125,6 +130,3 @@ dmypy.json
 *.swp
 .#*
 \#*#
-
-# Dist directory
-rubisco-**
diff --git a/.rubisco/lint.yaml b/.rubisco/lint.yaml
@@ -6,8 +6,26 @@ steps:
   - popen: git ls-files \*.py
     id: files
 
+  - name: 🛠️ Analysing the code with ruff
+    run:
+      [
+        python,
+        -m,
+        ruff,
+        check,
+        rubisco,
+        --config,
+        ruff.toml,
+        --select,
+        ALL,
+        --ignore,
+        D203,
+        --ignore,
+        D213,
+      ]
+
   - name: 🛠️ Analysing the code with pylint
     run: python -m pylint -j ${{ nproc }} $(git ls-files \*.py)
 
-  - name: 🛠️ Analysing the code with flake8
-    run: python -m flake8 rubisco
+  - name: 🛠️ Running type check
+    run: python -m pytype --keep-going rubisco -j ${{ nproc }}
diff --git a/repo.json b/repo.json
@@ -15,7 +15,7 @@
       "run": ".rubisco/build.yaml"
     },
     "format": {
-      "exec": "python -m isort rubisco"
+      "exec": "python -m ruff format rubisco"
     },
     "clean": {
       "workflow": [
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,7 +1,9 @@
-pylint
-isort
-flake8
-Nuitka
 build
 hatchling
+isort
+Nuitka
+pylint
+urllib3[socks]  # Avoid urllib3's warning in pytype's check
 pytest
+pytype
+ruff
diff --git a/requirements.txt b/requirements.txt
@@ -1,9 +1,9 @@
 aiohttp >= 3.5.4
 colorama >= 0.3.9
 json-five >= 0.5.1
+py7zr >= 0.16.1
+pyyaml >= 5.4.1
 requests >= 2.18.4
 rich >= 6.2.0
 rich-argparse >= 1.0.0
-pyyaml >= 5.4.1
-py7zr >= 0.16.1
-typing_extensions
+typing_extensions >= 4.0.0
diff --git a/rubisco/cli/main.py b/rubisco/cli/main.py
@@ -26,7 +26,7 @@
 import os
 import sys
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Iterable, Sequence
+from typing import TYPE_CHECKING, Any
 
 import colorama
 import rich
@@ -69,6 +69,8 @@
 )
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable, Sequence
+
     from rubisco.kernel.workflow import Step, Workflow
     from rubisco.lib.process import Process
 
@@ -120,7 +122,7 @@ def __call__(
         self,
         parser: argparse.ArgumentParser,
         namespace: argparse.Namespace,  # noqa: ARG002
-        values: list,  # noqa: ARG002
+        values: str | Sequence[Any] | None,  # noqa: ARG002
         option_string: str | None = None,  # noqa: ARG002
     ) -> None:
         show_version()
diff --git a/rubisco/envutils/packages.py b/rubisco/envutils/packages.py
@@ -27,7 +27,7 @@
     from rubisco.lib.version import Version
 
 
-class ExtensionPackage:
+class ExtensionPackage:  # pylint: disable=too-few-public-methods
     """A package."""
 
     name: str
@@ -54,4 +54,4 @@ def __init__(
 
 
 if __name__ == "__main__":
-    pass  # TODO
+    pass
diff --git a/rubisco/kernel/git.py b/rubisco/kernel/git.py
@@ -234,7 +234,6 @@ def git_branch_set_upstream(
     colorama.init()
 
     class _GitTestKTrigger(IKernelTrigger):
-
         def on_update_git_repo(
             self,
             path: Path,
diff --git a/rubisco/kernel/mirrorlist.py b/rubisco/kernel/mirrorlist.py
@@ -224,7 +224,6 @@ def get_url(
     )
 
     class _TestKTrigger(IKernelTrigger):
-
         def pre_speedtest(self, host: str) -> None:
             rich.print(f"[blue]=>[/blue] Testing {host} ...", end="\n")
 
diff --git a/rubisco/kernel/workflow.py b/rubisco/kernel/workflow.py
@@ -21,16 +21,17 @@
 
 Workflow is a ordered list of steps. Each step only contains one action.
 """
+
 from __future__ import annotations
 
+import abc
 import glob
 import os
 import shutil
-import sys
 import uuid
 from abc import abstractmethod
 from pathlib import Path
-from typing import Generator
+from typing import TYPE_CHECKING, Any
 
 import json5 as json
 import yaml
@@ -56,6 +57,9 @@
 )
 from rubisco.shared.ktrigger import IKernelTrigger, call_ktrigger
 
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
 __all__ = [
     "Step",
     "ShellExecStep",
@@ -78,10 +82,19 @@
     "_set_extloader",
 ]
 
-try:  # Avoid circular import.
-    from rubisco.shared.extension import load_extension
-except ImportError:
-    load_extension = NotImplemented
+
+def load_extension(*args: Any, **kwargs: Any) -> None:  # noqa: ANN401
+    """Not implemented. Use `_set_extloader` to set.
+
+    Args:
+        *args: The arguments.
+        **kwargs: The keyword arguments.
+
+    Raises:
+        NotImplementedError: Always.
+
+    """
+    raise NotImplementedError
 
 
 # Avoid circular import.
@@ -91,7 +104,7 @@ def _set_extloader(extloader) -> None:  # noqa: ANN001
     load_extension = extloader
 
 
-class Step:  # pylint: disable=too-many-instance-attributes
+class Step(abc.ABC):  # pylint: disable=too-many-instance-attributes
     """A step in the workflow."""
 
     id: str
@@ -413,17 +426,11 @@ def init(self) -> None:
     def run(self) -> None:
         """Run the step."""
         for glob_partten in self.globs:
-            if sys.version_info >= (3, 10):
-                paths = glob.glob(  # pylint: disable=E1123  # noqa: PTH207
-                    glob_partten,
-                    recursive=True,
-                    include_hidden=self.include_hidden,
-                )
-            else:
-                paths = glob.glob(  # pylint: disable=E1123  # noqa: PTH207
-                    glob_partten,
-                    recursive=True,
-                )
+            paths = glob.glob(  # pylint: disable=E1123  # noqa: PTH207
+                glob_partten,
+                recursive=True,
+                include_hidden=self.include_hidden,
+            )
             for str_path in paths:
                 path = Path(str_path)
                 call_ktrigger(IKernelTrigger.on_remove, path=path)
diff --git a/rubisco/lib/archive.py b/rubisco/lib/archive.py
@@ -414,13 +414,15 @@ def extract(  # pylint: disable=too-many-branches # noqa: C901 PLR0912
                 compress_type = suffix1[1:]
             else:
                 raise RUValueError(
-                    str(format_str(
-                        _(
-                            "Unable to determine compression type of "
-                            "'[underline]${{path}}[/underline]'",
+                    str(
+                        format_str(
+                            _(
+                                "Unable to determine compression type of "
+                                "'[underline]${{path}}[/underline]'",
+                            ),
+                            fmt={"path": str(file)},
                         ),
-                        fmt={"path": str(file)},
-                    )),
+                    ),
                     hint=_("Please specify the compression type explicitly."),
                 )
         if compress_type in ["gz", "gzip"]:
diff --git a/rubisco/lib/command.py b/rubisco/lib/command.py
@@ -18,6 +18,7 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 """Generate command line."""
+
 from __future__ import annotations
 
 __all__ = ["command"]
diff --git a/rubisco/lib/fileutil.py b/rubisco/lib/fileutil.py
@@ -134,7 +134,6 @@ def _onerror(
         return _onexc(func, path, exc_info[1])
 
     try:
-
         if path.is_dir() and not path.is_symlink():
             if sys.version_info <= (3, 12):
                 shutil.rmtree(  # pylint: disable=deprecated-argument
diff --git a/rubisco/lib/l10n_lang_names.py b/rubisco/lib/l10n_lang_names.py
@@ -246,8 +246,8 @@
     "ms_MY": "Bahasa Melayu (Malaysia)",  # Malay (Malaysia)
     "mt_MT": "Malti (Malta)",  # Maltese (Malta)
     "my_MM": "မြန်မာ (မြန်မာ)",  # Burmese (Myanmar)
-    "nan_TW": "閩南語 (中華人民共和國臺灣省)",  # Min Nan (Taiwan)
-    "nan_TW@latin": "閩南語 (中華人民共和國臺灣省, latin)",  # Min Nan (Taiwan, Latin)
+    "nan_TW": "閩南語 (中國臺灣)",  # Min Nan (Taiwan)
+    "nan_TW@latin": "閩南語 (中國臺灣, latin)",  # Min Nan (Taiwan, Latin)
     "nb_NO": "Norsk bokmål (Norge)",  # Norwegian Bokmål (Norway)
     "nds_DE": "Plattdüütsch (Düütschland)",  # Low German (Germany)
     "nds_NL": "Nedersaksisch (Nederland)",  # Low Saxon (Netherlands)
diff --git a/rubisco/lib/log.py b/rubisco/lib/log.py
@@ -55,6 +55,7 @@
     logger.addHandler(logging.NullHandler())
 
 if "--debug" in sys.argv:  # Don't use argparse here.
+    import rich
     import rich.logging
 
     logger_handler = rich.logging.RichHandler(
diff --git a/rubisco/lib/process.py b/rubisco/lib/process.py
@@ -168,9 +168,7 @@ def popen(
             stdin=sys.stdin,
             stdout=PIPE if stdout else sys.stdout,
             stderr=(
-                PIPE
-                if stderr == 1
-                else (STDOUT if stderr == 2 else sys.stderr)  # noqa: PLR2004
+                PIPE if stderr == 1 else (STDOUT if stderr == 2 else sys.stderr)  # noqa: PLR2004
             ),
         ) as self.process:
             ret = self.process.wait()
diff --git a/rubisco/lib/speedtest.py b/rubisco/lib/speedtest.py
@@ -21,6 +21,7 @@
 
 import time
 
+import aiohttp
 import aiohttp.client_exceptions
 
 from rubisco.config import TIMEOUT
diff --git a/rubisco/lib/variable.py b/rubisco/lib/variable.py
diff --git a/rubisco/lib/version.py b/rubisco/lib/version.py
diff --git a/rubisco/lib/wget.py b/rubisco/lib/wget.py
diff --git a/rubisco/shared/extension.py b/rubisco/shared/extension.py
diff --git a/rubisco/shared/ktrigger.py b/rubisco/shared/ktrigger.py
diff --git a/ruff.toml b/ruff.toml

-Original file line number
+Diff line change
@@ @@ -1,7 +1,9 @@ @@
 -pylint
 -isort
 -flake8
 -Nuitka
 build
 hatchling
 +isort
 +Nuitka
 +pylint
 +urllib3[socks]  # Avoid urllib3's warning in pytype's check
 pytest
 +pytype
 +ruff
Original file line number	Diff line number	Diff line change
`@@ -224,7 +224,6 @@ def get_url(`
`224`	`224`	`)`
`225`	`225`
`226`	`226`	`class _TestKTrigger(IKernelTrigger):`
`227`		`-`
`228`	`227`	`def pre_speedtest(self, host: str) -> None:`
`229`	`228`	`rich.print(f"[blue]=>[/blue] Testing {host} ...", end="\n")`
`230`	`229`