Python: package rcmpy.environment

rcmpy.environment

index
/home/vkottler/src/vkottler/workspace/rcmpy/rcmpy/environment/__init__.py

A module implementing the package's runtime environment.

Package Contents

Classes

rcmpy.environment.template.TemplateEnvironment(rcmpy.environment.base.BaseEnvironment)

Environment

class Environment(rcmpy.environment.template.TemplateEnvironment)

Environment(state: rcmpy.state.State, stack: contextlib.ExitStack) -> None

A class implementing this package's runtime environment.

Method resolution order:: Environment; rcmpy.environment.template.TemplateEnvironment; rcmpy.environment.base.BaseEnvironment; vcorelib.logging.LoggerMixin; builtins.object

Data and other attributes defined here:

__annotations__ = {}

Methods inherited from rcmpy.environment.template.TemplateEnvironment:

is_updated(self, file: rcmpy.config.file.ManagedFile) -> bool: Determine if a managed file is updated or not (based on template
changes).

Methods inherited from rcmpy.environment.base.BaseEnvironment:

__init__(self, state: rcmpy.state.State, stack: contextlib.ExitStack) -> None: Initialize this instance.

Readonly properties inherited from rcmpy.environment.base.BaseEnvironment:

config: Get this environment's configuration object.

config_loaded: Determine if this environment has loaded a config.

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Functions
		load_environment(root: Union[pathlib.Path, str, NoneType] = None, name: str = 'state.json') -> Iterator[rcmpy.environment.Environment] A wrapper for loading an environment with default state data.

Data
		Iterator = typing.Iterator Pathlike = typing.Union[pathlib.Path, str, NoneType]