ci: add lints + format check (#114)

Link to PR:
Arm-Debug/vgf-adapter-model-explorer#114

Author: hlivin01

.github/actions/build-wheel/action.yml

@@ -198,7 +198,6 @@ runs:
           NPROC=$(sysctl -n hw.ncpu)
         fi
         python ${SDK_PATH}/sw/vgf-lib/scripts/build.py -j $NPROC
-        
 
     - name: Copy dependencies
       shell: bash
@@ -228,9 +227,9 @@ runs:
       shell: bash
       run: |
         cd "$WORK_DIR"
-        python -m pip install .[test]
+        python -m pip install . --group dev
         if [ "${{ github.repository_owner }}" != "arm" ]; then
-            python -m pip install .[coverage]
+            python -m pip install . --group coverage
         fi
 
     - name: Update PATH
@@ -269,7 +268,7 @@ runs:
       shell: bash
       run: |
         cd "$WORK_DIR"
-        python -m pip install .[sbom]
+        python -m pip install . --group sbom
         python ./scripts/generate-mlir-bin-sbom.py \
           --llvm-ref ${{ steps.dep-revisions.outputs.llvm-ref }} \
           --model-converter-ref ${{ steps.dep-revisions.outputs.model-converter-ref }} \
@@ -286,7 +285,7 @@ runs:
 
         echo -e "[bdist_wheel]\npython_tag = cp$TAG\nplat_name = ${{ inputs.platform }}" > setup.cfg
 
-        python -m pip install build wheel
+        python -m pip install --group build
         python -m build
 
         mkdir -p wheelhouse

.github/workflows/check.yml

@@ -6,11 +6,28 @@ on:
 
 jobs:
   lint-and-format:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13", "3.12", "3.11", "3.10"]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - name: Install qlty
-        uses: qltysh/qlty-action/install@v1
-      - name: Check lint
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Checkout plugin repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Install plugin Python packages
+        run: |
+          pip install --upgrade pip
+          pip install . --group dev
+
+      - name: Lint and Format Check
+        run: |
+          ruff check --output-format=github
+          ruff format --check
+
+      - name: Type Check
         run: |
-          qlty check
+          pyright

pyproject.toml

@@ -37,30 +37,31 @@ dependencies = [
 Repository = "https://github.com/arm/vgf-adapter-model-explorer"
 Changelog = "https://github.com/arm/vgf-adapter-model-explorer/releases"
 
-[project.optional-dependencies]
-test = [
-    "pytest",
-    "pytest-timeout",
+[dependency-groups]
+dev = [
+    "pytest==9.0.1",
+    "pytest-timeout==2.4.0",
+    "ruff==0.14.2",
+    "pyright==1.1.407",
     "ai-edge-model-explorer==0.1.28"
 ]
-format = [
-  "ruff==0.14.2"
-]
 coverage = [
-  "pytest-cov"
+    "pytest-cov==7.0.0",
+]
+build = [
+    "build==1.3.0",
+    "wheel==0.45.1"
 ]
 sbom = [
   "spdx-tools==0.8.3"
 ]
 
 [tool.pyright]
-extraPaths = [
-    ".",
-    "./src",
+include = [
+  "src",
 ]
-autoSearchPaths = true
-useLibraryCodeForTypes = true
-diagnosticMode = "workspace"
+typeCheckingMode = "standard"
+
 
 [tool.setuptools]
 include-package-data = true
@@ -84,7 +85,7 @@ testpaths = ["src/vgf_adapter_model_explorer/tests"]
 
 [tool.ruff]
 line-length = 79
-target-version = "py312"
+target-version = "py310"
 
 [tool.ruff.lint]
 # https://docs.astral.sh/ruff/rules/

src/vgf_adapter_model_explorer/generic.py

@@ -7,7 +7,7 @@
 from typing import Any, Dict, List, Optional
 
 import numpy as np
-from mlir import ir
+from mlir import ir  # type: ignore[reportMissingImports]
 from model_explorer import graph_builder as gb
 
 from . import constants as cn

src/vgf_adapter_model_explorer/parser/parser.py

@@ -6,6 +6,7 @@
 
 import json
 import os
+from pathlib import Path
 from typing import Any, Callable, Dict
 
 from .types import (
@@ -24,7 +25,7 @@ class Parser:
     def __init__(
         self,
         model_path: str,
-        spirv_binary_extractor: Callable[[str], Dict[str, Any]],
+        spirv_binary_extractor: Callable[[str], Path],
     ):
         self.model_name = os.path.basename(model_path)
         spv_path = spirv_binary_extractor(os.path.abspath(model_path))

src/vgf_adapter_model_explorer/spirv/spirv.py

@@ -6,7 +6,7 @@
 
 from typing import Dict
 
-from mlir import ir
+from mlir import ir  # type: ignore[reportMissingImports]
 from model_explorer import graph_builder as gb
 
 from .. import constants as cn
@@ -70,7 +70,10 @@ def build_function_graph(
             traversed_ops=traversed_ops,
         )
 
-        if "Tosa" not in operation.name and "GraphOutputs" not in operation.name:
+        if (
+            "Tosa" not in operation.name
+            and "GraphOutputs" not in operation.name
+        ):
             continue
 
         function_graph.nodes.append(node)

src/vgf_adapter_model_explorer/spirv/spirv_node_builder.py

@@ -4,7 +4,7 @@
 # Licensed under the Apache License v2.0
 # See http://www.apache.org/licenses/LICENSE-2.0 for license information.
 
-from mlir import ir
+from mlir import ir  # type: ignore[reportMissingImports]
 from model_explorer import graph_builder as gb
 
 from ..constants import GRAPH_INPUT_ANNOTATION

src/vgf_adapter_model_explorer/tests/test_model_explorer_cli.py

@@ -41,6 +41,8 @@ def test_model_explorer_smoke():
     ]
     seen_lines = dict.fromkeys(searched_lines, False)
 
+    assert proc.stdout is not None
+
     for line in proc.stdout:
         if searched_lines[curr_searched] in line:
             seen_lines[searched_lines[curr_searched]] = True