Data Structures
class	StorageError
	User-facing storage workflow failure. More...

Functions
str	_utc_now ()
	Return a stable UTC timestamp for storage metadata.

str	_human_bytes (int value)
	Format a byte count for concise command output.

str	_sha256_file (str path)
	Calculate SHA-256 without loading a potentially large file into memory.

None	_atomic_write_json (str path, dict payload)
	Atomically replace a JSON state or manifest file.

	_read_json (str path)
	Read a JSON mapping when present, otherwise return None.

	read_artifact_manifest (str root_path)
	Read a local artifact's own identity manifest, run or study.

dict	read_artifact_identity (str root_path)
	Resolve what a local artifact directory is, and what it calls itself.

	_find_upwards (str start, str filename)
	Find the nearest named file at or above a filesystem anchor.

str	storage_workspace_root (str start=None)
	Locate the initialized workspace a storage command is standing in.

str	storage_config_origin (str config_path, str workspace_root=None)
	Classify where an active storage configuration came from.

str	resolve_storage_config_path (str explicit_path=None, bool require=True)
	Resolve an explicit or nearest workspace storage configuration.

dict	load_storage_profile (str profile_name=None, str config_path=None)
	Load and validate one non-secret rclone storage profile.

str	_state_path (str root_path)
	Return the local storage state marker path for an artifact root.

	read_storage_state (str root_path)
	Read the nearest applicable storage marker for a run, study, or study member.

bool	is_artifact_cold (str root_path)
	Return whether a local artifact marker says payload data was pruned.

dict	storage_state_summary (str root_path)
	Return a compact storage status for summarize and status commands.

dict	_parse_tags (raw_tags)
	Parse repeatable KEY=VALUE tags into deterministic metadata.

Variables
str	STORAGE_CONFIG_FILENAME = ".picurv-storage.yml"

str	STORAGE_STATE_FILENAME = ".picurv-storage.json"

str	STORAGE_LOCK_FILENAME = ".picurv-storage.lock.json"

int	STORAGE_SCHEMA_VERSION = 2

str	REMOTE_OBJECTS_DIRECTORY = "objects"

str	REMOTE_BLOBS_DIRECTORY = "blobs"

str	REMOTE_MANIFEST_FILENAME = "manifest.json"

tuple	STORAGE_ARTIFACT_TYPES = ("run", "study", "study-case")

str	RUN_MANIFEST_FILENAME = "manifest.json"

str	STUDY_MANIFEST_FILENAME = "study_manifest.json"

str	REMOTE_COMPLETE_FILENAME = "COMPLETE"

str	DEFAULT_PROFILE_NAME = "archive"

float	DEFAULT_CHUNK_SIZE_GIB = 8.0

	DEFAULT_STORAGE_WORKERS = max(1, min(8, os.cpu_count() or 1))

int	AUTO_NO_COMPRESSION_BYTES = 256 * 1024 * 1024

int	AUTO_MAXIMUM_COMPRESSION_BYTES = 20 * 1024 * 1024 * 1024

	CHECKPOINT_DIRECTORY_PATTERN = re.compile(r"^step_(\d{12})$")

	INCOMPLETE_CHECKPOINT_PATTERN = re.compile(r"^\.step_\d{12}\.incomplete\.")

	ARCHIVE_ID_PATTERN = re.compile(r"^[0-9a-f]{32}$")

int	KNOWN_CHECKPOINT_VERSION = 1

str	UNCLASSIFIED_COMPONENT = "unclassified"

str	WORKSPACE_CONFIG_FILENAME = ".picurv-workspace.yml"

tuple	WORKSPACE_EXCLUDED_ROOTS = ("runs", "studies")

	ALWAYS_RETAINED_COMPONENTS

tuple	STORAGE_RESTORE_COMPONENTS

	ALWAYS_RESTORED_COMPONENTS = frozenset({"metadata", "workspace-config"})

dict	_PARALLEL_GZIP_VALUES = {"fast", "balanced"}

tuple	CLI_OUTPUT_FORMATS = ("text", "json")

