Apply suggestions from code review

Co-authored-by: Joren Hammudoglu <[email protected]>
Signed-off-by: Nathaniel Starkman <[email protected]>

Author: nstarman

.github/workflows/ci.yml

@@ -1,15 +1,11 @@
 name: CI
-
-permissions:
-  contents: read
-  packages: read
+permissions: read-all
 
 on:
   workflow_dispatch:
   pull_request:
   push:
-    branches:
-      - main
+    branches: [main]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -29,20 +25,12 @@ jobs:
 
       - 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
+        run: uv sync --locked --group test
 
       - name: Run lefthook hooks
-        run: uv run lefthook run
+        run: uv run --frozen lefthook run pre-commit
 
   checks:
     name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
@@ -54,30 +42,22 @@ jobs:
         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 }}
+          python-version: ${{ matrix.python-version }}
 
       - name: Install the project
-        run: uv sync --group test
+        run: uv sync --locked --group test
 
       - name: Test package
         run: >-
-          uv run pytest src docs tests -ra --cov --cov-report=xml
-          --cov-report=term --durations=20
+          uv run --frozen pytest
+          -cov --cov-report=xml --cov-report=term --durations=20
+          src docs tests 
 
       - name: Upload coverage report
         uses: codecov/[email protected]
@@ -100,19 +80,15 @@ jobs:
       - 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 }}
-
+          python-version: ${{ matrix.python-version }}
       - name: Install the project
-        run: uv sync --extra all --group test-all --resolution lowest-direct
+        run: uv sync --locked --group test --resolution lowest-direct
 
       - name: Test package
         run: >-
-          uv run pytest src docs tests -ra --cov --cov-report=xml
-          --cov-report=term --durations=20 --mpl
+          uv run --frozen pytest
+          --cov --cov-report=xml --cov-report=term --durations=20
+          src docs tests
 
       - name: Upload coverage report
         uses: codecov/[email protected]

conftest.py

@@ -1,16 +1,18 @@
 """Pytest configuration file."""
 
+from typing import Final
+
 from sybil import Sybil
 from sybil.parsers.doctest import DocTestParser
 
-readme_tester = Sybil(
+readme_tester: Final = Sybil(
     parsers=[DocTestParser()],
     pattern="README.md",
 )
 
-python_file_tester = Sybil(
+python_file_tester: Final = Sybil(
     parsers=[DocTestParser()],
     pattern="src/**/*.py",
 )
 
-pytest_collect_file = (readme_tester + python_file_tester).pytest()
+pytest_collect_file: Final = (readme_tester + python_file_tester).pytest()

pyproject.toml

@@ -139,7 +139,7 @@ version_tuple = {version_tuple!r}
     ]
 
     [tool.ruff.lint.per-file-ignores]
-      "tests/*.py" = ["ANN201", "S101"]
+      "tests/*.py" = ["ANN201", "D1", "S101"]
 
     [tool.ruff.lint.flake8-import-conventions]
       banned-from = ["array_api_typing"]

src/array_api_typing/__init__.py

@@ -1,6 +1,10 @@
 """Static typing support for the array API standard."""
 
-__all__ = ["HasArrayNamespace", "__version__", "__version_tuple__"]
+__all__ = (
+    "HasArrayNamespace",
+    "__version__",
+    "__version_tuple__",
+)
 
 from ._namespace import HasArrayNamespace
 from ._version import version as __version__, version_tuple as __version_tuple__

src/array_api_typing/_namespace.py

@@ -1,6 +1,4 @@
-"""Static typing support for the array API standard."""
-
-__all__ = ["HasArrayNamespace"]
+__all__ = ("HasArrayNamespace",)
 
 from types import ModuleType
 from typing import Protocol, final

tests/__init__.py

@@ -1,5 +1,3 @@
-"""Tests for the HasArrayNamespace protocol."""
-
 from types import SimpleNamespace
 from typing import Protocol, runtime_checkable