feat: pykore Python bindings (v0.1.0-dev)

- PyO3 object wrappers: Grid, Config, State, Kernel, Diagnostics
- NumPy complex128 interop with in-place mutation semantics
- GIL release on compute path
- maturin build system, pyproject.toml
- 12 Python tests passing
- cargo clippy --all-features -D warnings clean

Author: edengilbertus

.github/workflows/ci.yml

@@ -8,9 +8,16 @@ jobs:
     steps:
       - uses: actions/checkout@v5
       - uses: dtolnay/rust-toolchain@stable
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - run: python -m venv .venv
+      - run: . .venv/bin/activate && python -m pip install maturin pytest numpy
       - run: cargo clippy -- -D warnings
       - run: cargo test
       - run: cargo check
+      - run: . .venv/bin/activate && maturin develop
+      - run: . .venv/bin/activate && pytest tests/python -q
       - name: Header drift check
         run: |
           cargo install cbindgen --locked

.gitignore

@@ -3,3 +3,10 @@ target/
 .DS_Store
 Cargo.lock
 docs/
+.venv/
+python/pykore/_kore*.so
+python/pykore/_kore*.pyd
+python/pykore/_kore*.dylib
+python/pykore/*.dylib.dSYM/
+tests/python/__pycache__/
+tests/python/.pytest_cache/

Cargo.toml

@@ -8,10 +8,15 @@ repository = "https://github.com/edengilbertus/kore"
 
 [lib]
 name = "kore"
-crate-type = ["rlib", "staticlib"]
+crate-type = ["rlib", "staticlib", "cdylib"]
+
+[features]
+python = ["dep:pyo3", "dep:numpy"]
 
 [dependencies]
 num-complex = "0.4"
+numpy = { version = "0.22", optional = true }
+pyo3 = { version = "0.22", optional = true, features = ["extension-module"] }
 rayon = "1"
 rustfft = "6"
 

pyproject.toml

@@ -0,0 +1,15 @@
+[build-system]
+requires = ["maturin>=1,<2"]
+build-backend = "maturin"
+
+[project]
+name = "pykore"
+dynamic = ["version"]
+
+[tool.maturin]
+python-source = "python"
+module-name = "pykore._kore"
+features = ["python"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests/python"]

python/pykore/__init__.py

@@ -0,0 +1,24 @@
+from importlib import import_module
+
+__all__ = [
+    "Grid",
+    "Config",
+    "State",
+    "Kernel",
+    "Diagnostics",
+    "DiagnosticsSummary",
+]
+
+
+def __getattr__(name: str):
+    if name not in __all__:
+        raise AttributeError(f"module 'pykore' has no attribute {name!r}")
+
+    try:
+        module = import_module("pykore._kore")
+    except ImportError as exc:
+        raise ImportError(
+            "pykore native extension is not built yet; run `maturin develop` first"
+        ) from exc
+
+    return getattr(module, name)

python/pykore/__pycache__/__init__.cpython-313.pyc

@@ -18,6 +18,8 @@ pub mod ffi;
 mod fft;
 mod grid;
 mod operators;
+#[cfg(feature = "python")]
+mod python;
 mod sp;
 mod state;
 mod threading;