tsdat.config.retriever

Classes

RetrieverConfig

Contains configuration parameters for the tsdat retriever class.

class tsdat.config.retriever.RetrieverConfig

Bases: tsdat.config.utils.ParameterizedConfigClass, tsdat.config.utils.YamlModel

Contains configuration parameters for the tsdat retriever class.

This class will ultimately be converted into a tsdat.io.base.Retriever subclass for use in tsdat pipelines.

Provides methods to support yaml parsing and validation, including the generation of json schema for immediate validation. This class also provides a method to instantiate a tsdat.io.base.Retriever subclass from a parsed configuration file.

Parameters

• classname (str) – The dotted module path to the pipeline that the specified configurations should apply to. To use the built-in IngestPipeline, for example, you would set ‘tsdat.pipeline.pipelines.IngestPipeline’ as the classname.

• readers (Dict[str, DataReaderConfig]) – The DataReaders to use for reading input data.

coords :Dict[str, Union[Dict[Pattern, RetrievedVariableConfig], RetrievedVariableConfig]]

data_vars :Dict[str, Union[Dict[Pattern, RetrievedVariableConfig], RetrievedVariableConfig]]

readers :Optional[Dict[Pattern, DataReaderConfig]]

Class Methods

coerce_to_patterned_retriever

Method Descriptions

classmethod coerce_to_patterned_retriever(cls, var_dict: Dict[str, Union[Dict[Pattern, RetrievedVariableConfig], RetrievedVariableConfig]]) → Dict[str, Dict[Pattern[str], RetrievedVariableConfig]]