Logging

setup_logger(log_name: str | None = 'Patcher', log_filename: str | None = 'Patcher.log', log_level: int | None = 20) → Logger

Set up the main logger with rotating file handler.

Parameters:

• log_name (Optional[str]) – The name of the logger, defaults to ‘patcher’.

• log_filename (Optional[str]) – The log file name, defaults to {log_name}.log.

• log_level (Optional[int]) – The logging level, defaults to logging.INFO.

Returns:

The configured logger.

Return type:

logging.Logger

setup_child_logger(name_of_child: str, name_of_logger: str | None = 'Patcher', debug: bool | None = False) → Logger

Setup a child logger for a specified context.

Parameters:

• name_of_child (str) – The name of the child logger.

• name_of_logger (str) – The name of the parent logger, defaults to ‘patcher’

• debug (Optional[bool]) – Whether to set the child logger level to DEBUG, defaults to False.

Returns:

The configured child logger.

Return type:

logging.Logger

handle_traceback(exception: Exception)

Write tracebacks to logs instead of to console for readability purposes.

Parameters:

exception (Exception) – The exception instance to log.

class LogMe(class_name: str, debug: bool | None = False)

A wrapper class for logging with additional output to console using click.

Parameters:

• class_name (str) – The name of the class for which the logger is being set up.

• debug (Optional[bool]) – Whether to set the child logger level to DEBUG, defaults to False.

is_debug_enabled() → bool

Check if debug logging is enabled.

Returns:

True if debug logging is enabled, False otherwise.

Return type:

bool

debug(msg: str)

Log a debug message and output to console if debug is enabled.

Parameters:

msg (str) – The debug message to log.

info(msg: str)

Log an info message and output to console.

Parameters:

msg (str) – The info message to log.

warning(msg: str)

Log a warning message and output to console.

Parameters:

msg (str) – The warning message to log.

error(msg: str)

Log an error message and output to console.

Parameters:

msg (str) – The error message to log.