tuple	STORAGE_COMPRESSION_POLICIES = ("auto", "none", "fast", "balanced", "maximum")

tuple	STORAGE_OFFLOAD_POLICIES = ("metadata-only", "restart-ready", "analysis-ready")

tuple	STORAGE_RETENTION_COMPONENTS

dict	STORAGE_COMPRESSION_EXTENSIONS

Function Documentation

◆ _utc_now()

str picurv_cli.storage.models._utc_now ( )

protected

Return a stable UTC timestamp for storage metadata.

Returns: Result produced by this operation.

Definition at line 143 of file models.py.

def _utc_now() -> str:
    """!
    @brief Return a stable UTC timestamp for storage metadata.
    @return Result produced by this operation.
    """
    return datetime.datetime.now(datetime.timezone.utc).isoformat()
 
 

◆ _human_bytes()

str picurv_cli.storage.models._human_bytes ( int value )

protected

Format a byte count for concise command output.

Parameters

[in] value Value supplied through the value argument.

Returns: Result produced by this operation.

Definition at line 151 of file models.py.

def _human_bytes(value: int) -> str:
    """!
    @brief Format a byte count for concise command output.
    @param[in] value Value supplied through the `value` argument.
    @return Result produced by this operation.
    """
    size = float(value)
    for suffix in ("B", "KiB", "MiB", "GiB", "TiB", "PiB"):
        if size < 1024.0 or suffix == "PiB":
            return f"{size:.1f} {suffix}" if suffix != "B" else f"{int(size)} B"
        size /= 1024.0
    return f"{int(value)} B"
 
 

◆ _sha256_file()

str picurv_cli.storage.models._sha256_file ( str path )

protected

Calculate SHA-256 without loading a potentially large file into memory.

Parameters

[in] path Value supplied through the path argument.

Returns: Result produced by this operation.

Definition at line 165 of file models.py.

def _sha256_file(path: str) -> str:
    """!
    @brief Calculate SHA-256 without loading a potentially large file into memory.
    @param[in] path Value supplied through the `path` argument.
    @return Result produced by this operation.
    """
    digest = hashlib.sha256()
    with open(path, "rb") as stream:
        while True:
            block = stream.read(8 * 1024 * 1024)
            if not block:
                break
            digest.update(block)
    return digest.hexdigest()
 
 

◆ _atomic_write_json()

None picurv_cli.storage.models._atomic_write_json	(	str	path,
		dict	payload
	)

protected

Atomically replace a JSON state or manifest file.

Parameters

[in]	path	Value supplied through the `path` argument.
[in]	payload	Value supplied through the `payload` argument.

Definition at line 181 of file models.py.

def _atomic_write_json(path: str, payload: dict) -> None:
    """!
    @brief Atomically replace a JSON state or manifest file.
    @param[in] path Value supplied through the `path` argument.
    @param[in] payload Value supplied through the `payload` argument.
    """
    path_abs = os.path.abspath(path)
    os.makedirs(os.path.dirname(path_abs), exist_ok=True)
    temporary = f"{path_abs}.tmp.{os.getpid()}"
    with open(temporary, "w", encoding="utf-8") as stream:
        json.dump(payload, stream, indent=2, sort_keys=True)
        stream.write("\n")
        stream.flush()
        os.fsync(stream.fileno())
    os.replace(temporary, path_abs)
 
 

◆ _read_json()

picurv_cli.storage.models._read_json ( str path )

protected

Read a JSON mapping when present, otherwise return None.

Parameters

[in] path Value supplied through the path argument.

Returns: Result produced by this operation.

Definition at line 198 of file models.py.

def _read_json(path: str):
    """!
    @brief Read a JSON mapping when present, otherwise return None.
    @param[in] path Value supplied through the `path` argument.
    @return Result produced by this operation.
    """
    try:
        with open(path, "r", encoding="utf-8") as stream:
            payload = json.load(stream)
    except (OSError, ValueError):
        return None
    return payload if isinstance(payload, dict) else None
 
 

◆ read_artifact_manifest()

