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

A module implementing a basic environment interface.

 
Classes
       
vcorelib.logging.LoggerMixin(builtins.object)
BaseEnvironment

 
class BaseEnvironment(vcorelib.logging.LoggerMixin)
    BaseEnvironment(state: rcmpy.state.State, stack: contextlib.ExitStack) -> None
 
A class implementing this package's base runtime environment.
 
 
Method resolution order:
BaseEnvironment
vcorelib.logging.LoggerMixin
builtins.object
Methods defined here:
__init__(self, state: rcmpy.state.State, stack: contextlib.ExitStack) -> None
Initialize this instance.
Readonly properties defined here:
config
Get this environment's configuration object.
config_loaded
Determine if this environment has loaded a config.
Data and other attributes defined here:
__annotations__ = {}
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_if_single_candidate(path: Union[pathlib.Path, str, NoneType], logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = None) -> Optional[vcorelib.io.types.LoadResult]
Attempt to load a configuration file if a candidate exists at the given
path.
load_manifest(root: pathlib.Path, variant: str, logger: Union[logging.Logger, logging.LoggerAdapter[Any]]) -> Optional[vcorelib.io.types.LoadResult]
Load the top-level data repository configuration.

 
Data
        ARBITER = <vcorelib.io.arbiter.DataArbiter object>
LoggerType = typing.Union[logging.Logger, logging.LoggerAdapter[typing.Any]]
Optional = typing.Optional
PKG_NAME = 'rcmpy'
Pathlike = typing.Union[pathlib.Path, str, NoneType]