Skip to content

Plot Config Loader

plot_config_loader

Plot Configuration Loader.

Loads YAML configuration files for plot use cases.

Classes:

Name Description
PlotConfigLoader

Loads and caches YAML configurations.
Notes

Configurations are loaded from: src/infrastructure/plot_configs/module{N}/uc_{X}_{Y}_config.yaml

Classes

PlotConfigLoader 

PlotConfigLoader(config_dir: str = 'src/infrastructure/plot_configs')

Configuration loader for plot use cases.

Loads YAML configuration files and caches them in memory for performance.

Attributes:

Name Type Description
config_dir Path

Base directory for configurations
_cache Dict[str, Dict[str, Any]]

Configuration cache

Initialize configuration loader.

Parameters:

Name Type Description Default
config_dir str

Base directory for plot configurations.

 "src/infrastructure/plot_configs"
Source code in src/application/plot_services/plot_config_loader.py 
40
41
42
43
44
45
46
47
48
49
50
51
def __init__(self, config_dir: str = "src/infrastructure/plot_configs"):
    """
    Initialize configuration loader.

    Parameters
    ----------
    config_dir : str, default="src/infrastructure/plot_configs"
        Base directory for plot configurations.
    """
    self.config_dir = Path(config_dir)
    self._cache: Dict[str, Dict[str, Any]] = {}
    logger.info(f"PlotConfigLoader initialized: {self.config_dir}")
Functions
load_config 
load_config(use_case_id: str, force_reload: bool = False) -> Dict[str, Any]

Load configuration for given use case.

Configuration file naming convention: - UC-2.1 -> module2/uc_2_1_config.yaml - UC-3.4 -> module3/uc_3_4_config.yaml

Parameters:

Name Type Description Default
use_case_id str

Use case identifier (e.g., "UC-2.1")

 required
force_reload bool

Force reload from file (bypass cache)

 False

Returns:

Type Description
Dict[str, Any]

Configuration dictionary

Raises:

Type Description
FileNotFoundError

If configuration file not found
ValueError

If YAML is invalid
Source code in src/application/plot_services/plot_config_loader.py 
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
def load_config(
    self, use_case_id: str, force_reload: bool = False
) -> Dict[str, Any]:
    """
    Load configuration for given use case.

    Configuration file naming convention:
    - UC-2.1 -> module2/uc_2_1_config.yaml
    - UC-3.4 -> module3/uc_3_4_config.yaml

    Parameters
    ----------
    use_case_id : str
        Use case identifier (e.g., "UC-2.1")
    force_reload : bool, default=False
        Force reload from file (bypass cache)

    Returns
    -------
    Dict[str, Any]
        Configuration dictionary

    Raises
    ------
    FileNotFoundError
        If configuration file not found
    ValueError
        If YAML is invalid
    """
    # Check cache
    if use_case_id in self._cache and not force_reload:
        logger.debug(f"Cache HIT for config: {use_case_id}")
        return self._cache[use_case_id]

    logger.debug(f"Cache MISS for config: {use_case_id}")

    # Parse use case ID to get module and file name
    # UC-2.1 -> module2, uc_2_1_config.yaml
    # UC-3.2 -> module3, uc_3_2_config.yaml

    # Remove 'UC-' prefix and split by '.'
    if not use_case_id.startswith("UC-"):
        raise ValueError(
            f"Invalid use case ID format: {use_case_id}. "
            f"Expected format: UC-X.Y"
        )

    # Extract module and subcase numbers
    # "UC-2.1" -> "2.1" -> ["2", "1"]
    id_part = use_case_id.replace("UC-", "")
    parts = id_part.split(".")

    if len(parts) != 2:
        raise ValueError(
            f"Invalid use case ID format: {use_case_id}. "
            f"Expected format: UC-X.Y"
        )

    module_num = parts[0]  # "2"
    sub_case = parts[1]  # "1"

    # Build file path
    # module2/uc_2_1_config.yaml
    module_dir = f"module{module_num}"
    filename = f"uc_{module_num}_{sub_case}_config.yaml"
    config_path = self.config_dir / module_dir / filename

    logger.debug(f"Looking for config: {use_case_id} -> {config_path}")

    # Load YAML
    if not config_path.exists():
        raise FileNotFoundError(f"Configuration file not found: {config_path}")

    try:
        with open(config_path, "r", encoding="utf-8") as f:
            config = yaml.safe_load(f)

        # Cache and return
        self._cache[use_case_id] = config
        logger.info(f"Loaded configuration for {use_case_id}")

        return config

    except yaml.YAMLError as e:
        raise ValueError(f"Invalid YAML in {config_path}: {e}")
clear_cache 
clear_cache() -> None

Clear configuration cache.

Source code in src/application/plot_services/plot_config_loader.py 
139
140
141
142
def clear_cache(self) -> None:
    """Clear configuration cache."""
    self._cache.clear()
    logger.info("Configuration cache cleared")
get_cached_keys 
get_cached_keys() -> list

Get list of cached use case IDs.

Returns:

Type Description
list

List of cached use case IDs.
Source code in src/application/plot_services/plot_config_loader.py 
144
145
146
147
148
149
150
151
152
153
def get_cached_keys(self) -> list:
    """
    Get list of cached use case IDs.

    Returns
    -------
    list
        List of cached use case IDs.
    """
    return list(self._cache.keys())