Module edna.core.configuration

from __future__ import annotations

from edna.core.types.builtin import ConfigurationVariable
import yaml
from typing import Dict
from abc import ABC


class EdnaConfiguration(ABC):
    """The interface representing an EdnaConfiguration. It exposes methods to read and write to the configuration.

    `set_variables()` and `set_options()` need to be implemented in inheriting classes.

    Attributes:
        variables (ConfigurationVariable): A key-value store of configuration for an Edna Job
        configuration (ConfigurationVariable): A key-value store of configuration for an Edna Context
        options (ConfigurationVariable): A key-value store of options for an Edna Job

    Returns:
        EdnaConfiguration: An EdnaConfiguration object.
    """
    variables: ConfigurationVariable
    configuration: ConfigurationVariable
    options: ConfigurationVariable
    def __init__(self):
        """Initialize the ConfigurationVariable
        """
        self.variables = ConfigurationVariable()

    def setVariable(self, key: str, value): # TODO create an EdnaType, then add the default types to it??? for strict type checking?
        self.variables[key] = value
    
    def getVariable(self, key: str):
        return self.variables[key]

    def setOption(self, key: str, value): # TODO create an EdnaType, then add the default types to it??? for strict type checking?
        self.options[key] = value
    
    def getOption(self, key: str):
        return self.options[key]


    def load_from_file(self, filepath: str):
        """Load the configuration from a yaml file.

        Args:
            filepath (str): Absolute path to the yaml file.
        """
        with open(filepath, "r") as conffile:
            temporary_configuration = yaml.load(conffile.read(), Loader=yaml.FullLoader)
        self.set_variables(temporary_configuration)
        self.set_options(temporary_configuration)
        #self.set_configuration(self, temporary_configuration)  # TODO record entire configuration???

    def set_variables(self, configuration: Dict[str, str]):
        """Set the internal variables in the configuration

        Args:
            configuration (Dict[str, str]): [The dictionary from the configuration yaml]
        """
        pass

    def set_options(self, configuration: Dict[str, str]):
        """Set the internal options for an EdnaContext using this Configuration class.

        Args:
            configuration (Dict[str, str]): [The dictionary from the configuration yaml]
        """
        pass



from .StreamingConfiguration import StreamingConfiguration