configure_logger

gratools.configure_logger(name, log_dir_path, verbosity_level, file_suffix='')[source]

Configures and returns a logger instance with specified settings.

The logger will output to: 1. The console (via RichHandler for formatted, colorful output). 2. A general log file (e.g., ‘name_log.o’). 3. An error log file for WARNING and higher messages (e.g., ‘name_log.e’).

Parameters

namestr

The name for the logger (e.g., “GraTools”).

log_dir_pathPath

The directory path where log files will be stored.

verbosity_levelstr

The logging verbosity level (e.g., “DEBUG”, “INFO”, “ERROR”). This sets the minimum level for messages to be processed by the logger.

file_suffixstr, optional

An optional suffix to append to the base name of log files. Defaults to an empty string.

Returns

logging.Logger

The configured logger instance.

Parameters:
  • name (str)

  • log_dir_path (Path)

  • verbosity_level (str)

  • file_suffix (str)

Return type:

Logger