✅ test: add tests & CI

Signed-off-by: Nathaniel Starkman <[email protected]>

Author: nstarman

.github/workflows/ci.yml

@@ -0,0 +1,120 @@
+name: CI
+
+permissions:
+  contents: read
+  packages: read
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  # Many color libraries just need this to be set to any value, but at least
+  # one distinguishes color depth, where "3" -> "256-bit color".
+  FORCE_COLOR: 3
+
+jobs:
+  format:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install the project
+        run: uv sync --group test
+
+      - name: Run lefthook hooks
+        run: uv run lefthook run
+
+  checks:
+    name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
+    runs-on: ${{ matrix.runs-on }}
+    needs: [format]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+        runs-on: [ubuntu-latest, macos-latest, windows-latest]
+
+        # TODO: check when pypy3.11 is available
+        # include:
+        #   - python-version: pypy-3.11
+        #     runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --group test
+
+      - name: Test package
+        run: >-
+          uv run pytest src docs tests -ra --cov --cov-report=xml
+          --cov-report=term --durations=20
+
+      - name: Upload coverage report
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  check_oldest:
+    name: Check Oldest Dependencies
+    runs-on: ${{ matrix.runs-on }}
+    needs: [format]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11"]
+        runs-on: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --extra all --group test-all --resolution lowest-direct
+
+      - name: Test package
+        run: >-
+          uv run pytest src docs tests -ra --cov --cov-report=xml
+          --cov-report=term --durations=20 --mpl
+
+      - name: Upload coverage report
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

lefthook.yml

@@ -13,4 +13,4 @@ pre-commit:
       run: uv run ruff format {staged_files}
     - name: mypy
       glob: "*.py"
-      run: uv run mypy {staged_files}
+      run: uv run --group mypy mypy {staged_files}

pyproject.toml

@@ -51,6 +51,9 @@
     "pytest-github-actions-annotate-failures>=0.3.0",
     "sybil>=8.0.0",
   ]
+  mypy = [
+    "mypy>=1.13.0"
+  ]
 
 
 [tool.hatch]
@@ -74,6 +77,7 @@ version_tuple = {version_tuple!r}
 [tool.mypy]
   files = ["src", "tests"]
   python_version = "3.10"
+  mypy_path = "src"
 
   strict = true
   disallow_incomplete_defs = true
@@ -90,6 +94,10 @@ version_tuple = {version_tuple!r}
     module = "sybil.*"
     ignore_missing_imports = true
 
+  [[tool.mypy.overrides]]
+    module = "tests.*"
+    disallow_untyped_defs = false
+
 
 [tool.pytest.ini_options]
   addopts = [
@@ -130,6 +138,9 @@ version_tuple = {version_tuple!r}
       "ISC001", # Conflicts with formatter
     ]
 
+    [tool.ruff.lint.per-file-ignores]
+      "tests/*.py" = ["ANN201", "S101"]
+
     [tool.ruff.lint.flake8-import-conventions]
       banned-from = ["array_api_typing"]
 

tests/__init__.py

@@ -0,0 +1 @@
+"""Tests."""

tests/test_namespace.py

@@ -0,0 +1,44 @@
+"""Tests for the HasArrayNamespace protocol."""
+
+from types import SimpleNamespace
+from typing import Protocol, runtime_checkable
+
+import array_api_typing as xpt
+
+
+@runtime_checkable
+class CheckableHasArrayNamespace(xpt.HasArrayNamespace, Protocol):  # type: ignore[misc]
+    """Runtime checkable version of HasArrayNamespace."""
+
+
+class GoodArray:
+    """Example class that implements the HasArrayNamespace protocol."""
+
+    def __array_namespace__(self) -> object:  # noqa: PLW3201
+        return SimpleNamespace()
+
+
+class BadArray:
+    """Example class that does not implement the HasArrayNamespace protocol."""
+
+
+def test_has_namespace_class():
+    """Test that GoodArray is a subclass of HasArrayNamespace."""
+    assert issubclass(GoodArray, CheckableHasArrayNamespace)
+
+
+def test_has_namespace_instance():
+    """Test that an instance of GoodArray is recognized as HasArrayNamespace."""
+    x = GoodArray()
+    assert isinstance(x, CheckableHasArrayNamespace)
+
+
+def test_not_has_namespace_class():
+    """Test that BadArray is not a subclass of HasArrayNamespace."""
+    assert not issubclass(BadArray, CheckableHasArrayNamespace)
+
+
+def test_not_has_namespace_instance():
+    """Test that an instance of BadArray is not recognized as HasArrayNamespace."""
+    y = BadArray()
+    assert not isinstance(y, CheckableHasArrayNamespace)