feat: PortDiff for StaticSizeCircuit

.github/change-filters.yml

@@ -17,4 +17,4 @@ python:
   - "tket2-py/**"
   - "tket2-eccs/**"
   - "pyproject.toml"
-  - "poetry.lock"
+  - "uv.lock"

.github/dependabot.yml

@@ -25,7 +25,10 @@ updates:
       # Major updates still generate individual PRs
 
   - package-ecosystem: "pip"
-    directory: "/" # Location of package manifests
+    directories: # Location of package manifests
+      - "/"
+      - "/tket2-py"
+      - "/tket2-eccs"
     schedule:
       interval: "weekly"
     commit-message:

.github/script/install-uv.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# Installs a fixed UV version
+#
+# This reads the `UV_CACHE_DIR` environment variable if it is set,
+# and stores the downloaded dependencies in that directory.
+
+curl -LsSf https://astral.sh/uv/0.3.4/install.sh | sh

.github/workflows/ci.yml

@@ -19,6 +19,7 @@ env:
   CI: true # insta snapshots behave differently on ci
   SCCACHE_GHA_ENABLED: "true"
   RUSTC_WRAPPER: "sccache"
+  UV_CACHE_DIR: /tmp/.uv-cache
 
 jobs:
   # Check if changes were made to the relevant files.
@@ -82,23 +83,29 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: mozilla-actions/[email protected]
-      - name: Install poetry
-        run: pipx install poetry
-      - name: Set up Python
+      - name: Set up uv
+        run: .github/script/install-uv.sh
+      - name: "Set up Python"
         uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
-          cache: "poetry"
-      - name: Install the project libraries
-        # Note: We do not need to compile with maturin here,
-        # as we are only checking the Python code.
-        run: poetry install
+          python-version: '3.12'
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}
+      - name: Setup dependencies
+        run: uv sync --locked
       - name: Type check with mypy
-        run: poetry run mypy .
+        run: uv run mypy .
       - name: Check formatting with ruff
-        run: poetry run ruff format --check
+        run: uv run ruff format --check
       - name: Lint with ruff
-        run: poetry run ruff check
+        run: uv run ruff check
+      - name: Minimize uv cache
+        run: uv cache prune --ci
 
   benches:
     name: Build benchmarks 🏋️
@@ -226,23 +233,30 @@ jobs:
       - uses: mozilla-actions/[email protected]
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@stable
-      - name: Install poetry
-        run: pipx install poetry
-      - uses: actions/setup-python@v5
+      - name: Set up uv
+        run: .github/script/install-uv.sh
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
-          cache: 'poetry'
-      - name: Build pyo3 bindings
-        run: |
-          poetry install
-          poetry run maturin develop
+          python-version: '3.10'
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}
+      - name: Setup dependencies
+        run: uv sync --locked
       - name: Run python tests with coverage instrumentation
-        run: poetry run pytest --cov=./ --cov-report=xml
+        run: uv run pytest --cov=./ --cov-report=xml
       - name: Upload coverage output artifact
         uses: actions/upload-artifact@v4
         with:
           name: py-coverage
           path: coverage.xml
+      - name: Minimize uv cache
+        run: uv cache prune --ci
 
   coverage-py:
     name: Upload Python coverage 🐍

.github/workflows/python-pure-wheels.yml

@@ -25,7 +25,7 @@ jobs:
     strategy:
       matrix:
         target:
-          - { name: tket2-eccs, key_secret: PYPI_PUBLISH_TKET2_ECCS }
+          - { dir: tket2-eccs, name: tket2_eccs, key_secret: PYPI_PUBLISH_TKET2_ECCS }
     steps:
       # Check the release tag against the package name
       #
@@ -35,41 +35,56 @@ jobs:
         run: |
           echo "run=$SHOULD_RUN" >> $GITHUB_OUTPUT
         env:
