deploy_tools.layout

Members

Layout	Represents the layout of the deployment area.
ModuleAreaLayout	Represents the layout of Modules with the given root path.
ModuleBuildLayout	Represents the layout used for Modules during the build process.

class deploy_tools.layout.ModuleAreaLayout(root: Path)

Represents the layout of Modules with the given root path.

This is generic to both built and deployed modules.

get_module_folder(name: str, version: str) → Path

Return the folder holding the given module’s files.

get_entrypoints_folder(name: str, version: str) → Path

Return the folder holding the given module’s entrypoint scripts.

get_modulefile(name: str, version: str) → Path

Return the path to the given module’s modulefile.

get_module_snapshot_path(name: str, version: str) → Path

Return the path to the given module’s configuration snapshot.

class deploy_tools.layout.ModuleBuildLayout(root: Path)

Represents the layout used for Modules during the build process.

When intended to be used before the Deploy step, this should be done on the same filesystem as the Deployment Area, in order to ensure that all filesystem moves are atomic.

get_sif_files_folder(name: str, version: str) → Path

Return the folder holding the given module’s Apptainer .sif images.

property build_root: Path

Root path of the build area.

class deploy_tools.layout.Layout(deployment_root: Path, build_root: Path | None = None)

Represents the layout of the deployment area.

get_module_folder(name: str, version: str) → Path

Return the folder holding the given deployed module’s files.

get_entrypoints_folder(name: str, version: str) → Path

Return the folder holding the given deployed module’s entrypoint scripts.

get_modulefiles_root(from_deprecated: bool = False) → Path

Return the modulefiles root, or the deprecated one if requested.

get_modulefile_link(name: str, version: str, from_deprecated: bool = False) → Path

Return the path to the modulefile link for the given module.

get_modulefile(name: str, version: str) → Path

Return the path to the given deployed module’s modulefile.

get_module_snapshot_path(name: str, version: str) → Path

Return the path to the given deployed module’s configuration snapshot.

get_default_version_file(name: str) → Path

Return the path to the file recording a module’s default version.

property deployment_root: Path

Root path of the deployment area.

property deprecated_root: Path

Root path for deprecated files.

property modules_root: Path

Root path holding deployed modules.

property modulefiles_root: Path

Root path holding modulefile links for deployed modules.

property deprecated_modulefiles_root: Path

Root path holding modulefile links for deprecated modules.

property deployment_snapshot_path: Path

Path to the deployment area’s configuration snapshot.

property build_layout: ModuleBuildLayout

Return the ModuleBuildLayout for the associated build area.