astra.config

Configuration management for Astra observatory automation system.

This module provides configuration classes for managing Astra’s settings, observatory configurations, and asset paths. It handles YAML configuration files, directory initialization, and provides a singleton pattern for global configuration access.

Classes:

Config: Main configuration singleton for Astra settings AssetPaths: Container for asset directory paths ObservatoryConfig: Observatory-specific configuration management _ConfigInitialiser: Helper class for initial configuration setup

Classes

AssetPaths(folder_assets)	Container for asset directory paths and log file used by Astra.
Config(*args, **kwargs)	Singleton class for managing Astra's configuration settings.
ObservatoryConfig(config_path, observatory_name)	Observatory-specific configuration management with YAML persistence.

class astra.config.Config(*args: Any, **kwargs: Any)

Bases: object

Singleton class for managing Astra’s configuration settings.

This class loads configuration settings from a YAML file and provides methods to access and modify these settings. It ensures that only one instance of the configuration is created throughout the application.

CONFIG_PATH

The path to the configuration YAML file.

Type:

Path

TEMPLATE_DIR

The path to the directory containing template files.

Type:

Path

TIME_FORMAT

The format used for datetime strings.

Type:

str

observatory_name

The name of the observatory.

Type:

str

folder_assets

The path to the folder containing assets.

Type:

Path

gaia_db

The path to the Gaia database

Type:

Path

paths

An instance of AssetPaths containing paths to asset folders and log file.

Type:

AssetPaths

Note

If no configuration file is found, the user is prompted to provide the necessary information during initialization of the Config object. The configuration file is saved and the necessary files and folders are created.

Initialise the configuration settings.

Parameters:

• observatory_name (str) – The name of the observatory.

• folder_assets (Path | str) – The path to the folder containing assets.

• gaia_db (Path | str) – The path to the Gaia database.

• allow_default (bool) – Whether to raise a SystemExit if observatory configuration files were left unchanged.

• propagate_observatory_name (bool) – Whether to automatically modify the observatory config files by substituting the observatory name. Mainly useful for testing.

CONFIG_PATH = PosixPath('/opt/build/repo/src/astra/config/astra_config.yml')

TEMPLATE_DIR = PosixPath('/opt/build/repo/src/astra/config/templates')

TIME_FORMAT = '%Y-%m-%d %H:%M:%S'

static __new__(cls, *args: Any, **kwargs: Any) → Config

Ensure singleton pattern - only one Config instance exists.

property observatory_config: ObservatoryConfig

Load the observatory configuration.

reset(remove_assets: bool = False) → None

Reset configuration by removing config file and optionally assets.

Parameters:

remove_assets – If True, also removes the assets folder after confirmation.

save() → None

Save current configuration settings to YAML file.

as_datetime(date_string: str) → datetime

Convert string to datetime using configured format.

Parameters:

date_string – Date string to convert.

Returns:

datetime – Parsed datetime object.

_load_from_file() → Dict[str, str]

Load configuration from YAML file.

Returns:

dict – Configuration data from file.

_initialize_observatory_files(allow_default: bool, propagate_observatory_name: bool) → None

Initialize observatory configuration files from templates.

_modify_observatory_config_files(file_path, old_strings=[], new_strings=[])

Modify default template files by substituting specified strings.

class astra.config.AssetPaths(folder_assets: Path | str)

Bases: object

Container for asset directory paths and log file used by Astra.

Manages the creation and organization of Astra’s asset directories including configuration, schedules, images, and logs.

archive_log_file() → None

Archive the current log file with a timestamp.

_initialize_folders_and_log_file() → None

Create necessary folders and the log file if they do not exist.

class astra.config._ConfigInitialiser

Bases: object

Helper class for initial configuration setup through user prompts.

Handles the first-time setup process including directory creation, user input validation, and initial configuration file generation.

DEFAULT_ASSETS_PATH = PosixPath('/opt/buildhome/Documents/Astra')

static run(observatory_name: str | None, folder_assets: Path | str | None, gaia_db: Path | str | None) → None

Create initial configuration through user prompts.

Parameters:

• observatory_name – Name of the observatory.

• folder_assets – Path to assets folder.

• gaia_db – Path to Gaia database file.

static _prompt_assets_path() → Path

Prompt user for assets folder location.

Returns:

Path – Validated path to assets folder.

static _prompt_gaia_db_path() → str | None

Prompt user for Gaia database location.

Returns:

str or None – Path to Gaia database file or None if not using local DB.

static _validate_paths(folder_assets: Path | str | None, gaia_db: Path | str | None) → None

Validate user-provided path arguments.

Parameters:

• folder_assets – Path to assets folder.

• gaia_db – Path to Gaia database file.

Raises:

• TypeError – If paths are not str or Path types.

• FileNotFoundError – If gaia_db path doesn’t exist.

class astra.config.ObservatoryConfig(config_path: str | Path, observatory_name: str)

Bases: dict

Observatory-specific configuration management with YAML persistence.

Extends dict to provide configuration loading, saving, backup creation, and automatic reload detection for observatory configuration files.

Examples

>>> from astra.config import ObservatoryConfig
>>> observatory_config = ObservatoryConfig.from_config()

property file_path: Path

Get path to the observatory configuration YAML file.

load() → None

Load observatory configuration from YAML file.

Uses ruamel.yaml to preserve comments and structure for later saving.

reload() → ObservatoryConfig

Reload configuration if file has been modified.

Returns:

ObservatoryConfig – Self for method chaining.

save(file_path: Path | str | None = None) → None

Save configuration to YAML file with automatic backup.

Uses ruamel.yaml to preserve comments, structure, and formatting from the original file.

Parameters:

file_path – Optional custom save path, defaults to original file path.

save_backup() → None

Create timestamped backup of current configuration file.

static _deep_update(target: dict, source: dict) → None

Deep update target dict with source dict values.

Preserves ruamel.yaml CommentedMap structure and comments while updating values. Only updates existing keys or adds new ones; doesn’t remove keys from target.

Parameters:

• target – Dictionary to update (modified in place, preserves CommentedMap).

• source – Dictionary with new values to merge in.

backup_file_path(datetime_str: str = '') → Path

Get backup file path with timestamp.

Parameters:

datetime_str – Optional custom datetime string, defaults to current time.

Returns:

Path – Full path to backup file.

is_outdated() → bool

Check if configuration file has been modified since last load.

Returns:

bool – True if file has been modified externally.

classmethod from_config(config: Config | None = None) → ObservatoryConfig

Create ObservatoryConfig from main Config instance.

Parameters:

config – Main Config instance, creates new one if None.

Returns:

ObservatoryConfig – Configured instance for the observatory.

Raises:

TypeError – If config is not a Config instance.

load_fits_config() → DataFrame

Load the FITS header configuration as a pandas DataFrame.

Parameters:

observatory_name (str) – Name of the observatory.

Returns:

pd.DataFrame – DataFrame containing FITS header configuration.

get_device_config(device_type: str, device_name: str) → Dict[str, Any]

Return configuration dict for a specific device.

Parameters:

• device_type – Type of the device (e.g., ‘Telescope’, ‘Camera’).

• device_name – Name of the specific device.

Returns:

dict –

Configuration dictionary for the specified device, or {}

if not found.