spacr.version

The installed spaCR version, and the environment report built from it.

Resolves the version from installed package metadata rather than a hard-coded string, so a source checkout and an installed wheel agree.

Copyright © 2025 olafsson lab

Functions

__getattr__(name)	Resolve version_str lazily (PEP 562).
format_version_info(→ str)	Return a human-readable multi-line summary of the current environment.
get_torch_version(→ str)	Return the installed PyTorch version, or "not available" if torch is missing.
get_version(→ str)	Return the installed spacr package version, or "unknown" if not found.
get_version_info(→ dict[str, str])	Return a dict of spacr, platform, Python, and torch version strings.

Module Contents

spacr.version.__getattr__(name: str)

Resolve version_str lazily (PEP 562).

Parameters:

name – Module attribute requested by Python’s fallback lookup.

Returns:

The formatted environment report for version_str.

Raises:

AttributeError – If name is not version_str.

format_version_info() calls get_torch_version(), which imports torch — roughly 0.94 s. Evaluating it at module scope meant every import spacr paid for torch whether or not anything needed it, which defeated the point of light entry points like spacr.validate, whose whole value is answering in about a second before a run starts.

from spacr.version import version_str still works unchanged; the cost is now paid only by the caller that actually asks for it.

spacr.version.format_version_info() → str

Return a human-readable multi-line summary of the current environment.

Returns:

Tab-aligned version report suitable for CLI display.

spacr.version.get_torch_version() → str

Return the installed PyTorch version, or "not available" if torch is missing.

Returns:

torch.__version__ when importable, otherwise a placeholder string.

spacr.version.get_version() → str

Return the installed spacr package version, or "unknown" if not found.

Returns:

Version string from the first candidate distribution that resolves.

spacr.version.get_version_info() → dict[str, str]

Return a dict of spacr, platform, Python, and torch version strings.

Returns:

Mapping with keys spacr_version, platform, python_version, torch_version.