sharedbox 0.5.0__tar.gz → 0.7.0__tar.gz

{sharedbox-0.5.0 → sharedbox-0.7.0}/.github/dependabot.yml

@@ -4,6 +4,7 @@ updates:
     directory: /
     schedule:
       interval: weekly
+    labels: [dependencies, skip-changelog]
     commit-message:
       prefix: ci
     groups:
@@ -14,6 +15,7 @@ updates:
     directory: /
     schedule:
       interval: weekly
+    labels: [dependencies, skip-changelog]
     commit-message:
       prefix: build
       include: scope

sharedbox-0.7.0/.github/pull_request_template.md

@@ -0,0 +1,3 @@
+<!-- One bullet per change a reviewer can see, in the imperative. -->
+
+- [ ] Added a file to `changelog.d/` for each change a user notices, or this pull request changes nothing a user notices and needs the `skip-changelog` label

sharedbox-0.7.0/.github/workflows/check-changelog.yaml

@@ -0,0 +1,47 @@
+name: Changelog
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, labeled, unlabeled]
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  entry:
+    name: Require a changelog entry
+    runs-on: ubuntu-latest
+    steps:
+      - name: Read the labels
+        id: labels
+        env:
+          GH_TOKEN: ${{ github.token }}
+          PR: ${{ github.event.pull_request.number }}
+          REPO: ${{ github.repository }}
+        run: |
+          # read now rather than from the event: a pull request opened with a
+          # label gets it a moment after its "opened" event fires
+          skip=$(gh pr view "$PR" --repo "$REPO" --json labels --jq 'any(.labels[]; .name == "skip-changelog")')
+          echo "skip=$skip" >> "$GITHUB_OUTPUT"
+          if [ "$skip" = "true" ]; then
+            echo "Labelled skip-changelog: no entry needed."
+          fi
+
+      - uses: actions/checkout@v7
+        if: steps.labels.outputs.skip != 'true'
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        if: steps.labels.outputs.skip != 'true'
+        uses: astral-sh/setup-uv@v7
+
+      - name: Check for an entry in changelog.d
+        if: steps.labels.outputs.skip != 'true'
+        run: |
+          uvx towncrier==26.9.0 check --compare-with "origin/${{ github.base_ref }}" || {
+            echo "Add a file to changelog.d/ for each change, or ask for the skip-changelog label:"
+            echo "https://jacopoabramo.github.io/sharedbox/how-to/commits-and-prs/#changelog-entries"
+            exit 1
+          }

{sharedbox-0.5.0 → sharedbox-0.7.0}/.github/workflows/ci.yaml

@@ -19,7 +19,7 @@ jobs:
       # local hooks in prek.toml call `uv run --locked --only-group lint ...`
       - uses: astral-sh/setup-uv@v7
 
-      - uses: j178/prek-action@4e14d07f9231acabce116ccfca13b13dd9755ece # v3.0.0
+      - uses: j178/prek-action@44924fe9ef4a6f88253c4b6b1bf11c689d3ce53d # v3.1.0
         with:
           prek-version: "0.5.3"
 
@@ -88,7 +88,7 @@ jobs:
       - name: Create a box larger than a 16 MiB /dev/shm
         if: runner.os == 'Linux' && matrix.build == 'Release'
         run: |
-          docker run --rm --shm-size=16m -v "$PWD":/src -w /src ubuntu:24.04 build-cpp/test_small_shm
+          sudo unshare --mount sh -c 'mount -t tmpfs -o size=16m tmpfs /dev/shm && build-cpp/test_small_shm'
 
   build_wheels:
     name: Build wheel for ${{ matrix.python }}-${{ matrix.platform_id }}
@@ -114,11 +114,11 @@ jobs:
           ref: ${{ github.event_name == 'release' && github.event.release.tag_name || '' }}
 
       - name: Build wheels
-        uses: pypa/cibuildwheel@v4.2.1
+        uses: pypa/cibuildwheel@v4.3.4
         env:
           CIBW_BUILD: ${{ matrix.python }}-${{ matrix.platform_id }}
           CIBW_CONTAINER_ENGINE: "docker; create_args: --shm-size=1g"
-          CIBW_TEST_REQUIRES: pytest hypothesis numpy
+          CIBW_TEST_REQUIRES: pytest hypothesis numpy attrs
           CIBW_TEST_COMMAND: pytest {project}/tests
         with:
           package-dir: .
@@ -212,11 +212,11 @@ jobs:
         shell: bash
         run: |
           uv venv --python 3.12 .stress
