nirs4all.workspace.compat module

Transition helpers for legacy workspace detection and conversion guidance.

exception nirs4all.workspace.compat.ConversionRequired(info: WorkspaceFormatInfo)[source]

Bases: RtError

A legacy workspace must be converted by an explicit Tools command.

class nirs4all.workspace.compat.WorkspaceFormatInfo(path: Path, format: str, conversion_required: bool, message: str, conversion_command: str | None = None)[source]

Bases: object

Stat-only workspace format diagnosis used by the transition release.

conversion_command: str | None = None

conversion_required: bool

format: str

message: str

path: Path

nirs4all.workspace.compat.build_conversion_command(path: Path | str, output: Path | str | None = None) → str[source]: Build the recommended no-in-place conversion command.

nirs4all.workspace.compat.default_conversion_output(path: Path) → Path[source]: Return the default fresh output directory for a converted workspace.

nirs4all.workspace.compat.inspect_workspace_format(path: Path | str) → WorkspaceFormatInfo[source]: Inspect a workspace or artifact without opening it through WorkspaceStore.

nirs4all.workspace.compat.warn_if_legacy_workspace(path: Path | str) → WorkspaceFormatInfo[source]: Warn with a concrete conversion command when path is a legacy workspace.