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

datazen - A data structure for runtime data.

 
Package Contents
       
base
command
compile
config
group
integrated
manifest
manifest_cache
render
schema
task
template
variable

 
Classes
       
builtins.object
EnvironmentNamespace

 
class EnvironmentNamespace(builtins.object)
    EnvironmentNamespace(name: str)
 
The base class for management of the environment data structure.
 
  Methods defined here:
__init__(self, name: str)
Base constructor.
add_dir(self, dir_type: datazen.enums.DataType, dir_path: str, rel_path: str = '.', allow_dup: bool = False) -> bool
Add a directory to be loaded for a given data type.
add_dirs(self, dir_type: datazen.enums.DataType, dir_paths: List[str], rel_path: str = '.', allow_dup: bool = False) -> int
Add multiple directories for a given data type, return the number of
directories added.
get_to_load(self, dir_type: datazen.enums.DataType) -> List[Union[pathlib.Path, str, NoneType]]
Build a list of the yet-to-be-loaded directories for a given data
type.
unload(self, dir_type: datazen.enums.DataType) -> None
Mark all directories for a given type as un-loaded.
unload_all(self) -> None
Mark all directories as unloaded.
update_load_state(self, dir_type: datazen.enums.DataType, to_load: List[Union[pathlib.Path, str, NoneType]]) -> int
Update the load states of directories in 'to_load' for a given
data type.

Data descriptors defined here:
__dict__
dictionary for instance variables
__weakref__
list of weak references to the object

 
Functions
       
clone(env: datazen.environment.EnvironmentNamespace, update: datazen.environment.EnvironmentNamespace) -> datazen.environment.EnvironmentNamespace
Create a clone (deep copy) of an existing Environment.

 
Data
        Dict = typing.Dict
GenericStrDict = typing.Dict[str, typing.Any]
List = typing.List
Pathlike = typing.Union[pathlib.Path, str, NoneType]