-          SHOULD_RUN: ${{ github.event_name != 'release' || ( github.ref_type == 'tag' && startsWith(github.ref, format('refs/tags/{0}-v', matrix.target.name)) ) }}
+          SHOULD_RUN: ${{ github.event_name != 'release' || ( github.ref_type == 'tag' && startsWith(github.ref, format('refs/tags/{0}-v', matrix.target.dir)) ) }}
 
       - uses: actions/checkout@v4
         if: ${{ steps.check-tag.outputs.run == 'true' }}
       - name: Run sccache-cache
         if: ${{ steps.check-tag.outputs.run == 'true' }}
         uses: mozilla-actions/[email protected]
-      - name: Install poetry
+
+
+      - name: Set up uv
         if: ${{ steps.check-tag.outputs.run == 'true' }}
-        run: pipx install poetry
-      - name: Set up Python '3.10'
+        run: .github/script/install-uv.sh
+      - name: Set up Python
         if: ${{ steps.check-tag.outputs.run == 'true' }}
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
-          cache: "poetry"
+          python-version: '3.12'
 
       - name: Build sdist and wheels
         if: ${{ steps.check-tag.outputs.run == 'true' }}
         run: |
-          cd ${{ matrix.target.name }}
-          poetry build -o ../dist
+          cd ${{ matrix.target.dir }}
+          uvx --from build pyproject-build --installer uv --outdir ../dist
 
       - name: Upload the built packages as artifacts
         if: ${{ steps.check-tag.outputs.run == 'true' }}
         uses: actions/upload-artifact@v4
         with:
