noxfile.py

# /// script
# requires-python = ">=3.11"
# dependencies = [
#     "nox",
# ]
# ///
import json
import os
import re
import sys
import urllib.request
from pathlib import Path

import nox
import tomllib

PYODIDE_VERSION = os.getenv("PYODIDE_VERSION", "0.29.0")
GITHUB_ACTIONS = os.getenv("GITHUB_ACTIONS")
GITHUB_ENV = os.getenv("GITHUB_ENV")
MSRV = tomllib.loads(Path("Cargo.toml").read_text())["package"]["rust-version"]


def append_to_github_env(name: str, value: str):
    if not GITHUB_ACTIONS or not GITHUB_ENV:
        return

    with open(GITHUB_ENV, "a") as f:
        f.write(f"{name}={value}\n")


def get_latest_pyo3_version():
    url = "https://crates.io/api/v1/crates/pyo3"
    with urllib.request.urlopen(urllib.request.Request(url, headers={"User-Agent": "maturin-nox-update"})) as response:
        data = json.loads(response.read().decode())
        return data["crate"]["max_stable_version"]


@nox.session(name="update-pyo3", python=False)
def update_pyo3(session: nox.Session):
    latest_version = get_latest_pyo3_version()
    session.log(f"Latest pyo3 version: {latest_version}")

    crates = ["pyo3", "pyo3-ffi", "pyo3-build-config"]
    # Update test crates and root Cargo.toml
    cargo_tomls = [p for p in Path(".").glob("**/Cargo.toml") if "pyo3-no-extension-module" not in str(p)]
    # Update templates
    templates = list(Path("src/templates").glob("*.j2"))

    for path in cargo_tomls + templates:
        content = path.read_text()
        changed = False
        for crate in crates:
            # Replace crate = "version"
            new_content = re.sub(
                rf'^(\s*{crate}\s*=\s*)"[0-9.]+"',
                rf'\1"{latest_version}"',
                content,
                flags=re.MULTILINE,
            )
            if new_content != content:
                content = new_content
                changed = True
            # Replace crate = { version = "version"
            new_content = re.sub(
                rf'^(\s*{crate}\s*=\s*\{{.*?version\s*=\s*)"[0-9.]+"',
                rf'\1"{latest_version}"',
                content,
                flags=re.MULTILINE,
            )
            if new_content != content:
                content = new_content
                changed = True

        if changed:
            session.log(f"Updating {path}")
            path.write_text(content)

    test_crate_dir = Path("./test-crates").resolve()
    crates_to_update = ["pyo3", "pyo3-ffi", "python3-dll-a"]
    for root, _, files in os.walk(test_crate_dir):
        if "pyo3-no-extension-module" in root:
            continue
        if "Cargo.lock" in files:
            cargo_lock_path = Path(root) / "Cargo.lock"
            with open(cargo_lock_path, "r") as lock_file:
                content = lock_file.read()
                for crate in crates_to_update:
                    if f'name = "{crate}"' in content:
                        with session.chdir(root):
                            session.run("cargo", f"+{MSRV}", "update", "-p", crate, external=True)