picurv_cli.storage.models.read_artifact_manifest ( str root_path )

Read a local artifact's own identity manifest, run or study.

Parameters

[in] root_path Run, study, or study-member directory.

Returns: The parsed manifest mapping, or None when the directory has none.

Definition at line 212 of file models.py.

def read_artifact_manifest(root_path: str):
    """!
    @brief Read a local artifact's own identity manifest, run or study.
    @param[in] root_path Run, study, or study-member directory.
    @return The parsed manifest mapping, or None when the directory has none.
    """
    root = os.path.abspath(root_path)
    for filename in (RUN_MANIFEST_FILENAME, STUDY_MANIFEST_FILENAME):
        payload = _read_json(os.path.join(root, filename))
        if payload:
            return payload
    return None
 
 

Here is the caller graph for this function:

◆ read_artifact_identity()

dict picurv_cli.storage.models.read_artifact_identity ( str root_path )

Resolve what a local artifact directory is, and what it calls itself.

The manifest is authoritative. The directory basename is a last resort, reported as such through identity_source, so a caller can tell a real identity from a guess instead of both looking the same.

Parameters

[in] root_path Run, study, or study-member directory.

Returns: Mapping with artifact_type, run_id, study_id, case_id, and identity_source ("manifest" or "directory-name").

Definition at line 226 of file models.py.

def read_artifact_identity(root_path: str) -> dict:
    """!
    @brief Resolve what a local artifact directory is, and what it calls itself.
 
    @details The manifest is authoritative. The directory basename is a last resort,
             reported as such through `identity_source`, so a caller can tell a real
             identity from a guess instead of both looking the same.
    @param[in] root_path Run, study, or study-member directory.
    @return Mapping with `artifact_type`, `run_id`, `study_id`, `case_id`, and
            `identity_source` ("manifest" or "directory-name").
    """
    root = os.path.abspath(root_path)
    manifest = read_artifact_manifest(root)
    if manifest:
        artifact_type = manifest.get("artifact_type")
        if artifact_type in STORAGE_ARTIFACT_TYPES:
            return {
                "artifact_type": artifact_type,
                "run_id": manifest.get("run_id"),
                "study_id": manifest.get("study_id"),
                "case_id": manifest.get("case_id"),
                "paths": manifest.get("paths") or {},
                "identity_source": "manifest",
            }
    return {
        "artifact_type": None,
        "run_id": os.path.basename(root),
        "study_id": os.path.basename(root),
        "case_id": None,
        "paths": {},
        "identity_source": "directory-name",
    }
 
 
 

Here is the call graph for this function:

◆ _find_upwards()

picurv_cli.storage.models._find_upwards	(	str	start,
		str	filename
	)

protected

Find the nearest named file at or above a filesystem anchor.

Parameters

[in]	start	Value supplied through the `start` argument.
[in]	filename	Value supplied through the `filename` argument.

Returns: Result produced by this operation.

Definition at line 261 of file models.py.

def _find_upwards(start: str, filename: str):
    """!
    @brief Find the nearest named file at or above a filesystem anchor.
    @param[in] start Value supplied through the `start` argument.
    @param[in] filename Value supplied through the `filename` argument.
    @return Result produced by this operation.
    """
    current = os.path.abspath(start)
    if os.path.isfile(current):
        current = os.path.dirname(current)
    while True:
        candidate = os.path.join(current, filename)
        if os.path.isfile(candidate):
            return candidate
        parent = os.path.dirname(current)
        if parent == current:
            return None
        current = parent
 
 

◆ storage_workspace_root()

str picurv_cli.storage.models.storage_workspace_root ( str start = None )

Locate the initialized workspace a storage command is standing in.

Parameters

[in] start Directory to search from; defaults to the current directory.

Returns: Absolute workspace root, or None when the command is not inside one.

Definition at line 281 of file models.py.

def storage_workspace_root(start: str = None) -> str:
    """!
    @brief Locate the initialized workspace a storage command is standing in.
    @param[in] start Directory to search from; defaults to the current directory.
    @return Absolute workspace root, or None when the command is not inside one.
    """
    marker = _find_upwards(start or os.getcwd(), WORKSPACE_CONFIG_FILENAME)
    return os.path.dirname(marker) if marker else None
 
 

