tsdat.config.config¶
Module Contents¶
Classes¶
Wrapper for the pipeline configuration file. |
-
class
tsdat.config.config.Config(dictionary: Dict)¶ Wrapper for the pipeline configuration file.
Note: in most cases,
Config.load(filepath)should be used to instantiate the Config class.- Parameters
dictionary (Dict) – The pipeline configuration file as a dictionary.
-
_parse_quality_managers(self, dictionary: Dict) → Dict[str, tsdat.config.quality_manager_definition.QualityManagerDefinition]¶ Extracts QualityManagerDefinitions from the config file.
- Parameters
dictionary (Dict) – The quality_management dictionary.
- Returns
Mapping of quality manager name to QualityManagerDefinition
- Return type
Dict[str, QualityManagerDefinition]
-
classmethod
load(self, filepaths: List[str])¶ Load one or more yaml pipeline configuration files. Multiple files should only be passed as input if the pipeline configuration file is split across multiple files.
- Parameters
filepaths (List[str]) – The path(s) to yaml configuration files to load.
- Returns
A Config object wrapping the yaml configuration file(s).
- Return type
-
static
lint_yaml(filename: str)¶ Lints a yaml file and raises an exception if an error is found.
- Parameters
filename (str) – The path to the file to lint.
- Raises
Exception – Raises an exception if an error is found.