inventory.py File Reference

Discovering what an artifact contains and which target was selected. More...

Go to the source code of this file.

Namespaces
namespace	picurv_cli
namespace	picurv_cli.storage
namespace	picurv_cli.storage.inventory

Functions
list	picurv_cli.storage.inventory._completed_study_members (str study_root)
	Select the study members that are finished and idle.
list	picurv_cli.storage.inventory._select_completed_case_ids (str study_root)
	Resolve --completed into member ids, raising if none qualify.
str	picurv_cli.storage.inventory._validate_case_id (str case_id)
	Validate a canonical numbered study-member identifier.
list	picurv_cli.storage.inventory.resolve_local_storage_targets (str run_dir=None, str study_dir=None, case_ids=None, str workspace=None, bool include_inputs=False, bool completed=False)
	Resolve explicit run/study/workspace selectors into artifact descriptions.
bool	picurv_cli.storage.inventory._path_is_within (str root, str candidate)
	Return whether an absolute candidate remains within a root directory.
str	picurv_cli.storage.inventory._resolve_configured_path (str root, str value)
	Resolve runtime-directory syntax using the run directory as working directory.
list	picurv_cli.storage.inventory._artifact_runtime_roots (str root)
	Return run-like roots contained by a standalone run or whole study.
list	picurv_cli.storage.inventory._discover_external_paths (str root)
	Report explicit external-reference descriptors inside an artifact.
list	picurv_cli.storage.inventory._discover_dependencies (str root)
	Discover absolute restart/source paths embedded in generated controls.
list	picurv_cli.storage.inventory._walk_archive_entries (str root, excluded_roots=())
	Enumerate archive entries without following symlinks.
dict	picurv_cli.storage.inventory._artifact_component_layout (str root, str artifact_type)
	Read from the artifact's own manifests where each component lives.
	picurv_cli.storage.inventory._checkpoint_step_from_bundle (str bundle_root)
	Read a committed checkpoint's own recorded step number.
str	picurv_cli.storage.inventory._classify_workspace_component (str relative_path)
	Classify one workspace-owned path for packaging and retention.
str	picurv_cli.storage.inventory._classify_component (str relative_path, dict layout=None)
	Classify one artifact path for packaging and local retention.
list	picurv_cli.storage.inventory._checkpoint_steps (list entries)
	Return committed checkpoint steps represented in an inventory.
list	picurv_cli.storage.inventory._find_incomplete_checkpoints (list entries)
	Return incomplete checkpoint paths that make archival unsafe.
dict	picurv_cli.storage.inventory.inspect_artifact (dict target, bool query_scheduler=True)
	Build a read-only inventory and lifecycle assessment for one artifact.
str	picurv_cli.storage.inventory._inventory_fingerprint (dict inventory)
	Stable digest of the file set an archive would package.

Variables
dict	picurv_cli.storage.inventory.FALLBACK_COMPONENT_PATHS

Detailed Description

Discovering what an artifact contains and which target was selected.

Definition in file inventory.py.