◆ storage_config_origin()

str picurv_cli.storage.models.storage_config_origin	(	str	config_path,
		str	workspace_root = `None`
	)

Classify where an active storage configuration came from.

Discovery walks upward without stopping at the workspace boundary, which is deliberate: one configuration is meant to be shareable across a directory of campaigns. What makes that dangerous is silence, not sharing. An offload uploads to the remote this file names and then prunes local payload, so which file answered has to be visible at the point of use.

Parameters

[in]	config_path	Resolved storage configuration path.
[in]	workspace_root	Owning workspace, or None to discover it from the cwd.

Returns: "workspace" when the file belongs to the workspace in scope, "shared" when it was inherited from above it, and "unowned" when there is no workspace.

Definition at line 291 of file models.py.

def storage_config_origin(config_path: str, workspace_root: str = None) -> str:
    """!
    @brief Classify where an active storage configuration came from.
 
    @details Discovery walks upward without stopping at the workspace boundary, which
             is deliberate: one configuration is meant to be shareable across a
             directory of campaigns. What makes that dangerous is silence, not sharing.
             An offload uploads to the remote this file names and then prunes local
             payload, so which file answered has to be visible at the point of use.
    @param[in] config_path Resolved storage configuration path.
    @param[in] workspace_root Owning workspace, or None to discover it from the cwd.
    @return "workspace" when the file belongs to the workspace in scope, "shared" when
            it was inherited from above it, and "unowned" when there is no workspace.
    """
    if not config_path:
        return "unowned"
    root = workspace_root if workspace_root is not None else storage_workspace_root()
    if not root:
        return "unowned"
    resolved = os.path.abspath(config_path)
    root = os.path.abspath(root)
    return "workspace" if os.path.dirname(resolved) == root else "shared"
 
 

◆ resolve_storage_config_path()

str picurv_cli.storage.models.resolve_storage_config_path	(	str	explicit_path = `None`,
		bool	require = `True`
	)

Resolve an explicit or nearest workspace storage configuration.

Parameters

[in]	explicit_path	Optional user-selected YAML path.
[in]	require	Whether a missing configuration is an error.

Returns: Result produced by this operation.

Definition at line 315 of file models.py.

def resolve_storage_config_path(explicit_path: str = None, require: bool = True) -> str:
    """!
    @brief Resolve an explicit or nearest workspace storage configuration.
    @param[in] explicit_path Optional user-selected YAML path.
    @param[in] require Whether a missing configuration is an error.
    @return Result produced by this operation.
    """
    if explicit_path:
        result = os.path.abspath(explicit_path)
    else:
        result = _find_upwards(os.getcwd(), STORAGE_CONFIG_FILENAME)
    if result and os.path.isfile(result):
        return result
    if require:
        raise StorageError(
            "No PICurv storage configuration was found. Run "
            "'picurv storage setup --remote <rclone-remote:path>' first or pass --storage-config."
        )
    return os.path.abspath(explicit_path or os.path.join(os.getcwd(), STORAGE_CONFIG_FILENAME))
 
 

◆ load_storage_profile()

dict picurv_cli.storage.models.load_storage_profile	(	str	profile_name = `None`,
		str	config_path = `None`
	)

Load and validate one non-secret rclone storage profile.

Parameters

[in]	profile_name	Value supplied through the `profile_name` argument.
[in]	config_path	Value supplied through the `config_path` argument.

Returns: Result produced by this operation.

Definition at line 336 of file models.py.

