feat: UNURAN as submodule with build

Author: wrdxwrdxwrdx

.github/workflows/docs_deploy.yml

@@ -23,6 +23,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Sync submodules to tracked branches
+        run: |
+          git submodule sync --recursive
+          git submodule update --init --remote --recursive
+
       - uses: actions/setup-python@v5
         with:
           python-version: "3.12"

.github/workflows/docs_preview.yml

@@ -13,6 +13,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Sync submodules to tracked branches
+        run: |
+          git submodule sync --recursive
+          git submodule update --init --remote --recursive
+
       - uses: actions/setup-python@v5
         with:
           python-version: "3.12"

.gitignore

@@ -5,6 +5,7 @@ __pycache__/
 
 # C extensions
 *.so
+*.o
 
 # Distribution / packaging
 .Python
@@ -127,7 +128,12 @@ poetry.lock
 .cursorindexingignore
 
 # Docs
-
 docs/build/*
 docs/source/api/*
 docs/source/examples/*
+
+# Log files
+*.log
+
+# Unuran build artifacts
+src/pysatl_core/sampling/unuran/bindings/_unuran_cffi.c

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "subprojects/unuran-pysatl"]
+	path = subprojects/unuran-pysatl
+	url = https://github.com/PySATL/unuran.git
+	branch = main

.pre-commit-config.yaml

@@ -20,6 +20,7 @@ exclude: >
     | LICENSE$
     | .*\.md$
     | .*\.jpg$
+    | subprojects/.*
   )$
 
 repos:
@@ -68,3 +69,4 @@ repos:
           - scipy>=1.13
           - pytest>=8
           - scipy-stubs>=1.13
+          - types-setuptools>=75

pyproject.toml

@@ -1,7 +1,13 @@
 [build-system]
 build-backend = "poetry.core.masonry.api"
 
-requires = [ "poetry-core>=1.9" ]
+requires = [
+  "cffi>=1.16",
+  "meson>=0.64",
+  "ninja>=1.10",
+  "poetry-core>=1.9",
+  "setuptools>=69",
+]
 
 [tool.poetry]
 name = "pysatl-core"
@@ -41,10 +47,15 @@ homepage = "https://github.com/PySATL/pysatl-core"
 repository = "https://github.com/PySATL/pysatl-core"
 urls.Issues = "https://github.com/PySATL/pysatl-core/issues"
 
+[tool.poetry.build]
+script = "src/pysatl_core/sampling/unuran/bindings/_cffi_build.py"
+
 [tool.poetry.dependencies]
 python = ">=3.12"
 numpy = "^2.0.0"
 scipy = ">=1.13"
+cffi = "^1.16.0"
+mypy_extensions = ">=1.0.0"
 
 [tool.poetry.group.dev.dependencies]
 ruff = ">=0.6"
@@ -55,6 +66,7 @@ coverage = { version = ">=7.5", extras = [ "toml" ] }
 pre-commit = ">=3.6"
 types-setuptools = "*"
 scipy-stubs = ">=1.13.0.0"
+types-cffi = ">=1.17.0.0"
 
 [tool.poetry.group.docs.dependencies]
 jupyter = "^1.1.1"
@@ -70,6 +82,7 @@ linkify-it-py = "^2.0.3"
 [tool.ruff]
 target-version = "py312"
 line-length = 100
+exclude = [ "subprojects" ]
 
 format.line-ending = "lf"
 
@@ -84,6 +97,9 @@ lint.isort.force-single-line = false
 lint.isort.known-first-party = [ "pysatl_core" ]
 lint.isort.order-by-type = true
 
+[tool.codespell]
+skip = "subprojects/**"
+
 [tool.pytest.ini_options]
 addopts = "-q --cov=pysatl_core --cov-report=term-missing"
 testpaths = [ "tests" ]

src/pysatl_core/sampling/unuran/bindings/__init__.py

@@ -0,0 +1,37 @@
+"""
+PySATL Core — UNU.RAN CFFI Bindings
+=====================================
+
+Lazy loader for the compiled CFFI extension module ``_unuran_cffi``.
+Tries the fully-qualified package path first, then falls back to a
+bare top-level import so the extension can be found regardless of
+how it was installed.  Exposes ``_unuran_cffi`` (``None`` when the
+binary extension is not available).
+"""
+
+from __future__ import annotations
+
+__author__ = "Artem Romanyuk"
+__copyright__ = "Copyright (c) 2025 PySATL project"
+__license__ = "SPDX-License-Identifier: MIT"
+
+from importlib import import_module
+from types import ModuleType
+
+_unuran_cffi_module = None
+
+for name in (
+    "pysatl_core.sampling.unuran.bindings._unuran_cffi",
+    "_unuran_cffi",
+):
+    try:
+        _unuran_cffi_module = import_module(name)
+        break
+    except ModuleNotFoundError:  # pragma: no cover - optional binary module
+        pass
+
+_unuran_cffi: ModuleType | None = _unuran_cffi_module
+
+__all__ = [
+    "_unuran_cffi",
+]