dataset_data

Module for DatasetData interface

!!! classes DatasetData

DatasetData (IDatasetData)

Class for storing dataset information

Source code in entities/dataset_data.py

class DatasetData(IDatasetData):
    """Class for storing dataset information"""

    def __init__(self, dataset: dict[str, Any]):
        """Create DatasetData based on provided info dictionary

        Args:
            dataset (dict[str, Any]):
        """
        self._path = Path(get_dict_element("filename", dataset)).resolve()
        self._start_date = str(get_dict_element("start_date", dataset, False))
        self._end_date = str(get_dict_element("end_date", dataset, False))
        self._get_mapping(dataset)

    @property
    def path(self) -> Path:
        """File path to the input dataset"""
        return self._path

    @property
    def start_date(self) -> str:
        """optional start date to filter the dataset"""
        # start_date is passed as string (not datetime) because it is optional
        return self._start_date

    @property
    def end_date(self) -> str:
        """optional end date to filter the dataset"""
        # end_date is passed as string (not datetime) because it is optional
        return self._end_date

    @property
    def mapping(self) -> dict[str, str]:
        """Variable name mapping (source to target)"""
        return self._mapping

    @path.setter
    def path(self, path: Path):
        """path of the model"""
        self._path = path

    def _get_mapping(self, dataset: dict[str, Any]):
        """Get mapping specified in input file

        Args:
            dataset (dict[str, Any]):
        """
        self._mapping = get_dict_element("variable_mapping", dataset, False)

end_date: str property readonly

optional end date to filter the dataset

mapping: dict[str, str] property readonly

Variable name mapping (source to target)

path: Path property writable

File path to the input dataset

start_date: str property readonly

optional start date to filter the dataset

__init__(self, dataset) special

Create DatasetData based on provided info dictionary

Parameters:

Name	Type	Description	Default
dataset	dict[str, Any]		required

Source code in entities/dataset_data.py

def __init__(self, dataset: dict[str, Any]):
    """Create DatasetData based on provided info dictionary

    Args:
        dataset (dict[str, Any]):
    """
    self._path = Path(get_dict_element("filename", dataset)).resolve()
    self._start_date = str(get_dict_element("start_date", dataset, False))
    self._end_date = str(get_dict_element("end_date", dataset, False))
    self._get_mapping(dataset)