-          name: build-${{ matrix.target.name }}-sdist
+          name: build-${{ matrix.target.dir }}-sdist
           path: |
             dist/*.tar.gz
             dist/*.whl
 
+      - name: Test installing the built wheels
+        if: ${{ steps.check-tag.outputs.run == 'true' }}
+        run: |
+          echo "Testing the newly built ${{ matrix.target.name }} wheels..."
+          uv run -f dist --with ${{ matrix.target.name }} --refresh-package ${{ matrix.target.name }} --no-project -- python -c "import ${{ matrix.target.name }}"
+          uvx twine check --strict dist/*
+
       - name: Publish to PyPI
-        if: ${{ (github.event_name == 'release' && github.ref_type == 'tag' && startsWith(github.ref, format('refs/tags/{0}-v', matrix.target.name)) ) || (github.event_name == 'workflow_dispatch' && github.ref_type == 'tag' && startsWith(github.ref, format('refs/tags/{0}-v', matrix.target.name)) ) }}
+        if: ${{ (github.event_name == 'release' && github.ref_type == 'tag' && startsWith(github.ref, format('refs/tags/{0}-v', matrix.target.dir)) ) || (github.event_name == 'workflow_dispatch' && github.ref_type == 'tag' && startsWith(github.ref, format('refs/tags/{0}-v', matrix.target.dir)) ) }}
         run: |
-          cd ${{ matrix.target.name }}
-          poetry config pypi-token.pypi ${{ secrets[matrix.target.key_secret] }}
-          poetry publish --dist-dir ../dist --skip-existing
+          echo "Publishing to PyPI..."
+          echo "Based on the following workflow variables, this is a new version tag push:"
+          echo "  - event_name: ${{ github.event_name }}"
+          echo "  - ref_type: ${{ github.ref_type }}"
+          echo "  - ref: ${{ github.ref }}"
+          uvx twine upload --skip-existing --verbose dist/*
+        env:
+          TWINE_NON_INTERACTIVE: 1
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets[matrix.target.key_secret] }}

.github/workflows/python-wheels.yml

@@ -20,6 +20,9 @@ on:
 permissions:
   contents: read
 
+env:
+  MODULE_DIR: tket2-py
+
 jobs:
   # Check if the tag matches the package name,
   # or if the workflow is running on a non-release event.
@@ -64,9 +67,10 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
+          args: --release --out ../dist --find-interpreter
           sccache: 'true'
           manylinux: auto
+          working-directory: ${{ env.MODULE_DIR }}
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -97,9 +101,10 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
+          args: --release --out ../dist --find-interpreter
           sccache: 'true'
           manylinux: musllinux_1_2
+          working-directory: ${{ env.MODULE_DIR }}
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -127,8 +132,9 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
+          args: --release --out ../dist --find-interpreter
           sccache: 'true'
+          working-directory: ${{ env.MODULE_DIR }}
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -155,8 +161,9 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
+          args: --release --out ../dist --find-interpreter
           sccache: 'true'
+          working-directory: ${{ env.MODULE_DIR }}
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -173,7 +180,8 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           command: sdist
-          args: --out dist
+          args: --out ../dist
+          working-directory: ${{ env.MODULE_DIR }}
       - name: Upload sdist
         uses: actions/upload-artifact@v4
         with:

.pre-commit-config.yaml

@@ -34,74 +34,67 @@ repos:
 
   - repo: local
     hooks:
-      - id: poetry-install
-        name: sync poetry deps
-        description: Ensure development tools are installed.
-        entry: poetry install --sync
-        language: system
-        files: poetry.lock
-        pass_filenames: false
       - id: ruff-format
         name: ruff format
         description: Format python code with `ruff`.
-        entry: poetry run ruff format
+        entry: uv run ruff format
         language: system
         files: \.py$
         pass_filenames: false
       - id: ruff-check
         name: ruff
         description: Check python code with `ruff`.
-        entry: poetry run ruff check --fix --exit-non-zero-on-fix
+        entry: uv run ruff check --fix --exit-non-zero-on-fix
         language: system
         files: \.py$
         pass_filenames: false
       - id: mypy-check
         name: mypy
         description: Check python code with `mypy`.
-        entry: poetry run mypy .
+        entry: uv run mypy .
         language: system
         files: \.py$
         pass_filenames: false
       - id: cargo-fmt
         name: cargo format
         description: Format rust code with `cargo fmt`.
-        entry: poetry run -- cargo fmt --all -- --check
+        entry: uv run -- cargo fmt --all -- --check
         language: system
         files: \.rs$
         pass_filenames: false
       - id: cargo-check
         name: cargo check
         description: Check rust code with `cargo check`.
-        entry: poetry run -- cargo check --all --all-features --workspace
+        entry: uv run -- cargo check --all --all-features --workspace
         language: system
         files: \.rs$
         pass_filenames: false
       - id: cargo-test
         name: cargo test
         description: Run tests with `cargo test`.
-        entry: poetry run -- cargo test --all-features --workspace
+        entry: uv run -- cargo test --all-features
         language: system
         files: \.rs$
         pass_filenames: false
       - id: cargo-clippy
         name: cargo clippy
         description: Run clippy lints with `cargo clippy`.
-        entry: poetry run -- cargo clippy --all-features --all-targets --workspace -- -D warnings
+        entry: uv run -- cargo clippy --all-features --all-targets --workspace -- -D warnings
         language: system
         files: \.rs$
         pass_filenames: false
       - id: cargo-doc
         name: cargo doc
         description: Generate documentation with `cargo doc`.
-        entry: poetry run -- cargo doc --no-deps --all-features --workspace
+        entry: uv run -- cargo doc --no-deps --all-features --workspace
         language: system
         files: \.rs$
         pass_filenames: false
       - id: py-test
         name: pytest
         description: Run python tests
         # Ensure that we are using the local version of `tket2-eccs` and not the one from PyPI
-        entry: poetry run -- sh -c "poetry install -C tket2-eccs && maturin develop && pytest --cov=./ --cov-report=html"
+        entry: uv run -- sh -c "maturin develop && pytest --cov=./ --cov-report=html"
         language: system
         files: \.py$
         pass_filenames: false

.release-please-manifest.json

@@ -1,4 +1,4 @@
 {
-    "tket2-py": "0.2.1",
+    "tket2-py": "0.3.0",
     "tket2-eccs": "0.1.0"
 }