rcmpy.environment package

rcmpy.environment package#

A module implementing a basic environment interface.

class rcmpy.environment.base.BaseEnvironment(state: State, stack: ExitStack)[source]#

Bases: LoggerMixin

A class implementing this package’s base runtime environment.

property config_loaded: bool#: Determine if this environment has loaded a config.

rcmpy.environment.base.load_if_single_candidate(path: Path | str | None, logger: Logger | LoggerAdapter[Any] = None) → LoadResult | None[source]#: Attempt to load a configuration file if a candidate exists at the given path.

rcmpy.environment.base.load_manifest(root: Path, variant: str, logger: Logger | LoggerAdapter[Any]) → LoadResult | None[source]#: Load the top-level data repository configuration.

A module for exposing useful information from the current system to templates.

rcmpy.environment.data.system_data() → Dict[str, Any][source]#: Obtain useful system configuration data.

An environment extension for working with template files.

class rcmpy.environment.template.EnvTemplate(name: str, path: Path, subdir: str, template: Template | None = None)[source]#

Bases: NamedTuple

A data structure for keeping track of environment templates. If ‘template’ is None, it signals that the template does not require rendering.

class rcmpy.environment.template.TemplateEnvironment(state: State, stack: ExitStack)[source]#

A class implementing template management for this package’s runtime environment.

is_updated(file: ManagedFile) → bool[source]#: Determine if a managed file is updated or not (based on template changes).

rcmpy.environment.template.template_name(name: str) → Tuple[bool, str][source]#: Determine if a name is a template and remove the template suffix if applicable.

A module implementing the package’s runtime environment.

class rcmpy.environment.Environment(state: State, stack: ExitStack)[source]#

A class implementing this package’s runtime environment.

rcmpy.environment.load_environment(root: Path | str | None = None, name: str = 'state.json') → Iterator[Environment][source]#: A wrapper for loading an environment with default state data.