gawain 0.1.0__tar.gz

gawain-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+  workflow_call:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  rust:
+    name: Rust tests (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: dtolnay/rust-toolchain@b725eda525362e7cf34af9a7243cac1e3f01a7ec # stable
+        with:
+          toolchain: stable
+          components: clippy, rustfmt
+      - uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - name: Install ty into .venv
+        run: |
+          uv venv --python 3.14 .venv
+          uv pip install --python .venv ty==0.0.100
+      - run: cargo fmt --check
+      - run: cargo clippy --all-targets -- -D warnings
+      - run: cargo test --no-fail-fast
+
+  python:
+    name: Differential tests and self-check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: dtolnay/rust-toolchain@b725eda525362e7cf34af9a7243cac1e3f01a7ec # stable
+        with:
+          toolchain: stable
+      - uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - run: cargo build
+      - name: Differential tests against must-annotate
+        run: uv run --no-project --python 3.14 --with pytest --with must-annotate==0.1.2 python -m pytest tests/python
+      - name: gawain checks its own Python code
+        run: |
+          uv venv --python 3.14 .venv
+          uv pip install --python .venv ty==0.0.100 pytest
+          PATH="$PWD/.venv/bin:$PATH" target/debug/gawain check scripts tests/python
+
+  windows:
+    name: Windows smoke test
+    runs-on: windows-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: dtolnay/rust-toolchain@b725eda525362e7cf34af9a7243cac1e3f01a7ec # stable
+        with:
+          toolchain: stable
+      - uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - run: cargo build --release
+      - name: Run gawain on a clean file and on a file with a missing annotation
+        run: |
+          uv venv --python 3.14 .venv
+          uv pip install --python .venv ty==0.0.100
+          export PATH="$PWD/.venv/Scripts:$PATH"
+          mkdir -p smoke/clean smoke/dirty
+          printf 'def add(a: int, b: int) -> int:\n    return a + b\n' > smoke/clean/ok.py
+          printf 'total = sum([1, 2])\n' > smoke/dirty/bad.py
+          target/release/gawain.exe check smoke/clean
+          status=0
+          target/release/gawain.exe check smoke/dirty || status=$?
+          test "$status" -eq 1

gawain-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,152 @@
+name: Release
+
+# A tag push (v0.1.0, ...) builds every wheel and the sdist, tests the wheels and publishes to PyPI.
+# A manual run builds and tests the same files without publishing them.
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  ci:
+    name: CI
+    uses: ./.github/workflows/ci.yml
+
+  version:
+    name: Tag matches the package version
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: Compare the tag with pyproject.toml and Cargo.toml
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          py=$(python3 -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')
+          rs=$(python3 -c 'import tomllib; print(tomllib.load(open("Cargo.toml", "rb"))["package"]["version"])')
+          echo "tag=$tag pyproject=$py Cargo=$rs"
+          test "$tag" = "$py" && test "$tag" = "$rs"
+
+  wheels:
+    name: Wheel ${{ matrix.name }}
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { name: linux-x86_64, runner: ubuntu-latest, target: x86_64, manylinux: auto }
+          - { name: linux-aarch64, runner: ubuntu-latest, target: aarch64, manylinux: auto }
+          - { name: musllinux-x86_64, runner: ubuntu-latest, target: x86_64, manylinux: musllinux_1_2 }
+          - { name: musllinux-aarch64, runner: ubuntu-latest, target: aarch64, manylinux: musllinux_1_2 }
+          - { name: macos-x86_64, runner: macos-15-intel, target: x86_64 }
+          - { name: macos-aarch64, runner: macos-latest, target: aarch64 }
+          - { name: windows-x64, runner: windows-latest, target: x64 }
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
+        with:
+          target: ${{ matrix.target }}
+          manylinux: ${{ matrix.manylinux }}
+          args: --release --locked --out dist
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: dist-${{ matrix.name }}
+          path: dist
+
+  sdist:
+    name: Source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
+        with:
+          command: sdist
+          args: --out dist
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: dist-sdist
+          path: dist
+
+  test-wheels:
+    name: Install and run (${{ matrix.os }})
+    needs: wheels
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm, macos-latest, macos-15-intel, windows-latest]
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          pattern: dist-*
+          merge-multiple: true
+          path: dist
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - name: Install the built wheel and run it on a clean file and on a file with a missing annotation
+        run: |
+          uv venv --python 3.14 .venv
+          uv pip install --python .venv ty==0.0.100
+          uv pip install --python .venv --no-index --find-links dist gawain
+          if [ -d .venv/Scripts ]; then bin=.venv/Scripts; else bin=.venv/bin; fi
+          export PATH="$PWD/$bin:$PATH"
+          mkdir -p smoke/clean smoke/dirty
+          printf 'def add(a: int, b: int) -> int:\n    return a + b\n' > smoke/clean/ok.py
+          printf 'total = sum([1, 2])\n' > smoke/dirty/bad.py
+          gawain check smoke/clean
+          status=0
+          gawain check smoke/dirty || status=$?
+          test "$status" -eq 1
+
+  test-musl:
+    name: Install and run (musl, ${{ matrix.runner }})
+    needs: wheels
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        runner: [ubuntu-latest, ubuntu-24.04-arm]
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          pattern: dist-musllinux-*
+          merge-multiple: true
+          path: dist
+      - name: Install the built wheel in Alpine and run it on a clean file and on a file with a missing annotation
+        run: |
+          docker run --rm -v "$PWD/dist:/dist:ro" python:3.14-alpine sh -euc '
+            python -m venv /venv
+            /venv/bin/pip install --quiet ty==0.0.100
+            /venv/bin/pip install --quiet --no-index --find-links /dist gawain
+            export PATH="/venv/bin:$PATH"
+            mkdir -p /smoke/clean /smoke/dirty
+            printf "def add(a: int, b: int) -> int:\n    return a + b\n" > /smoke/clean/ok.py
+            printf "total = sum([1, 2])\n" > /smoke/dirty/bad.py
+            gawain check /smoke/clean
+            status=0
+            gawain check /smoke/dirty || status=$?
+            test "$status" -eq 1
+          '
+
+  publish-pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'push'
+    needs: [ci, version, wheels, sdist, test-wheels, test-musl]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/gawain
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          pattern: dist-*
+          merge-multiple: true
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3

gawain-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+target/
+.metrics/
+.venv/
+*.whl
+__pycache__/
+.coverage
+uv.lock
+
+# Internal development notes
+docs/crap-exceptions.md
+docs/differential.md
+docs/glossary.md

gawain-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,6 @@
+- id: gawain
+  name: gawain
+  entry: gawain check
+  language: python
+  types: [python]
+  require_serial: true