def _resolve_pyodide_platform_inputs(info: dict) -> dict:
    """Map a `pyodide-lock.json` `info` block to the env vars and expected
    wheel platform tag that maturin should produce when targeting that
    Pyodide release.

    Mirrors the cascade in `src/target/platform_tag.rs::emscripten_platform_tag`;
    keep the two in sync.

    Pyodide encodes platform metadata across (overlapping) fields:

    * `info.platform` is `emscripten_<X>_<Y>_<Z>` and contains the emcc
      version that built the runtime (used by `setup-emsdk`).
    * `info.abi_version` (Pyodide >= 0.28) is `<year>_<patch>` and drives the
      PEP 783 `pyemscripten_<year>_<patch>_wasm32` tag through maturin's
      historical `PYODIDE_ABI_VERSION` env var.
    * A future `info.pyemscripten_platform_version` drives
      the PEP 783 `pyemscripten_<year>_<patch>_wasm32` wheel tag.

    See https://peps.python.org/pep-0783/.
    """
    platform = info.get("platform", "")
    if platform.startswith("emscripten_"):
        emscripten_version = platform.removeprefix("emscripten_").replace("_", ".")
    else:
        emscripten_version = info.get("emscripten_version", "")

    pyemscripten = info.get("pyemscripten_platform_version", "")
    abi_version = info.get("abi_version", "")

    # Only export `EMSCRIPTEN_VERSION` when we actually resolved one — an
    # empty value would clobber a previously-set `EMSCRIPTEN_VERSION` in
    # `$GITHUB_ENV` and break `setup-emsdk`.
    env: dict[str, str] = {}
    if emscripten_version:
        env["EMSCRIPTEN_VERSION"] = emscripten_version
    if pyemscripten:
        env["PYEMSCRIPTEN_PLATFORM_VERSION"] = pyemscripten
        env["EXPECTED_PLATFORM_TAG"] = f"pyemscripten_{pyemscripten}_wasm32"
    elif abi_version:
        env["PYODIDE_ABI_VERSION"] = abi_version
        env["EXPECTED_PLATFORM_TAG"] = f"pyemscripten_{abi_version}_wasm32"
    elif emscripten_version:
        legacy = emscripten_version.replace(".", "_").replace("-", "_")
        env["EXPECTED_PLATFORM_TAG"] = f"emscripten_{legacy}_wasm32"
    return env


@nox.session(name="setup-pyodide", python=False)
def setup_pyodide(session: nox.Session):
    tests_dir = Path("./tests").resolve()
    with session.chdir(tests_dir):
        session.run(
            "npm",
            "i",
            "--no-save",
            f"pyodide@{PYODIDE_VERSION}",
            "prettier",
            external=True,
        )
        with session.chdir(tests_dir / "node_modules" / "pyodide"):
            # Pyodide ships its Emscripten output as a single very long line
            # named `pyodide.asm.js` (Pyodide <= 0.29) or `pyodide.asm.mjs`
            # (Pyodide >= 314.0.0a1). Prettifying it makes Node-side errors
            # readable. Run prettier on whichever of the two exists.
            asm_file = next(Path(".").glob("pyodide.asm.*js"), None)
            if asm_file is not None:
                session.run(
                    "node",
                    "../prettier/bin/prettier.cjs",
                    "-w",
                    asm_file.name,
                    external=True,
                )
            with open("pyodide-lock.json") as f:
                info = json.load(f)["info"]
            for name, value in _resolve_pyodide_platform_inputs(info).items():
                session.log(f"Pyodide {PYODIDE_VERSION}: {name}={value}")
                append_to_github_env(name, value)


@nox.session(name="test-emscripten", python=False)
def test_emscripten(session: nox.Session):
    tests_dir = Path("./tests").resolve()
    expected_tag = os.getenv("EXPECTED_PLATFORM_TAG")

    test_crates = [
        "test-crates/pyo3-pure",
        "test-crates/pyo3-mixed",
    ]
    for crate in test_crates:
        crate = Path(crate).resolve()
        ver = sys.version_info
        session.run("cargo", "build", external=True)
        session.run(
            tests_dir.parent / "target" / "debug" / "maturin",
            "build",
            "-m",
            str(crate / "Cargo.toml"),
            "--target",
            "wasm32-unknown-emscripten",
            "-i",
            f"python{ver.major}.{ver.minor}",
            env={"RUSTUP_TOOLCHAIN": "nightly"},
            external=True,
        )

        if expected_tag:
            wheels_dir = crate / "target" / "wheels"
            wheels = sorted(wheels_dir.glob("*.whl"))
            if not wheels:
                session.error(f"No wheel produced in {wheels_dir}")
            mismatched = [w for w in wheels if expected_tag not in w.name]
            if mismatched:
                names = ", ".join(w.name for w in mismatched)
                session.error(f"Expected platform tag {expected_tag} in wheel name(s): {names}")
            session.log(f"Verified {len(wheels)} wheel(s) carry platform tag {expected_tag}")

        with session.chdir(tests_dir):
            session.run("node", "emscripten_runner.js", str(crate), external=True)