apsbits.utils.config_loaders

Configuration management for the instrument.

This module serves as the single source of truth for instrument configuration. It loads and validates the configuration from the iconfig.yml file and provides access to the configuration throughout the application.

Functions

get_config()	Get the current configuration.
load_config([config_path])	Load configuration from a YAML or TOML file.
load_config_yaml(config_obj)	Load configuration from a YAML file.
update_config(updates)	Update the current configuration.

apsbits.utils.config_loaders.get_config() → Dict[str, Any]

Get the current configuration.

Returns:

The current configuration dictionary.

apsbits.utils.config_loaders.load_config(config_path: Path | None = None) → Dict[str, Any]

Load configuration from a YAML or TOML file.

Args:

config_path: Path to the configuration file.

Returns:

The loaded configuration dictionary.

Raises:

ValueError: If config_path is None or if the file extension is not supported. FileNotFoundError: If the configuration file does not exist.

apsbits.utils.config_loaders.load_config_yaml(config_obj) → dict

Load configuration from a YAML file.

Args:

config_path: Path to the configuration file.

Returns:

The loaded configuration dictionary.

Raises:

FileNotFoundError: If the configuration file does not exist.

apsbits.utils.config_loaders.update_config(updates: Dict[str, Any]) → None

Update the current configuration.

Args:

updates: Dictionary of configuration updates.