peridem_env Namespace Reference

Functions
None	ensure_peridem ()

Variables
list	__all__ = ["REPO_ROOT", "ensure_peridem"]
	REPO_ROOT
tuple	_BUILD_DIRS

Detailed Description

Make ``import peridem`` work from a build tree.

Examples import this first so they run straight from a checkout without
``pip install``. If peridem is already importable (installed, or PYTHONPATH is
set) this does nothing.

Function Documentation

ensure_peridem()

None peridem_env.ensure_peridem

(

)

Definition at line 32 of file peridem_env.py.

def ensure_peridem() -> None:
    try:
        import peridem  # noqa: F401
 
        return
    except ImportError:
        pass
    # The staged package under build/ carries the compiled _core; the source
    # python/ directory does not, so it must never shadow it.
    for rel in _BUILD_DIRS:
        cand = REPO_ROOT / rel
        if (cand / "peridem" / "__init__.py").is_file():
            sys.path.insert(0, str(cand))
            break
    else:
        sys.path.insert(0, str(REPO_ROOT / "python"))
    try:
        import peridem  # noqa: F401
    except ImportError as exc:  # pragma: no cover - build guidance
        raise SystemExit(
            "cannot import peridem. Build the extension first:\n"
            f"  cmake -S {REPO_ROOT} -B {REPO_ROOT}/build -DEnable_Python=ON\n"
            f"  cmake --build {REPO_ROOT}/build --target peridem_core PeriDEM -j\n"
            f"({exc})"
        ) from exc
 
 

References ensure_peridem().

Referenced by ensure_peridem().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

__all__

list peridem_env.__all__ = ["REPO_ROOT", "ensure_peridem"]

private

Definition at line 21 of file peridem_env.py.

_BUILD_DIRS

tuple peridem_env._BUILD_DIRS

protected

Initial value:

=  ("build/linux/python", "build/python", "build/Release/python",
               "build/Debug/python")

Definition at line 28 of file peridem_env.py.

REPO_ROOT

peridem_env.REPO_ROOT

Initial value:

=  next(
    p for p in Path(__file__).resolve().parents
    if (p / "python" / "peridem" / "__init__.py").is_file()
)

Definition at line 23 of file peridem_env.py.