def load_storage_profile(profile_name: str = None, config_path: str = None) -> dict:
    """!
    @brief Load and validate one non-secret rclone storage profile.
    @param[in] profile_name Value supplied through the `profile_name` argument.
    @param[in] config_path Value supplied through the `config_path` argument.
    @return Result produced by this operation.
    """
    resolved_config = resolve_storage_config_path(config_path)
    with open(resolved_config, "r", encoding="utf-8") as stream:
        payload = yaml.safe_load(stream) or {}
    profiles = payload.get("profiles")
    if not isinstance(profiles, dict):
        raise StorageError(f"Storage config has no 'profiles' mapping: {resolved_config}")
    selected = profile_name or payload.get("default_profile") or DEFAULT_PROFILE_NAME
    profile = profiles.get(selected)
    if not isinstance(profile, dict):
        raise StorageError(f"Storage profile '{selected}' does not exist in {resolved_config}.")
    remote = profile.get("remote")
    if not isinstance(remote, str) or not remote.strip():
        raise StorageError(f"Storage profile '{selected}' requires a non-empty remote.")
    result = dict(profile)
    result["name"] = selected
    result["remote"] = remote.rstrip("/")
    result["config_path"] = resolved_config
    try:
        chunk_size_gib = float(result.get("chunk_size_gib", DEFAULT_CHUNK_SIZE_GIB))
    except (TypeError, ValueError) as exc:
        raise StorageError(f"Storage profile '{selected}' chunk_size_gib must be numeric.") from exc
    if chunk_size_gib <= 0.0:
        raise StorageError(f"Storage profile '{selected}' chunk_size_gib must be positive.")
    result["chunk_size_bytes"] = int(chunk_size_gib * 1024 ** 3)
    try:
        workers = int(result.get("workers", DEFAULT_STORAGE_WORKERS))
    except (TypeError, ValueError) as exc:
        raise StorageError(f"Storage profile '{selected}' workers must be an integer.") from exc
    if workers <= 0:
        raise StorageError(f"Storage profile '{selected}' workers must be positive.")
    result["workers"] = workers
    offload_policy = str(result.get("offload_policy", "metadata-only"))
    if offload_policy not in STORAGE_OFFLOAD_POLICIES:
        raise StorageError(
            f"Storage profile '{selected}' offload_policy must be one of: "
            + ", ".join(STORAGE_OFFLOAD_POLICIES)
        )
    result["offload_policy"] = offload_policy
    result["keep_latest_checkpoint"] = bool(result.get("keep_latest_checkpoint", False))
    return result
 
 

◆ _state_path()

str picurv_cli.storage.models._state_path ( str root_path )

protected

Return the local storage state marker path for an artifact root.

Parameters

[in] root_path Value supplied through the root_path argument.

Returns: Result produced by this operation.

Definition at line 385 of file models.py.

def _state_path(root_path: str) -> str:
    """!
    @brief Return the local storage state marker path for an artifact root.
    @param[in] root_path Value supplied through the `root_path` argument.
    @return Result produced by this operation.
    """
    return os.path.join(os.path.abspath(root_path), STORAGE_STATE_FILENAME)
 
 

◆ read_storage_state()

picurv_cli.storage.models.read_storage_state ( str root_path )

Read the nearest applicable storage marker for a run, study, or study member.

Parameters

[in] root_path Value supplied through the root_path argument.

Returns: Result produced by this operation.

Definition at line 394 of file models.py.

def read_storage_state(root_path: str):
    """!
    @brief Read the nearest applicable storage marker for a run, study, or study member.
    @param[in] root_path Value supplied through the `root_path` argument.
    @return Result produced by this operation.
    """
    root = Path(os.path.abspath(root_path))
    state = _read_json(_state_path(str(root)))
    if state:
        return state
    # A whole-study archive owns every numbered member.  Let ordinary run
    # workflows see that parent state without treating unrelated ancestors as
    # storage owners.
    if root.parent.name == "cases":
        return _read_json(_state_path(str(root.parent.parent)))
    return None
 
 

◆ is_artifact_cold()

bool picurv_cli.storage.models.is_artifact_cold ( str root_path )

Return whether a local artifact marker says payload data was pruned.

Parameters

[in] root_path Value supplied through the root_path argument.

Returns: Result produced by this operation.

Definition at line 412 of file models.py.

