Skip to content

Config

Utility functions for the Simlify command-line interface (CLI), including logging setup and configuration loading.

load_yaml_config(file_path)

Loads configuration data from a YAML file.

This function takes the path to a YAML file as input, attempts to open and parse the file using the yaml library's safe loader, and returns the configuration as a Python dictionary. If any error occurs during the file reading or parsing process, an error message is logged using loguru, and the program exits with an error code.

PARAMETER DESCRIPTION
file_path

The path to the YAML configuration file to be loaded.

TYPE: str

RETURNS DESCRIPTION
dict[str, Any]

A dictionary representing the configuration loaded from the YAML file. The keys of the dictionary are strings, and the values can be of any type supported by YAML.
RAISES DESCRIPTION
SystemExit

If there is an error loading the YAML file (e.g., file not found, invalid YAML syntax), the function will log an error and terminate the program with an exit code of 1.

setup_logging(args)

Configures the logging level and output for the Simlify CLI based on command-line arguments.

This function takes the parsed command-line arguments and uses them to determine the verbosity level of the logs. It supports three levels of verbosity controlled by the -v and -vv flags: INFO (default), DEBUG (-v), and TRACE (-vv). It also allows the user to specify a log file to write the logs to using the --logfile argument. The logging format is set to display the log level and the message.

PARAMETER DESCRIPTION
args

An object containing the parsed command-line arguments, specifically looking for -v, -vv, and --logfile.

TYPE: Namespace

The function performs the following steps:

  1. Determines the log level based on the presence of -v and -vv flags.
  2. If -vv is present, the log level is set to TRACE (0).
  3. If -v is present, the log level is set to DEBUG (10).
  4. If neither flag is present, the log level defaults to INFO (20).
  5. Calls the enable_logging function from the simlify package to configure the logging system with the determined log level, whether to use standard error for output (set to True), the specified log file (if any), and the desired log message format.