Rust extension module

.cargo/config.toml

@@ -0,0 +1,15 @@
+[build]
+rustflags = []
+
+# see https://pyo3.rs/v0.21.2/building-and-distribution.html?highlight=macos#manual-builds
+[target.x86_64-apple-darwin]
+rustflags = [
+ "-C", "link-arg=-undefined",
+ "-C", "link-arg=dynamic_lookup",
+]
+
+[target.aarch64-apple-darwin]
+rustflags = [
+ "-C", "link-arg=-undefined",
+ "-C", "link-arg=dynamic_lookup",
+]

.coveragerc

@@ -0,0 +1,11 @@
+[coverage:run]
+branch=True
+[coverage:report]
+fail_under=100
+exclude_lines=
+ pragma: no cover
+ raise NotImplementedError
+ def __repr__
+ @overload
+ ^\s+\.\.\.
+ if TYPE_CHECKING.*:

.flake8

@@ -0,0 +1,8 @@
+[flake8]
+exclude = .git,__pycache__,docs/source/conf.py,old,build,dist,.tox
+extend-ignore =
+ # let black handle line length
+ E501
+per-file-ignores =
+ __init__.py: F401,F403
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,6 +5,7 @@
 # Checklist
 
 - [ ] Build runs successfully
+- [ ] Type stubs updated
 - [ ] Docs updated
 
 # Release checklist (maintainers only)

.github/workflows/checks.yml

@@ -0,0 +1,139 @@
+name: Checks
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ workflow_dispatch:
+
+jobs:
+ test-python-versions:
+ name: Test Python ${{ matrix.python-version }}
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ python-version: [
+ "3.9",
+ "3.10",
+ "3.11",
+ "3.12",
+ "3.13-dev",
+ ]
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions-rust-lang/setup-rust-toolchain@v1
+ - uses: actions/setup-python@v5
+ with:
+ python-version: ${{ matrix.python-version }}
+
+ - name: "Test Rust"
+ if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.python-version == '3.12') }}
+ run: |
+ cargo test
+
+ - name: Install and test
+ shell: bash
+ run: |
+ pip install .
+ pip install -r requirements/test.txt
+ pytest tests/
+
+ Test-os:
+ name: Test on ${{ matrix.os }}
+ runs-on: ${{ matrix.os }}
+ strategy:
+ fail-fast: false
+ matrix:
+ os: [ubuntu-latest, windows-latest, macos-latest]
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions-rust-lang/setup-rust-toolchain@v1
+
+ - uses: actions/setup-python@v5
+ if: ${{ !(matrix.os == 'windows-latest') }}
+ with:
+ python-version: '3.12'
+
+ # ensure 32-bit target is tested
+ # FUTURE: Add a linux 32-bit target
+ - uses: actions/setup-python@v5
+ if: ${{ matrix.os == 'windows-latest' }}
+ with:
+ python-version: '3.12'
+ architecture: x86
+
+
+ - name: Install and test
+ shell: bash
+ run: |
+ pip install -e .
+ pip install -r requirements/test.txt
+ pytest tests/
+
+ test-pure-python:
+ name: Test pure Python version
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ python-version: [
+ "3.9",
+ "3.10",
+ "3.11",
+ "3.12",
+ "3.13-dev",
+ # # NOTE: pypy/pytest fails sometimes (https://github.com/pypy/pypy/issues/3959)
+ "pypy3.9",
+ "pypy3.10"
+ ]
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v5
+ with:
+ python-version: ${{ matrix.python-version }}
+ # only run coverage once
+ - if: ${{ matrix.python-version == '3.12' }}
+ run: |
+ pip install .
+ pip install -r requirements/test.txt
+ pytest tests/ --cov=whenever --cov-report=xml
+ env:
+ WHENEVER_NO_BUILD_RUST_EXT: "1"
+ - run: |
+ pip install .
+ pip install -r requirements/test.txt
+ pytest tests/
+ env:
+ WHENEVER_NO_BUILD_RUST_EXT: "1"
+
+ Linting:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v5
+ with:
+ python-version: '3.12'
+ - run: |
+ pip install .
+ pip install -U pip
+ pip install -r requirements/lint.txt
+ make ci-lint
+ env:
+ WHENEVER_NO_BUILD_RUST_EXT: "1"
+
+ Typecheck:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v5
+ with:
+ python-version: '3.12'
+ - run: |
+ pip install .
+ pip install -r requirements/typecheck.txt
+ pip install -r requirements/test.txt
+ make typecheck
+ env:
+ WHENEVER_NO_BUILD_RUST_EXT: "1"

