tsdat.config.config
¶
Classes¶
Wrapper for the pipeline configuration file. |
-
class
tsdat.config.config.
Config
(dictionary: Dict)[source]¶ 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.
Class Methods
Lints a yaml file and raises an exception if an error is found.
Load one or more yaml pipeline configuration files. Multiple files
Method Descriptions
-
static
lint_yaml
(filename: str)[source]¶ 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.
-
classmethod
load
(self, filepaths: List[str])[source]¶ 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