Source code for alab_management.config

# type: ignore

"""
This file contains the configuration for the alab_management package.
It will read from a yaml file to get all the configurations.

An example of the yaml file is as follows:

.. code-block:: yaml

  [general]
  working_dir = "."
  name = 'default_lab'

  [mongodb]
  host = 'localhost'
  port = 27017
  username = ''
  password = ''

  [rabbitmq]
  host = "localhost"
  port = 5672

"""

import os
from pathlib import Path
from types import MappingProxyType as FrozenDict
from typing import Any

import toml




def freeze_config(config_: dict[str, Any]) -> FrozenDict:
    """
    Convert the config dict to frozen config.

    Args:
        config_: the dict of config data

    Returns
    -------
        frozen_config, which can not be modified
    """

    def _frozen_collection(collection_or_element):
        """Convert a list to tuple, a dict to frozen_dict recursively."""
        if isinstance(collection_or_element, list):
            return tuple(
                _frozen_collection(element) for element in collection_or_element
            )
        if isinstance(collection_or_element, dict):
            return FrozenDict(
                {k: _frozen_collection(v) for k, v in collection_or_element.items()}
            )

        return collection_or_element

    return _frozen_collection(config_)





class AlabOSConfig:
    """Class used for storing all the config data."""

    def __init__(self):
        """Load a immutable toml config file from `config_path`."""
        config_path = os.getenv("ALABOS_CONFIG_PATH", None)
        sim_mode_flag = os.getenv("SIM_MODE_FLAG", "True")
        sim_mode_flag_boolean = sim_mode_flag.lower() == "true"

        self.sim_mode_flag = sim_mode_flag_boolean

        if config_path is None:
            config_path = "config.toml"

        try:
            with open(config_path, encoding="utf-8") as f:
                _config = toml.load(f)
        except FileNotFoundError as exc:
            raise FileNotFoundError(
                f"Config file was not found at {config_path}."
                "Please set your computer's environment variable 'ALABOS_CONFIG_PATH' to the path to the config file. In "
                "absence of this environment variable, we assume there is a file named config.toml in the current "
                "directory."
            ) from exc

        self._path = Path(config_path).absolute()
        self._config = freeze_config(_config)

    def __getitem__(self, item):
        """Get the config item."""
        return self._config.__getitem__(item)

    def __str__(self):
        """Get the string representation of the config."""
        return self._config.__repr__()

    def __repr__(self):
        """Get the string representation of the config."""
        return self.__str__()

    def __hash__(self):  # type: ignore
        """Get the hash of the config."""
        return self._config.__hash__()



    def get(self, item, default=None):
        """Get the config item."""
        return self._config.get(item, default)




    def set_item(self, key, value):
        """Set a specific config item."""
        self._config[key] = value


    def __contains__(self, item):
        """Check if the config contains the item."""
        return self._config.__contains__(item)

    @property
    def path(self) -> Path:
        """The absolute path to the config file."""
        return self._path



    def is_sim_mode(self) -> bool:
        """Check if the system is in simulation mode."""
        return self.sim_mode_flag