def is_artifact_cold(root_path: str) -> bool:
    """!
    @brief Return whether a local artifact marker says payload data was pruned.
    @param[in] root_path Value supplied through the `root_path` argument.
    @return Result produced by this operation.
    """
    state = read_storage_state(root_path)
    return bool(state and state.get("local_pruned"))
 
 

◆ storage_state_summary()

dict picurv_cli.storage.models.storage_state_summary ( str root_path )

Return a compact storage status for summarize and status commands.

Parameters

[in] root_path Value supplied through the root_path argument.

Returns: Result produced by this operation.

Definition at line 422 of file models.py.

def storage_state_summary(root_path: str) -> dict:
    """!
    @brief Return a compact storage status for summarize and status commands.
    @param[in] root_path Value supplied through the `root_path` argument.
    @return Result produced by this operation.
    """
    state = read_storage_state(root_path)
    if not state:
        # A marker that exists but cannot be read is worse than none: the artifact
        # claims a remote copy nobody can locate.
        if os.path.exists(_state_path(root_path)):
            return {"state": "BROKEN", "archive_id": None, "label": None,
                    "detail": "storage marker is present but unreadable"}
        return {"state": "LOCAL", "archive_id": None, "label": None}
    if not state.get("archive_id"):
        return {"state": "BROKEN", "archive_id": None, "label": state.get("label"),
                "detail": "storage marker names no archive"}
    if state.get("local_pruned"):
        status = "PARTIAL" if state.get("restored_components") else "COLD"
    else:
        status = "PROTECTED"
    return {
        "state": status,
        "archive_id": state.get("archive_id"),
        "label": state.get("label"),
        "profile": state.get("profile"),
        "remote": state.get("remote"),
    }
 
 
#: Output encodings shared with the rest of the CLI. Storage does not own this set.

◆ _parse_tags()

dict picurv_cli.storage.models._parse_tags ( raw_tags )

protected

Parse repeatable KEY=VALUE tags into deterministic metadata.

Parameters

[in] raw_tags Value supplied through the raw_tags argument.

Returns: Result produced by this operation.

Definition at line 482 of file models.py.

def _parse_tags(raw_tags) -> dict:
    """!
    @brief Parse repeatable KEY=VALUE tags into deterministic metadata.
    @param[in] raw_tags Value supplied through the `raw_tags` argument.
    @return Result produced by this operation.
    """
    tags = {}
    for item in raw_tags or []:
        key, separator, value = str(item).partition("=")
        if not separator or not key.strip() or not value.strip():
            raise StorageError(f"Invalid tag {item!r}; expected KEY=VALUE.")
        tags[key.strip()] = value.strip()
    return tags

Variable Documentation

◆ STORAGE_CONFIG_FILENAME

str picurv_cli.storage.models.STORAGE_CONFIG_FILENAME = ".picurv-storage.yml"

Definition at line 27 of file models.py.

◆ STORAGE_STATE_FILENAME

str picurv_cli.storage.models.STORAGE_STATE_FILENAME = ".picurv-storage.json"

Definition at line 30 of file models.py.

◆ STORAGE_LOCK_FILENAME

str picurv_cli.storage.models.STORAGE_LOCK_FILENAME = ".picurv-storage.lock.json"

Definition at line 33 of file models.py.

◆ STORAGE_SCHEMA_VERSION

int picurv_cli.storage.models.STORAGE_SCHEMA_VERSION = 2

Definition at line 38 of file models.py.

◆ REMOTE_OBJECTS_DIRECTORY

str picurv_cli.storage.models.REMOTE_OBJECTS_DIRECTORY = "objects"

Definition at line 41 of file models.py.

◆ REMOTE_BLOBS_DIRECTORY

str picurv_cli.storage.models.REMOTE_BLOBS_DIRECTORY = "blobs"

Definition at line 45 of file models.py.

◆ REMOTE_MANIFEST_FILENAME

str picurv_cli.storage.models.REMOTE_MANIFEST_FILENAME = "manifest.json"

Definition at line 48 of file models.py.

◆ STORAGE_ARTIFACT_TYPES

tuple picurv_cli.storage.models.STORAGE_ARTIFACT_TYPES = ("run", "study", "study-case")

