python-package.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Python Package

on:
  # `push` restricted to `main` so feature branches only run via `pull_request`.
  # Otherwise every push to a branch with an open PR would trigger the workflow
  # twice (once for `push`, once for `pull_request`) — doubling CI cost and
  # latency for no benefit.
  push:
    branches: [main]
  pull_request:
  # Allow re-running the workflow without an empty push (handy after the
  # workflow gets `disabled_inactivity` after 60 days idle).
  workflow_dispatch:
  schedule:
    - cron:  '0 0 */7 * *'

# Cancel an in-flight run when a newer commit lands on the same ref. Keeps the
# queue lean and stops stale runs from blocking the merge button.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'
    - name: Install lint deps
      run: |
        python -m pip install --upgrade pip
        pip install flake8
    - name: Lint
      run: |
        flake8 PyMemoryEditor tests

  type-check:
    needs: lint
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'
    - name: Install dev deps
      # Include the `speed` extra (NumPy) so mypy type-checks the NumPy fast
      # path against real stubs. Without it, `import numpy` resolves to `Any`
      # and the `# type: ignore` in scan_numpy.py reads as unused.
      run: |
        python -m pip install --upgrade pip
        pip install -e ".[dev,speed]"
    - name: Run mypy
      run: |
        mypy PyMemoryEditor

  build:
    needs: lint
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.10', '3.11', '3.12', '3.13']
        os:
          - ubuntu-latest
          - windows-latest
          - macos-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install Qt system libraries (Linux)
      # PySide6 links against libEGL/libGL/libxkbcommon/libfontconfig and the
      # XCB stack at import time, even when running under the `offscreen`
      # platform plugin. The Ubuntu runner ships without them, so pytest-qt's
      # `import QtGui` crashes with `libEGL.so.1: cannot open shared object`.
      if: runner.os == 'Linux'
      run: |
        sudo apt-get update
        sudo apt-get install -y --no-install-recommends \
          libegl1 \
          libgl1 \
          libxkbcommon0 \
          libfontconfig1 \
          libdbus-1-3 \
          libxcb-cursor0 \
          libxcb-icccm4 \
          libxcb-image0 \
          libxcb-keysyms1 \
          libxcb-randr0 \
          libxcb-render-util0 \
          libxcb-shape0 \
          libxcb-sync1 \
          libxcb-xfixes0 \
          libxcb-xinerama0 \
          libxcb-xkb1 \
          libxkbcommon-x11-0
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e ".[dev]"
    - name: Test with pytest
      env:
        QT_QPA_PLATFORM: offscreen
      run: |
        pytest tests -v -s -x --cov=PyMemoryEditor --cov-report=term

  # Isolated job for the optional NumPy-accelerated scan fast path (the
  # `[speed]` extra). The matrix above deliberately runs WITHOUT NumPy so the
  # pure-Python scan path stays covered; this single Linux job installs
  # `.[speed]` on top of the dev deps to exercise the vectorized path.
  build-speed:
    needs: lint
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'
    - name: Install Qt system libraries (Linux)
      # PySide6 links against libEGL/libGL/libxkbcommon/libfontconfig and the
      # XCB stack at import time, even when running under the `offscreen`
      # platform plugin. The Ubuntu runner ships without them, so pytest-qt's
      # `import QtGui` crashes with `libEGL.so.1: cannot open shared object`.
      run: |
        sudo apt-get update
        sudo apt-get install -y --no-install-recommends \
          libegl1 \
          libgl1 \
          libxkbcommon0 \
          libfontconfig1 \
          libdbus-1-3 \
          libxcb-cursor0 \
          libxcb-icccm4 \
          libxcb-image0 \
          libxcb-keysyms1 \
          libxcb-randr0 \
          libxcb-render-util0 \
          libxcb-shape0 \
          libxcb-sync1 \
          libxcb-xfixes0 \
          libxcb-xinerama0 \
          libxcb-xkb1 \
          libxkbcommon-x11-0
    - name: Install dependencies (with NumPy speed extra)
      run: |
        python -m pip install --upgrade pip
        pip install -e ".[dev,speed]"
    - name: Test with pytest (NumPy fast path)
      env:
        QT_QPA_PLATFORM: offscreen
      run: |
        pytest tests -v -s -x --cov=PyMemoryEditor --cov-report=term