-          uv pip install --python .stress wheelhouse/*.whl pytest hypothesis
+          uv pip install --python .stress wheelhouse/*.whl pytest hypothesis numpy attrs
           python=.stress/bin/python
           [ -x "$python" ] || python=.stress/Scripts/python.exe
           "$python" -m pytest -m stress -q -p no:cacheprovider
-          "$python" -m pytest tests/test_properties_codec.py tests/test_properties_layout.py tests/test_properties_forged.py tests/test_properties_stateful.py -q -p no:cacheprovider --hypothesis-profile=thorough
+          "$python" -m pytest tests/test_properties_*.py -q -p no:cacheprovider --hypothesis-profile=thorough
 
       - uses: actions/upload-artifact@v7
         if: always()
@@ -246,7 +246,15 @@ jobs:
       - uses: actions/checkout@v7
         with:
           fetch-depth: 0
-          ref: ${{ github.event_name == 'release' && github.event.release.tag_name || '' }}
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Check the changelog has a section for a final release
+        env:
+          TAG: ${{ github.event.release.tag_name }}
+        run: |
+          if [[ "$TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            python3 scripts/release_notes.py extract "${TAG#v}" > /dev/null
+          fi
 
       - name: Build SDist
         run: pipx run build --sdist
@@ -280,3 +288,25 @@ jobs:
           merge-multiple: true
 
       - uses: pypa/gh-action-pypi-publish@release/v1
+
+  # final releases only: a release candidate's entries stay in changelog.d
+  # for the final release's section
+  github_release:
+    name: Write the GitHub release notes
+    needs: [upload_pypi]
+    if: github.event_name == 'release' && !github.event.release.prerelease
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Write the release's notes from its changelog section
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.event.release.tag_name }}
+        run: |
+          python3 scripts/release_notes.py extract "${TAG#v}" > notes.md
+          gh release edit "$TAG" --title "$TAG" --notes-file notes.md

sharedbox-0.7.0/.github/workflows/ops.yaml

@@ -0,0 +1,108 @@
+name: Ops
+
+on:
+  pull_request:
+    branches: [ main ]
+    paths:
+      - include/sharedbox/**
+      - src/sharedbox/_native/**
+      - src/sharedbox/benchmarks/ops.py
+      - .github/workflows/ops.yaml
+      - CMakeLists.txt
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  ops:
+    name: Reads and writes against the base branch on Windows
+    runs-on: windows-latest
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          path: head
+          fetch-depth: 0
+
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ github.base_ref || 'main' }}
+          path: base
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v7
+
+      - name: Install both
+        shell: bash
+        run: |
+          for side in base head; do
+            (cd "$side" && uv sync --frozen --python 3.11)
+          done
+
+      - name: Run benchbox ops, alternating base and head
+        shell: bash
+        env:
+          # The 64k set and dict rows nearly double the job, so a pull request skips them.
+          SIZES: ${{ github.event_name == 'pull_request' && '[!6]*' || '*' }}
+        run: |
+          mkdir results
+          step=0
+          total=18 # 3 rounds x 2 sides x (int, record), plus list, set and dict once per side
+          for round in 1 2 3; do
+            for side in base head; do
+              for rows in int record list set dict; do
+                case "$rows" in list|set|dict) [ "$round" != 1 ] && continue ;; esac # not gated, one round is enough
+                step=$((step + 1))
+                echo "::group::[$step/$total] round $round, $side, $rows rows"
+                case "$rows" in
+                  list) pattern="*list*/*" ;;
+                  set) pattern="*set$SIZES/*" ;;
+                  dict) pattern="*dict$SIZES/*" ;;
+                  *) pattern="*$rows/SharedBox" ;;
+                esac
+                (cd "$side" && uv run --no-sync benchbox ops --fast \
+                  --filter "$pattern" --json "../results/$side-$round-$rows.json")
+                echo "::endgroup::"
+              done
+            done
+          done
+
+      - name: Compare the medians
+        shell: bash
+        run: |
+          cd head
+          uv run --no-sync python - ../results <<'EOF' | tee -a "$GITHUB_STEP_SUMMARY"
+          import statistics
+          import sys
+          from pathlib import Path
+
+          import pyperf
+          from sharedbox.benchmarks._app import machine
+
+          means: dict[tuple[str, str], list[float]] = {}
+          for path in sorted(Path(sys.argv[1]).glob("*.json")):
+              side = path.name.split("-")[0]
+              for bench in pyperf.BenchmarkSuite.load(str(path)).get_benchmarks():
+                  means.setdefault((bench.get_name(), side), []).append(bench.mean())
+          print("### benchbox ops on Windows cp311, median of three rounds, list, set and dict rows one round")
+          print()
+          print("A pull request skips the 64k set and dict rows; start the workflow by hand for them.")
+          print()
+          print(machine())
+          print()
+          print("| benchmark | base | head | head / base |")
+          print("| --- | --- | --- | --- |")
+          for name in sorted({name for name, _ in means}):
+              base = statistics.median(means.get((name, "base"), [0.0]))
+              head = statistics.median(means.get((name, "head"), [0.0]))
+              # A row added or removed by the pull request has times on one side only.
+              cells = [f"{v * 1e9:.1f} ns" if v else "-" for v in (base, head)]
+              ratio = f"{head / base:.3f}" if base and head else "-"
+              print(f"| {name} | {cells[0]} | {cells[1]} | {ratio} |")
+          EOF
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: ops
+          path: results

sharedbox-0.7.0/.github/workflows/prepare-release.yaml