Definition at line 53 of file models.py.

◆ RUN_MANIFEST_FILENAME

str picurv_cli.storage.models.RUN_MANIFEST_FILENAME = "manifest.json"

Definition at line 60 of file models.py.

◆ STUDY_MANIFEST_FILENAME

str picurv_cli.storage.models.STUDY_MANIFEST_FILENAME = "study_manifest.json"

Definition at line 64 of file models.py.

◆ REMOTE_COMPLETE_FILENAME

str picurv_cli.storage.models.REMOTE_COMPLETE_FILENAME = "COMPLETE"

Definition at line 67 of file models.py.

◆ DEFAULT_PROFILE_NAME

str picurv_cli.storage.models.DEFAULT_PROFILE_NAME = "archive"

Definition at line 70 of file models.py.

◆ DEFAULT_CHUNK_SIZE_GIB

float picurv_cli.storage.models.DEFAULT_CHUNK_SIZE_GIB = 8.0

Definition at line 73 of file models.py.

◆ DEFAULT_STORAGE_WORKERS

picurv_cli.storage.models.DEFAULT_STORAGE_WORKERS = max(1, min(8, os.cpu_count() or 1))

Definition at line 76 of file models.py.

◆ AUTO_NO_COMPRESSION_BYTES

int picurv_cli.storage.models.AUTO_NO_COMPRESSION_BYTES = 256 * 1024 * 1024

Definition at line 79 of file models.py.

◆ AUTO_MAXIMUM_COMPRESSION_BYTES

int picurv_cli.storage.models.AUTO_MAXIMUM_COMPRESSION_BYTES = 20 * 1024 * 1024 * 1024

Definition at line 82 of file models.py.

◆ CHECKPOINT_DIRECTORY_PATTERN

picurv_cli.storage.models.CHECKPOINT_DIRECTORY_PATTERN = re.compile(r"^step_(\d{12})$")

Definition at line 85 of file models.py.

◆ INCOMPLETE_CHECKPOINT_PATTERN

picurv_cli.storage.models.INCOMPLETE_CHECKPOINT_PATTERN = re.compile(r"^\.step_\d{12}\.incomplete\.")

Definition at line 88 of file models.py.

◆ ARCHIVE_ID_PATTERN

picurv_cli.storage.models.ARCHIVE_ID_PATTERN = re.compile(r"^[0-9a-f]{32}$")

Definition at line 91 of file models.py.

◆ KNOWN_CHECKPOINT_VERSION

int picurv_cli.storage.models.KNOWN_CHECKPOINT_VERSION = 1

Definition at line 94 of file models.py.

◆ UNCLASSIFIED_COMPONENT

str picurv_cli.storage.models.UNCLASSIFIED_COMPONENT = "unclassified"

Definition at line 99 of file models.py.

◆ WORKSPACE_CONFIG_FILENAME

str picurv_cli.storage.models.WORKSPACE_CONFIG_FILENAME = ".picurv-workspace.yml"

Definition at line 104 of file models.py.

◆ WORKSPACE_EXCLUDED_ROOTS

tuple picurv_cli.storage.models.WORKSPACE_EXCLUDED_ROOTS = ("runs", "studies")

Definition at line 110 of file models.py.

◆ ALWAYS_RETAINED_COMPONENTS

picurv_cli.storage.models.ALWAYS_RETAINED_COMPONENTS

Initial value:

=  frozenset(
    {UNCLASSIFIED_COMPONENT, "workspace-config", "workspace-inputs", "assets"}
)

Definition at line 118 of file models.py.

◆ STORAGE_RESTORE_COMPONENTS

tuple picurv_cli.storage.models.STORAGE_RESTORE_COMPONENTS

Initial value:

=  (
    "inputs", "raw-output", "analysis", "visualization", "logs", "assets",
    UNCLASSIFIED_COMPONENT, "workspace-config", "workspace-inputs",
)

Definition at line 123 of file models.py.

◆ ALWAYS_RESTORED_COMPONENTS

