gameboy_worlds.utils.log_handling

 1from gameboy_worlds.utils.fundamental import meta_dict_to_str
 2from gameboy_worlds.utils.parameter_handling import load_parameters
 3import sys
 4
 5
 6def log_error(message: str, parameters: dict = None):
 7    """
 8    Log an error message and raise a ValueError.
 9    Args:
10        message (str): The error message to log.
11        parameters (dict, optional): Parameters dictionary containing the logger. See load_parameters for details.
12        If parameters is None, the default parameters will be loaded from the config files
13        If the log_file or log_dir is overwritten in the command line parameters, then calling this function with parameters=None
14        will *not* log to the command line file. In general, use None only if you are confident that the parameters have not been changed.
15    """
16    parameters = load_parameters(parameters)
17    logger = parameters["logger"]
18    logger.error(message, stacklevel=2)
19    raise RuntimeError()
20    # sys.exit(1)
21
22
23def log_warn(message: str, parameters: dict = None):
24    """
25    Log a warning message.
26    Args:
27        message (str): The warning message to log.
28        parameters (dict, optional): Parameters dictionary containing the logger. See load_parameters for details.
29        If parameters is None, the default parameters will be loaded from the config files
30        If the log_file or log_dir is overwritten in the command line parameters, then calling this function with parameters=None
31        will *not* log to the command line file. In general, use None only if you are confident that the parameters have not been changed.
32    """
33    parameters = load_parameters(parameters)
34    logger = parameters["logger"]
35    logger.warn(message, stacklevel=2)
36
37
38def log_info(message: str, parameters: dict = None):
39    """
40    Log an info message.
41    Args:
42        message (str): The info message to log.
43        parameters (dict, optional): Parameters dictionary containing the logger. See load_parameters for details.
44        If parameters is None, the default parameters will be loaded from the config files
45        If the log_file or log_dir is overwritten in the command line parameters, then calling this function with parameters=None
46        will *not* log to the command line file. In general, use None only if you are confident that the parameters have not been changed.
47    """
48    parameters = load_parameters(parameters)
49    logger = parameters["logger"]
50    logger.info(message, stacklevel=2)
51
52
53def log_dict(meta_dict: dict, *, parameters: dict = None, n_indents: int = 1):
54    """
55    Print a dictionary in a readable format
56    Args:
57        meta_dict (dict): The dictionary to log.
58        n_indents (int, optional): Number of indentation levels for formatting. Defaults to 1.
59        parameters (dict, optional): Parameters dictionary containing the logger. See load_parameters for details.
60        If parameters is None, the default parameters will be loaded from the config files
61        If the log_file or log_dir is overwritten in the command line parameters, then calling this function with parameters=None
62        will *not* log to the command line file. In general, use None only if you are confident that the parameters have not been changed.
63    """
64    parameters = load_parameters(parameters)
65    logger = parameters["logger"]
66    meta_dict_str = meta_dict_to_str(
67        meta_dict, print_mode=True, n_indents=n_indents, skip_write_timestamp=False
68    )
69    logger.info("\n" + meta_dict_str, stacklevel=2)