@@ -0,0 +1,78 @@
+name: Prepare release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to release, such as 0.6.0, without the v"
+        required: true
+        type: string
+      dry_run:
+        description: "Only show the changelog section, in the run's summary"
+        required: false
+        type: boolean
+        default: false
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  prepare:
+    name: Write the changelog section and open the release pull request
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check the version
+        env:
+          VERSION: ${{ inputs.version }}
+        run: |
+          if [[ ! "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "The version must look like 0.6.0, without the v; got '$VERSION'."
+            echo "Tag a release candidate instead of preparing it."
+            exit 1
+          fi
+
+      - uses: actions/checkout@v7
+        with:
+          ref: main
+
+      - name: Check there is something to release
+        env:
+          VERSION: ${{ inputs.version }}
+        run: |
+          # towncrier refuses a version only when the whole heading matches,
+          # date included, so on a later day it would write a second section
+          if python3 scripts/release_notes.py extract "$VERSION" > /dev/null 2>&1; then
+            echo "The changelog already has a section for $VERSION."
+            exit 1
+          fi
+          if [ -z "$(find changelog.d -type f ! -name .gitkeep)" ]; then
+            echo "changelog.d holds no entries, so there is nothing to release."
+            exit 1
+          fi
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Write the section
+        env:
+          VERSION: ${{ inputs.version }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          uvx towncrier==26.9.0 build --yes --version "$VERSION" --date "$(date -u +%d-%m-%Y)"
+          python3 scripts/release_notes.py extract "$VERSION" > notes.md
+          cat notes.md >> "$GITHUB_STEP_SUMMARY"
+
+      - name: Open the release pull request
+        if: ${{ !inputs.dry_run }}
+        env:
+          VERSION: ${{ inputs.version }}
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          branch="release/v$VERSION"
+          git switch -c "$branch"
+          git commit -m "docs: write the $VERSION changelog"
+          git push origin "$branch"
+          gh pr create --base main --head "$branch" --label skip-changelog \
+            --title "docs: write the $VERSION changelog" --body-file notes.md

sharedbox-0.7.0/.github/workflows/streams.yaml

@@ -0,0 +1,85 @@
+name: Streams
+
+on:
+  pull_request:
+    branches: [ main ]
+    paths:
+      - include/sharedbox/stream.hpp
+      - include/sharedbox/core.hpp
+      - src/sharedbox/_stream.py
+      - src/sharedbox/_native/stream.cpp
+      - src/sharedbox/_native/types.cpp
+      - src/sharedbox/_native/codec.cpp
+      - src/sharedbox/benchmarks/stream.py
+      - scripts/stream_compare.py
+      - .github/workflows/streams.yaml
+  workflow_dispatch:
+    inputs:
+      base:
+        description: Commit, branch or tag to compare against
+        required: false
+        default: main
+
+permissions:
+  contents: read
+
+jobs:
+  streams:
+    name: Streams against the base on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, windows-latest ]
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          path: head
+          fetch-depth: 0
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ inputs.base || github.base_ref || 'main' }}
+          path: base
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v7
+      - name: Install both
+        shell: bash
+        run: |
+          for side in base head; do
+            (cd "$side" && uv sync --frozen --python 3.12)
+          done
+      - name: Check the base has SharedStream
+        id: base
+        shell: bash
+        run: |
+          if (cd base && uv run --no-sync python -c "import sharedbox; sharedbox.SharedStream"); then
+            echo "sides=base head" >> "$GITHUB_OUTPUT"
+          else
+            echo "sides=head" >> "$GITHUB_OUTPUT"
+            echo "base has no SharedStream; head only" | tee -a "$GITHUB_STEP_SUMMARY"
+          fi
+      - name: Run the stream benchmarks, alternating
+        shell: bash
+        run: |
+          mkdir results
+          for round in 1 2 3; do
+            if [ "${{ steps.base.outputs.sides }}" != "head" ]; then
+              (cd base && uv run --no-sync python ../head/src/sharedbox/benchmarks/stream.py \
+                --short --table both --json "../results/base-$round.json") \
+                || echo "::warning::base round $round failed"
+            fi
+            (cd head && uv run --no-sync python ../head/src/sharedbox/benchmarks/stream.py \
+              --short --table both --json "../results/head-$round.json")
+          done
+      - name: Compare
+        if: ${{ !cancelled() }}
+        shell: bash
+        run: |
+          cd head
+          uv run --no-sync python ../head/scripts/stream_compare.py ../results | tee -a "$GITHUB_STEP_SUMMARY"
+      - uses: actions/upload-artifact@v7
+        if: ${{ !cancelled() }}
+        with:
+          name: streams-${{ matrix.os }}
+          path: results

{sharedbox-0.5.0 → sharedbox-0.7.0}/.gitignore

@@ -20,9 +20,10 @@ wheelhouse/
 
 graphify-out/
 
-build-cpp/
+build-cpp*/
 
 .hypothesis/
+.claude/settings.json
 .claude/settings.local.json
 
 site/