picurv_cli.storage.models.ALWAYS_RESTORED_COMPONENTS = frozenset({"metadata", "workspace-config"})

Definition at line 133 of file models.py.

◆ _PARALLEL_GZIP_VALUES

dict picurv_cli.storage.models._PARALLEL_GZIP_VALUES = {"fast", "balanced"}

protected

Definition at line 136 of file models.py.

◆ CLI_OUTPUT_FORMATS

tuple picurv_cli.storage.models.CLI_OUTPUT_FORMATS = ("text", "json")

Definition at line 453 of file models.py.

◆ STORAGE_COMPRESSION_POLICIES

tuple picurv_cli.storage.models.STORAGE_COMPRESSION_POLICIES = ("auto", "none", "fast", "balanced", "maximum")

Definition at line 458 of file models.py.

◆ STORAGE_OFFLOAD_POLICIES

tuple picurv_cli.storage.models.STORAGE_OFFLOAD_POLICIES = ("metadata-only", "restart-ready", "analysis-ready")

Definition at line 461 of file models.py.

◆ STORAGE_RETENTION_COMPONENTS

tuple picurv_cli.storage.models.STORAGE_RETENTION_COMPONENTS

Initial value:

=  (
    "checkpoints", "logs", "analysis", "visualization", "inputs", "raw-output",
)

Definition at line 470 of file models.py.

◆ STORAGE_COMPRESSION_EXTENSIONS

dict picurv_cli.storage.models.STORAGE_COMPRESSION_EXTENSIONS

Initial value:

=  {
    "none": ".tar", "fast": ".tar.gz", "balanced": ".tar.gz", "maximum": ".tar.xz",
}

Definition at line 477 of file models.py.

Data Structures

Functions

Variables

Function Documentation

◆ _utc_now()

◆ _human_bytes()

◆ _sha256_file()

◆ _atomic_write_json()

◆ _read_json()

◆ read_artifact_manifest()

◆ read_artifact_identity()

◆ _find_upwards()

◆ storage_workspace_root()

◆ storage_config_origin()

◆ resolve_storage_config_path()

◆ load_storage_profile()

◆ _state_path()

◆ read_storage_state()

◆ is_artifact_cold()

◆ storage_state_summary()

◆ _parse_tags()

Variable Documentation

◆ STORAGE_CONFIG_FILENAME

◆ STORAGE_STATE_FILENAME

◆ STORAGE_LOCK_FILENAME

◆ STORAGE_SCHEMA_VERSION

◆ REMOTE_OBJECTS_DIRECTORY

◆ REMOTE_BLOBS_DIRECTORY

◆ REMOTE_MANIFEST_FILENAME

◆ STORAGE_ARTIFACT_TYPES

◆ RUN_MANIFEST_FILENAME

◆ STUDY_MANIFEST_FILENAME

◆ REMOTE_COMPLETE_FILENAME

◆ DEFAULT_PROFILE_NAME

◆ DEFAULT_CHUNK_SIZE_GIB

◆ DEFAULT_STORAGE_WORKERS

◆ AUTO_NO_COMPRESSION_BYTES

◆ AUTO_MAXIMUM_COMPRESSION_BYTES

◆ CHECKPOINT_DIRECTORY_PATTERN

◆ INCOMPLETE_CHECKPOINT_PATTERN

◆ ARCHIVE_ID_PATTERN

◆ KNOWN_CHECKPOINT_VERSION

◆ UNCLASSIFIED_COMPONENT

◆ WORKSPACE_CONFIG_FILENAME

◆ WORKSPACE_EXCLUDED_ROOTS

◆ ALWAYS_RETAINED_COMPONENTS

◆ STORAGE_RESTORE_COMPONENTS

◆ ALWAYS_RESTORED_COMPONENTS

◆ _PARALLEL_GZIP_VALUES

◆ CLI_OUTPUT_FORMATS

◆ STORAGE_COMPRESSION_POLICIES

◆ STORAGE_OFFLOAD_POLICIES

◆ STORAGE_RETENTION_COMPONENTS

◆ STORAGE_COMPRESSION_EXTENSIONS