chore: add ty type checker and reorder make commands for faster feedback

Add ty as a development dependency for use as a language server in text
editors. ty provides fast type checking that complements pyright/mypy,
while ruff handles missing type hints detection.

Reorder make commands to run the fastest checks first (ruff, flake8, ty)
before the slower mypy and pyright, improving feedback speed.

Signed-off-by: Gaëtan Lehmann <gaetan.lehmann@vates.tech>

Author: glehmann

.github/workflows/code-checkers.yml

@@ -31,6 +31,19 @@ jobs:
         run: cp vm_data.py-dist vm_data.py
       - run: pyright .
 
+  ty:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          persist-credentials: false
+      - uses: ./.github/actions/uv-setup/
+      - name: Create a dummy data.py
+        run: cp data.py-dist data.py
+      - name: Create a dummy vm_data.py
+        run: cp vm_data.py-dist vm_data.py
+      - run: ty check .
+
   ruff:
     runs-on: ubuntu-latest
     env:

.pre-commit-config.yaml

@@ -13,6 +13,12 @@ repos:
         require_serial: true
         entry: "uv run flake8"
         types: ["python"]
+      - id: "ty"
+        name: "ty"
+        language: "system"
+        require_serial: true
+        entry: "uv run ty check ."
+        types: ["python"]
       - id: "mypy"
         name: "mypy"
         language: "system"

Makefile

@@ -1,9 +1,9 @@
 # Makefile to run static code checkers locally
 # Equivalent to the GitHub Actions workflow in .github/workflows/code-checkers.yml
 
-.PHONY: all mypy pyright ruff flake8
+.PHONY: all mypy pyright ruff flake8 ty
 
-all: mypy pyright ruff flake8
+all: ruff flake8 ty pyright mypy
 
 data.py:
 	@test -r data.py || echo "File 'data.py' does not exist. Refer to https://github.com/xcp-ng/xcp-ng-tests#configuration." && exit 1
@@ -19,3 +19,6 @@ ruff: data.py
 
 flake8:
 	uv run flake8
+
+ty: data.py
+	uv run ty check .

conftest.py

@@ -186,7 +186,8 @@ def pytest_runtest_makereport(
 
     # store test results for each phase of a call, which can
     # be "setup", "call", "teardown"
-    item.stash.setdefault(PHASE_REPORT_KEY, {})[rep.when] = rep
+    assert rep.when is not None
+    item.stash.setdefault(PHASE_REPORT_KEY, {})[rep.when]# = rep
 
     return rep
 

lib/config.py

@@ -1,9 +1,9 @@
 from lib.common import GiB
 
-ignore_ssh_banner = False
-ssh_output_max_lines = 20
-volume_size = 1 * GiB
-write_volume_cap = 2 * GiB
+ignore_ssh_banner: bool = False
+ssh_output_max_lines: int = 20
+volume_size: int = 1 * GiB
+write_volume_cap: int = 2 * GiB
 
 def sr_device_config(datakey: str, *, required: list[str] = []) -> dict[str, str]:
     import data  # import here to avoid depending on this user file for collecting tests

lib/host.py

@@ -680,7 +680,7 @@ def rescan_block_devices_info(self) -> None:
         )  # limit to: sd, blkext
 
         self.block_devices_info = [
-            Host.BlockDeviceInfo({key.lower(): value.strip('"') # type: ignore[misc]
+            Host.BlockDeviceInfo({key.lower(): value.strip('"') # type: ignore
                                   for key, value in re.findall(r'(\S+)=(".*?"|\S+)', line)})
             for line in output_string.strip().splitlines()
         ]

pyproject.toml

@@ -19,18 +19,19 @@ dependencies = [
 [dependency-groups]
 dev = [
     "bs4>=0.0.1",
-    "mypy",
     "flake8",
     "flake8-pyproject",
+    "libarchive-c==5.3",
+    "mypy",
     "pydocstyle",
     "pyright",
     "ruff",
-    "types-requests",
-    "typing-extensions",
-    "libarchive-c==5.3",
-    "types-pygments",
+    "ty",
     "types-colorama",
     "types-pexpect",
+    "types-pygments",
+    "types-requests",
+    "typing-extensions",
     "zizmor",
     "prek>=0.3.11",
 ]
@@ -40,6 +41,9 @@ typeCheckingMode = "standard"
 reportMissingParameterType = "error"
 reportUnknownParameterType = "error"
 
+[tool.ty.rules]
+unused-type-ignore-comment = "ignore"
+
 [tool.ruff]
 preview = true
 line-length = 120
@@ -50,6 +54,7 @@ quote-style = "preserve"
 
 [tool.ruff.lint]
 select = [
+  "ANN",  # flake8-annotations
   "D",  # pydocstyle
   "FA",  # future-annotations
   "F",  # Pyflakes
@@ -62,6 +67,7 @@ select = [
 ]
 # don't use some of the default D and SIM rules
 ignore = [
+  "ANN401",  # missing-return-type-special-method. Might be removed later.
   "D100",  # undocumented-public-module
   "D101",  # undocumented-public-class
   "D102",  # undocumented-public-method
@@ -82,6 +88,7 @@ ignore = [
   "SIM105",  # suppressible-exception
   "SIM108",  # if-else-block-instead-of-if-exp
 ]
+flake8-annotations.mypy-init-return = true
 
 # restrict to the PEP 257 rules
 pydocstyle.convention = "pep257"

requirements/dev.txt

@@ -1,17 +1,18 @@
 # generated with update_requirements.py, do not edit manually
 bs4>=0.0.1
-mypy
 flake8
 flake8-pyproject
+libarchive-c==5.3
+mypy
 pydocstyle
 pyright
 ruff
-types-requests
-typing-extensions
-libarchive-c==5.3
-types-pygments
+ty
 types-colorama
 types-pexpect
+types-pygments
+types-requests
+typing-extensions
 zizmor
 prek>=0.3.11
 -r base.txt

scripts/xva_bridge.py

@@ -19,19 +19,19 @@ def __init__(self, member: minidom.Element):
 
     def get_name(self) -> str | None:
         for child in self.member.childNodes:
-            if child.nodeType == minidom.Node.ELEMENT_NODE and child.tagName == "name" and child.firstChild:
+            if isinstance(child, minidom.Element) and child.tagName == "name" and child.firstChild:
                 return child.firstChild.nodeValue
         return None
 
     def get_value(self) -> str | None:
         for child in self.member.childNodes:
-            if child.nodeType == minidom.Node.ELEMENT_NODE and child.tagName == "value" and child.firstChild:
+            if isinstance(child, minidom.Element) and child.tagName == "value" and child.firstChild:
                 return child.firstChild.nodeValue
         return None
 
     def set_value(self, value: str) -> None:
         for child in self.member.childNodes:
-            if child.nodeType == minidom.Node.ELEMENT_NODE and child.tagName == "value" and child.firstChild:
+            if isinstance(child, minidom.Element) and child.tagName == "value" and child.firstChild:
                 child.firstChild.nodeValue = value  # type: ignore
         return None