.github/workflows/wheels.yml

@@ -0,0 +1,108 @@
+name: Build and publish wheels
+
+on:
+ push:
+ tags:
+ - '*'
+ workflow_dispatch:
+
+permissions:
+ contents: read
+
+jobs:
+ binary:
+ name: build on ${{ matrix.os }} (${{ matrix.target }}) (${{ matrix.manylinux || 'auto' }})
+ strategy:
+ fail-fast: false
+ matrix:
+ os: [windows, macos, linux]
+ target: [x86_64, aarch64]
+ include:
+ # additional linux targets
+ - os: linux
+ target: x86
+ - os: linux
+ target: armv7
+ - os: linux
+ target: ppc64le
+ - os: linux
+ target: s390x
+
+ # musl targets
+ - os: linux
+ target: x86_64
+ manylinux: musllinux_1_2
+ - os: linux
+ target: x86
+ manylinux: musllinux_1_2
+ - os: linux
+ target: aarch64
+ manylinux: musllinux_1_2
+ - os: linux
+ target: armv7
+ manylinux: musllinux_1_2
+
+ - os: windows
+ python-architecture: x86
+ target: x86
+
+ exclude:
+ - os: windows
+ target: aarch64
+
+ runs-on: ${{ (matrix.os == 'linux' && 'ubuntu') || matrix.os }}-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v5
+ with:
+ python-version: '3.12'
+ architecture: ${{ matrix.python-architecture || 'x64' }}
+ - run: |
+ pip install -U twine
+ sed -i ${{ (matrix.os == 'macos' && '""') || '' }} 's/build-backend = "setuptools.build_meta"/build-backend = "maturin"/' pyproject.toml
+ sed -i ${{ (matrix.os == 'macos' && '""') || '' }} 's/^requires = \["setuptools", .*]/requires = \["maturin>=1.0,<2.0"\]/' pyproject.toml
+ tail pyproject.toml
+ - name: build wheels
+ uses: PyO3/maturin-action@v1
+ with:
+ target: ${{ matrix.target }}
+ args: --release --out dist --interpreter '3.9 3.10 3.11 3.12'
+ manylinux: ${{ matrix.manylinux || 'auto' }}
+ sccache: 'true'
+ rust-toolchain: stable
+ - run: twine check --strict dist/*
+ - name: Upload wheels
+ uses: actions/upload-artifact@v4
+ with:
+ name: wheels-binary-${{ matrix.os }}-${{ matrix.target }}-${{ matrix.manylinux || 'auto' }}
+ path: dist/*
+
+ sdist:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Build sdist
+ run: |
+ pip install build twine
+ python -m build --sdist --outdir dist
+ - run: twine check --strict dist/*
+ - name: Upload sdist
+ uses: actions/upload-artifact@v4
+ with:
+ name: wheels-sdist
+ path: dist/*
+
+ release:
+ name: Release
+ runs-on: ubuntu-latest
+ if: "startsWith(github.ref, 'refs/tags/')"
+ needs: [binary, sdist]
+ steps:
+ - uses: actions/download-artifact@v4
+ - name: Publish to PyPI
+ run: |
+ pip install twine
+ twine upload --non-interactive --disable-progress-bar --skip-existing wheels-*/*
+ env:
+ TWINE_USERNAME: __token__
+ TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -72,3 +72,6 @@ docs/_build/
 .python-version
 
 .hypothesis
+.benchmarks
+
+benchmarks/comparison/result_*.json

.readthedocs.yml

@@ -9,10 +9,11 @@ build:
  os: ubuntu-22.04
  tools:
  python: "3.11"
- rust: "1.70"
+ # rust shouldn't be needed as we disable building the extension
+ # in the readthedocs configuration
 
 python:
  install:
- - requirements: docs/requirements.txt
+ - requirements: requirements/docs.txt
  - method: pip
  path: .