name: Type-checking

# Mypy is too slow to run as part of regular CI. The purpose of the jobs in
# this file is to cover running Mypy across:
#
#   - OSes: Linux, Windows and macOS
#   - Python versions: lowest/highest supported versions, and an intermediate one
#
# The build matrix aims for sparse coverage across those two dimensions.
# Use of BLAS/LAPACK and SIMD is disabled on purpose, because those things
# don't matter for static typing and this speeds up the builds.
#
# This is a separate job file so it's easy to trigger by hand.

on:
  pull_request:
    branches:
      - main
      - maintenance/**
    paths-ignore:
      - '**.md'
      - '**.rst'
      - '.circlecl/**'
      - '.devcontainer/**'
      - '.spin/LICENSE'
      - 'benchmarks/**'
      - 'branding/**'
      - 'doc/**'
      - 'meson_cpu/**'
      - 'tools/**'
      - 'vendored-meson/**'
  workflow_dispatch:

defaults:
  run:
    shell: bash

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

permissions:
  contents: read # to fetch code (actions/checkout)

jobs:
  mypy:
    # To enable this workflow on a fork, comment out:
    if: github.repository == 'numpy/numpy'
    name: "MyPy"
    runs-on: ${{ matrix.os_python[0] }}
    strategy:
      fail-fast: false
      matrix:
        os_python:
          - [macos-latest, '3.14']
          - [ubuntu-latest, '3.13']
          - [windows-2022, '3.12']
    steps:
    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        submodules: recursive
        fetch-tags: true
        persist-credentials: false
    - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
      with:
        python-version: ${{ matrix.os_python[1] }}
        activate-environment: true
        cache-dependency-glob: |
          requirements/build_requirements.txt
          requirements/typing_requirements.txt
    - name: Install dependencies
      # orjson makes mypy faster but the default requirements.txt
      # can't install it because orjson doesn't support 32 bit Linux
      run: >-
        uv pip install
        -r requirements/build_requirements.txt
        -r requirements/typing_requirements.txt
        orjson
        basedpyright
    - name: Build
      run: |
        spin build -j2 -- -Dallow-noblas=true -Ddisable-optimization=true --vsenv
    - name: Run Mypy
      run: |
        spin mypy
    - name: Check basedpyright's type completeness is at least 100%
      run: >-
        spin run python tools/pyright_completeness.py
        --verifytypes numpy
        --ignoreexternal
        --exclude-like '*.tests.*' '*.conftest.*'

  pyrefly:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
    - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
      with:
        activate-environment: true
    - name: Install dependencies
      run: >-
        uv pip install
        -r requirements/typing_requirements.txt
    - name: Run pyrefly
      run: pyrefly check
