plum 2.8.0__tar.gz

plum-2.8.0/.gitattributes

@@ -0,0 +1,2 @@
+* text=auto eol=lf
+*.lock -diff merge=ours linguist-generated=true

plum-2.8.0/.github/workflows/build_book.yml

@@ -0,0 +1,38 @@
+name: Build Jupyter Book
+
+on:
+  # Trigger the workflow on push to main branch.
+  push:
+    branches:
+      - master
+
+# This job installs dependencies, build the book, and pushes it to `gh-pages`.
+jobs:
+  build-and-deploy-book:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10"]
+    steps:
+      - uses: actions/checkout@v2
+
+      # Install dependencies.
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6.8.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          uv sync --group dev --locked
+
+      # Build the book.
+      - name: Build
+        run: uv run --frozen jupyter-book build docs
+
+      # Deploy the book's HTML to gh-pages branch.
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3.6.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html

plum-2.8.0/.github/workflows/ci.yml

@@ -0,0 +1,102 @@
+name: CI
+
+on:
+  workflow_dispatch:
+
+  pull_request:
+
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        value:
+          - name: "3.10"
+            python-version: "3.10"
+            extra-install: ""
+          - name: "3.11"
+            python-version: "3.11"
+            extra-install: ""
+          - name: "3.12"
+            python-version: "3.12"
+            extra-install: ""
+          - name: "3.12-pre-beartype"
+            python-version: "3.12"
+            extra-install: "uv pip install --upgrade --pre beartype"
+          - name: "3.13"
+            python-version: "3.13"
+            extra-install: ""
+          - name: "3.13-pre-beartype"
+            python-version: "3.13"
+            extra-install: "uv pip install --upgrade --pre beartype"
+
+    name: Test ${{ matrix.value.name }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.value.python-version }}
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6.8.0
+        with:
+          python-version: ${{ matrix.value.python-version }}
+      - name: Install dependencies
+        run: |
+          uv sync --group dev --locked
+          ${{ matrix.value.extra-install }}
+      - name: Test linter assertions
+        run: uv run --frozen nox -s typecheck
+      - name: Run tests
+        run: |
+          PRAGMA_VERSION=`uv run python -c "import sys; print('.'.join(map(str, sys.version_info[:2])))"` \
+          uv run --frozen pytest -v --cov=src/plum --cov-report term-missing --cov-report lcov:coverage.lcov
+      - name: Coveralls parallel
+        uses: coverallsapp/github-action@v2
+        with:
+          flag-name: run-${{ matrix.value.name }}
+          parallel: true
+          file: coverage.lcov
+
+  # Test that `mypyc`-compiled wheels work.
+  test-mypyc:
+    name: Test mypyc wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867 # v7.1.6
+        with:
+          python-version: "3.12"
+
+      - name: Install build & test dependencies
+        run: uv sync --locked --no-install-project --no-default-groups --group build --group wheels --group test_static --group test_runtime
+
+      - name: Build mypyc wheel
+        run: uv run --no-sync python -m build --wheel
+        env:
+          HATCH_BUILD_HOOKS_ENABLE: "1"
+
+      - name: Install wheel
+        run: uv pip install dist/*.whl
+
+      - name: Verify compiled
+        run: uv run --no-sync python -c "from plum import COMPILED; print(f'COMPILED={COMPILED}'); assert COMPILED"
+
+      - name: Run tests
+        run: uv run --no-sync pytest tests/ -v -k "not incompatible_with_mypyc" --ignore=tests/advanced
+
+  finish:
+    name: Finish coverage
+    needs: test
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls finished
+        uses: coverallsapp/github-action@v2
+        with:
+          parallel-finished: true

plum-2.8.0/.github/workflows/codeql.yml

@@ -0,0 +1,67 @@
+name: CodeQL Advanced
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: '42 1 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible
+    # analysis time improvements.
+    runs-on: ubuntu-latest
+    permissions:
+      # Required for all workflows:
+      security-events: write
+
+      # Required to fetch internal or private CodeQL packs:
+      packages: read
+
+      # Only required for workflows in private repositories:
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: actions
+          build-mode: none
+        - language: python
+          build-mode: none
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v4
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+
+    # See https://docs.github.com/en/enterprise-server@3.16/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages#using-multiple-build-modes-in-a-multi-language-repository
+    - name: Run manual build steps
+
+      if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the ' \
+          'languages you are analyzing, replace this with the commands to build ' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v4
+      with:
+        category: "/language:${{matrix.language}}"

plum-2.8.0/.github/workflows/formatting_check.yml

@@ -0,0 +1,17 @@
+name: Check Formatting
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+
+    - uses: pre-commit/action@v3.0.0

plum-2.8.0/.github/workflows/publish.yml

@@ -0,0 +1,125 @@
+name: Build and Publish
+
+on:
+    release:
+        types: [published]
+    workflow_dispatch:
+        inputs:
+            publish:
+                description: "Publish to PyPI (only for releases)"
+                required: false
+                default: false
+                type: boolean
+
+# Cancel any in-progress build when a new commit is pushed.
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    # Build the `sdist` and pure Python wheel.
+    sdist-and-wheel:
+        name: Build sdist and pure wheel
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0 # Needed for hatch-vcs versioning
+
+            - name: Set up uv
+              uses: astral-sh/setup-uv@v5
+              with:
+                  python-version: "3.12"
+
+            - name: Build sdist and wheel
+              run: uv build
+
+            - name: Upload sdist
+              uses: actions/upload-artifact@v4
+              with:
+                  name: sdist
+                  path: dist/*.tar.gz
+
+            - name: Upload wheel
+              uses: actions/upload-artifact@v4
+              with:
+                  name: wheel-pure
+                  path: dist/*.whl
+
+    # Generate the wheel build matrix dynamically.
+    generate-wheels-matrix:
+        name: Generate wheels matrix
+        runs-on: ubuntu-latest
+        outputs:
+            include: ${{ steps.set-matrix.outputs.include }}
+        steps:
+            - uses: actions/checkout@v4
+            - name: Set up uv
+              uses: astral-sh/setup-uv@v5
+            - name: Install cibuildwheel and generate matrix
+              run: |
+                  uvx cibuildwheel==3.4.0 --print-build-identifiers --platform linux \
+                  | jq -nRc '{"only": inputs, "os": "ubuntu-latest"}' > /tmp/linux_builds.json
+                  uvx cibuildwheel==3.4.0 --print-build-identifiers --platform macos \
+                  | jq -nRc '{"only": inputs, "os": "macos-14"}' > /tmp/macos_builds.json
+                  uvx cibuildwheel==3.4.0 --print-build-identifiers --platform windows \
+                  | jq -nRc '{"only": inputs, "os": "windows-latest"}' > /tmp/windows_builds.json
+            - name: Merge matrices
+              id: set-matrix
+              run: |
+                MATRIX=$(jq -sc '.' /tmp/*_builds.json | jq -c '.')
+                echo "include=$MATRIX" >> "$GITHUB_OUTPUT"
+
+    # Build `mypyc`-compiled wheels using `cibuildwheel`.
+    mypyc-wheels:
+        name: Build ${{ matrix.only }}
+        needs: generate-wheels-matrix
+        runs-on: ${{ matrix.os }}
+        strategy:
+            fail-fast: false
+            matrix:
+                include: ${{ fromJson(needs.generate-wheels-matrix.outputs.include) }}
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Build wheels
+              uses: pypa/cibuildwheel@v3.4.0
+              with:
+                  only: ${{ matrix.only }}
+              env:
+                  CIBW_BUILD_VERBOSITY: 1
+
+            - name: Upload wheels
+              uses: actions/upload-artifact@v4
+              with:
+                  name: wheel-${{ matrix.only }}
+                  path: wheelhouse/*.whl
+
+    # Publish to PyPI using trusted publishing.
+    publish:
+        name: Publish to PyPI
+        needs: [sdist-and-wheel, mypyc-wheels]
+        runs-on: ubuntu-latest
+        # Only publish on release events or manual trigger with `publish=true`.
+        if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && inputs.publish)
+        environment:
+            name: pypi
+            url: https://pypi.org/p/plum-dispatch
+        permissions:
+            id-token: write # Required for trusted publishing
+        steps:
+            - name: Download all artifacts
+              uses: actions/download-artifact@v4
+              with:
+                  path: dist
+                  merge-multiple: true
+
+            - name: List artifacts
+              run: ls -la dist/
+
+            - name: Publish to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1
+              with:
+                  packages-dir: dist/

plum-2.8.0/.github/workflows/publish_new_pypi_name.yml

@@ -0,0 +1,197 @@
+name: Build and Publish to New PyPI Name
+
+on:
+    release:
+        types: [published]
+    workflow_dispatch:
+        inputs:
+            publish:
+                description: "Publish to PyPI (only for releases)"
+                required: false
+                default: false
+                type: boolean
+
+permissions:
+    contents: read
+
+# Cancel any in-progress build when a new commit is pushed.
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    # Build the `sdist` and pure Python wheel.
+    sdist-and-wheel:
+        name: Build sdist and pure wheel
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0 # Needed for hatch-vcs versioning
+
+            - name: Adjust metadata
+              shell: bash
+              run: |
+                  python - <<'PYTHON'
+                  from pathlib import Path
+
+                  for path in [
+                    Path("pyproject.toml"),
+                    Path("uv.lock"),
+                  ]:
+                      text = path.read_text(encoding="utf-8")
+                      text = text.replace("plum-dispatch", "plum")
+                      path.write_text(text, encoding="utf-8")
+                  PYTHON
+
+            - name: Store release version
+              shell: bash
+              run: echo "RELEASE_VERSION=${GITHUB_REF_NAME#v}" >> "$GITHUB_ENV"
+
+            - name: Set up uv
+              uses: astral-sh/setup-uv@v5
+              with:
+                  python-version: "3.12"
+
+            - name: Build sdist and wheel
+              run: uv build
+              env:
+                  SETUPTOOLS_SCM_PRETEND_VERSION: ${{ env.RELEASE_VERSION }}
+
+            - name: Upload sdist
+              uses: actions/upload-artifact@v4
+              with:
+                  name: sdist
+                  path: dist/*.tar.gz
+
+
+            - name: Upload wheel
+              uses: actions/upload-artifact@v4
+              with:
+                  name: wheel-pure
+                  path: dist/*.whl
+
+    # Generate the wheel build matrix dynamically.
+    generate-wheels-matrix:
+        name: Generate wheels matrix
+        runs-on: ubuntu-latest
+        outputs:
+            include: ${{ steps.set-matrix.outputs.include }}
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Adjust metadata
+              shell: bash
+              run: |
+                  python - <<'PYTHON'
+                  from pathlib import Path
+
+                  for path in [
+                    Path("pyproject.toml"),
+                    Path("uv.lock"),
+                  ]:
+                      text = path.read_text(encoding="utf-8")
+                      text =text.replace("plum-dispatch", "plum")
+                      path.write_text(text, encoding="utf-8")
+                  PYTHON
+
+            - name: Store release version
+              shell: bash
+              run: echo "RELEASE_VERSION=${GITHUB_REF_NAME#v}" >> "$GITHUB_ENV"
+
+            - name: Set up uv
+              uses: astral-sh/setup-uv@v5
+
+            - name: Install cibuildwheel and generate matrix
+              run: |
+                  uvx cibuildwheel==3.4.0 --print-build-identifiers --platform linux \
+                  | jq -nRc '{"only": inputs, "os": "ubuntu-latest"}' > /tmp/linux_builds.json
+                  uvx cibuildwheel==3.4.0 --print-build-identifiers --platform macos \
+                  | jq -nRc '{"only": inputs, "os": "macos-14"}' > /tmp/macos_builds.json
+                  uvx cibuildwheel==3.4.0 --print-build-identifiers --platform windows \
+                  | jq -nRc '{"only": inputs, "os": "windows-latest"}' > /tmp/windows_builds.json
+              env:
+                  CIBW_BUILD_VERBOSITY: 1
+                  SETUPTOOLS_SCM_PRETEND_VERSION: ${{ env.RELEASE_VERSION }}
+                  CIBW_ENVIRONMENT_PASS_LINUX: SETUPTOOLS_SCM_PRETEND_VERSION
+
+            - name: Merge matrices
+              id: set-matrix
+              run: |
+                MATRIX=$(jq -sc '.' /tmp/*_builds.json | jq -c '.')
+                echo "include=$MATRIX" >> "$GITHUB_OUTPUT"
+
+    # Build `mypyc`-compiled wheels using `cibuildwheel`.
+    mypyc-wheels:
+        name: Build ${{ matrix.only }}
+        needs: generate-wheels-matrix
+        runs-on: ${{ matrix.os }}
+        strategy:
+            fail-fast: false
+            matrix:
+                include: ${{ fromJson(needs.generate-wheels-matrix.outputs.include) }}
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Adjust metadata
+              shell: bash
+              run: |
+                  python - <<'PYTHON'
+                  from pathlib import Path
+
+                  for path in [
+                    Path("pyproject.toml"),
+                    Path("uv.lock"),
+                  ]:
+                      text = path.read_text(encoding="utf-8")
+                      text = text.replace("plum-dispatch", "plum")
+                      path.write_text(text, encoding="utf-8")
+                  PYTHON
+
+            - name: Store release version
+              shell: bash
+              run: echo "RELEASE_VERSION=${GITHUB_REF_NAME#v}" >> "$GITHUB_ENV"
+
+            - name: Build wheels
+              uses: pypa/cibuildwheel@v3.4.0
+              with:
+                  only: ${{ matrix.only }}
+              env:
+                  CIBW_BUILD_VERBOSITY: 1
+                  SETUPTOOLS_SCM_PRETEND_VERSION: ${{ env.RELEASE_VERSION }}
+                  CIBW_ENVIRONMENT_PASS_LINUX: SETUPTOOLS_SCM_PRETEND_VERSION
+
+            - name: Upload wheels
+              uses: actions/upload-artifact@v4
+              with:
+                  name: wheel-${{ matrix.only }}
+                  path: wheelhouse/*.whl
+
+    # Publish to PyPI using trusted publishing.
+    publish:
+        name: Publish to PyPI
+        needs: [sdist-and-wheel, mypyc-wheels]
+        runs-on: ubuntu-latest
+        # Only publish on release events or manual trigger with `publish=true`.
+        if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && inputs.publish)
+        environment:
+            name: pypi
+            url: https://pypi.org/p/plum
+        permissions:
+            id-token: write # Required for trusted publishing
+        steps:
+            - name: Download all artifacts
+              uses: actions/download-artifact@v4
+              with:
+                  path: dist
+                  merge-multiple: true
+
+            - name: List artifacts
+              run: ls -la dist/
+
+            - name: Publish to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1
+              with:
+                  packages-dir: dist/

plum-2.8.0/.gitignore

@@ -0,0 +1,32 @@
+# Autogenerated files
+src/plum/_version.py
+
+# Byte-compiled file
+*.pyc
+
+# Virtual environments
+venv
+.tox
+
+# Packaging
+*.egg-info
+dist
+pip-wheel-metadata
+
+# Documentation and coverage
+docs/_build
+docs/_static
+docs/source
+docs/readme.rst
+cover
+
+# Other
+.DS_Store
+*.swp
+.envrc
+
+# Cython build files
+*.html
+*.c
+*.so
+*.o

plum-2.8.0/.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+ci:
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autofix_commit_msg: "style: pre-commit fixes"
+
+default_language_version:
+  python: "3.10"
+
+repos:
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.23
+    hooks:
+      - id: validate-pyproject
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.6.0"
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.7.3"
+    hooks:
+      # Run the linter
+      - id: ruff
+        types_or: [python, pyi]
+        args: ["--fix", "--show-fixes"]
+      # Run the formatter
+      - id: ruff-format
+        types_or: [python, pyi]

plum-2.8.0/.readthedocs.yaml

@@ -0,0 +1,21 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    nodejs: "20"
+  jobs:
+    install:
+        # Since the install step is overridden, pip is no longer updated automatically.
+        - pip install --upgrade pip
+        - pip install --group 'docs' .
+
+    pre_build:
+      # Generate the Sphinx configuration for this Jupyter Book, so it builds.
+      - "jupyter-book config sphinx docs/"
+
+sphinx:
+  builder: html
+  fail_on_warning: true
+  configuration: docs/conf.py

plum-2.8.0/LICENCE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Wessel Bruinsma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.