bootstrap.py

"""
Shared bootstrap for every example's run.py.

Adds the `inky` Python binding to sys.path — mirroring how
inky/bindings/python/test.py loads it in development: a direct
sys.path.insert() at bindings/python/src, not a pip install. This suite
assumes inky-example-python is checked out as a SIBLING of inky/ (same
assumption the PHP suite makes about its Composer path repository — see
SUITE.md "Runtime requirements" §1 and the "Porting notes for Stage C"
§2(a) sanity check).

Runtime note (this suite's own Task-1-equivalent sanity check): unlike
Composer's symlinked path repository, this sys.path insertion points
directly at bindings/python/src — there is no package-manager symlink
anywhere in the loop, so there's nothing for __file__ resolution inside
inky/__init__.py to get fooled by. Its own dylib lookup (_find_library(),
resolved relative to its own __file__, four directories up to
target/release/) works completely unmodified. No special wiring was
needed; unlike PHP's `minimum-stability`/`prefer-stable` composer fix,
there is no equivalent dependency-resolver quirk here either, since this
suite never asks pip to resolve inky itself — only Jinja2 (a normal,
stable PyPI release) is installed via requirements.txt.

Every example's run.py starts with:

    import os, sys
    sys.path.insert(0, os.path.normpath(os.path.join(os.path.dirname(__file__), "..", "..")))
    import bootstrap
    import inky

    dist = bootstrap.inky_example("01-quickstart")
"""

import os
import sys

_ROOT = os.path.dirname(os.path.abspath(__file__))
_INKY_SRC = os.path.normpath(
    os.path.join(_ROOT, "..", "inky", "bindings", "python", "src")
)

if _INKY_SRC not in sys.path:
    sys.path.insert(0, _INKY_SRC)


def inky_example(name: str) -> str:
    """Return the dist output directory for an example, creating it if needed."""
    path = os.path.join(_ROOT, "dist", name)
    os.makedirs(path, exist_ok=True)
    return path