| | |
- datazen.environment.base.BaseEnvironment(builtins.object)
-
- SchemaEnvironment
class SchemaEnvironment(datazen.environment.base.BaseEnvironment) |
| |
SchemaEnvironment(default_ns: str = '__root__', logger: logging.Logger = <Logger datazen.environment.base (WARNING)>, newline: str = '\n', **_) -> None
The schema-data loading environment mixin, only requires the base
environment capability to function.
|
| |
- Method resolution order:
- SchemaEnvironment
- datazen.environment.base.BaseEnvironment
- builtins.object
Methods defined here:
- add_schema_dirs(self, dir_paths: List[str], rel_path: str = '.', name: str = '__root__', allow_dup: bool = False) -> int
- Add schema-data directories, return the number of directories added.
- add_schema_type_dirs(self, dir_paths: List[str], rel_path: str = '.', name: str = '__root__', allow_dup: bool = False) -> int
- Add directories containing schema-type data (to be registered at
runtime).
- enforce_schemas(self, data: Dict[str, Any], require_all: bool = True, sch_loads: datazen.load.LoadedFiles = LoadedFiles(files=None, file_data=None), sch_types_loads: datazen.load.LoadedFiles = LoadedFiles(files=None, file_data=None), name: str = '__root__') -> bool
- Perform schema-validation on provided data and return the boolean
result. Adds (and removes) namespaced types if applicable.
- load_schema_types(self, sch_loads: datazen.load.LoadedFiles = LoadedFiles(files=None, file_data=None), name: str = '__root__') -> Dict[str, Any]
- Load custom schema types and resolve any un-loaded directories.
- load_schemas(self, require_all: bool = True, sch_loads: datazen.load.LoadedFiles = LoadedFiles(files=None, file_data=None), sch_types_loads: datazen.load.LoadedFiles = LoadedFiles(files=None, file_data=None), name: str = '__root__', modify_registry: bool = True) -> Dict[str, Any]
- Load schema data, resolve any un-loaded schema directories.
Methods inherited from datazen.environment.base.BaseEnvironment:
- __init__(self, default_ns: str = '__root__', logger: logging.Logger = <Logger datazen.environment.base (WARNING)>, newline: str = '\n', **_) -> None
- Manage environments by names, set up a dictionary with a root
namespace.
- add_dir(self, dir_type: datazen.enums.DataType, dir_path: str, rel_path: str = '.', name: str = '__root__', allow_dup: bool = False) -> bool
- Proxy for add_dir for a namespace.
- add_dirs(self, dir_type: datazen.enums.DataType, dir_paths: List[str], rel_path: str = '.', name: str = '__root__', allow_dup: bool = False) -> int
- Proxy for add_dirs for a namespace.
- add_namespace(self, name: str, clone_root: bool = True) -> None
- Add a new namespace, optionally clone from the existing root.
- get_data(self, dir_type: datazen.enums.DataType, name: str = '__root__') -> Dict[str, Any]
- Get the raw data for a directory type from a namespace.
- get_namespace(self, key_name: str, target: str, target_data: Dict[str, Any]) -> str
- Determine the namespace that a target should use, in general they
all should be unique unless they don't load anything new.
- get_to_load(self, dir_type: datazen.enums.DataType, name: str = '__root__') -> List[Union[pathlib.Path, str, NoneType]]
- Proxy for a namespace's get_to_load.
- get_valid(self, name: str = '__root__') -> bool
- Get the 'valid' flag for a namespace.
- set_valid(self, value: bool, name: str = '__root__') -> None
- Set the 'valid' flag for a namespace.
- unload_all(self, name: str = '__root__') -> None
- Unload all of the directories for a namespace.
- update_load_state(self, dir_type: datazen.enums.DataType, to_load: List[Union[pathlib.Path, str, NoneType]], name: str = '__root__') -> int
- Proxy for update_load_state for a namespace.
Data descriptors inherited from datazen.environment.base.BaseEnvironment:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
| |