Source.Util.colored_log Namespace Reference

Classes
class	ColorFormatter
	Logging formatter that colors logging messages depending on their level. More...

Functions
str	get_format (bool line_no=False, bool threads=False)
	Get the configurable log format string.
None	init_console_logging (int level, bool threads=False)
	Initializes logging for console output.

Variables
	log = logging.getLogger(__name__)
str	S_LOG_DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
str	S_LOG_MSG_FORMAT_W_LINENO_W_THREADS = "%(asctime)s [%(name)s:%(lineno)d][%(threadName)s][%(levelname)s] %(message)s"
str	S_LOG_MSG_FORMAT_W_LINENO_WO_THREADS = "%(asctime)s [%(name)s:%(lineno)d][%(levelname)s] %(message)s"
str	S_LOG_MSG_FORMAT_WO_LINENO_W_THREADS = "%(asctime)s [%(name)s][%(threadName)s][%(levelname)s] %(message)s"
str	S_LOG_MSG_FORMAT_WO_LINENO_WO_THREADS = "%(asctime)s [%(name)s][%(levelname)s] %(message)s"

Detailed Description

---

Function Documentation

get_format()

str get_format	(	bool	line_no = False,
		bool	threads = False )

Get the configurable log format string.

Parameters

line_no	: include line number in log string
threads	: include thread name in log string

Returns

log format string

Definition at line 32 of file colored_log.py.

def get_format(line_no: bool = False, threads: bool = False) -> str:
    """!
    @brief Get the configurable log format string
    @param line_no : include line number in log string
    @param threads : include thread name in log string
    @return log format string
    """
    if not line_no and not threads:
        msg_format = S_LOG_MSG_FORMAT_WO_LINENO_WO_THREADS
    elif not line_no and threads:
        msg_format = S_LOG_MSG_FORMAT_WO_LINENO_W_THREADS
    elif line_no and not threads:
        msg_format = S_LOG_MSG_FORMAT_W_LINENO_WO_THREADS
    elif line_no and threads:
        msg_format = S_LOG_MSG_FORMAT_W_LINENO_W_THREADS
    else:
        raise ValueError("No valid format found")
    return msg_format
 
 

init_console_logging()

None init_console_logging	(	int	level,
		bool	threads = False )

Initializes logging for console output.

Line numbers are active in DEBUG level or lower.

Parameters

level	: root log level
threads	: include thread names in log strings

Definition at line 52 of file colored_log.py.

def init_console_logging(level: int, threads: bool = False) -> None:
    """!
    @brief Initializes logging for console output.
           Line numbers are active in DEBUG level or lower.
    @param level : root log level
    @param threads : include thread names in log strings
    """
    root_logger = logging.getLogger()
    root_logger.setLevel(level)
    stream_handler = logging.StreamHandler()
    line_no = bool(level == logging.DEBUG)
    date_format = S_LOG_DATE_FORMAT if (level != logging.DEBUG) else None
    stream_handler.setFormatter(ColorFormatter(line_no=line_no, threads=threads, data_format=date_format))
    root_logger.handlers.clear()
    root_logger.addHandler(stream_handler)
 
 

Variable Documentation

log

log = logging.getLogger(__name__)

Definition at line 118 of file colored_log.py.

S_LOG_DATE_FORMAT

str S_LOG_DATE_FORMAT = "%Y-%m-%d %H:%M:%S"

Definition at line 29 of file colored_log.py.

S_LOG_MSG_FORMAT_W_LINENO_W_THREADS

str S_LOG_MSG_FORMAT_W_LINENO_W_THREADS = "%(asctime)s [%(name)s:%(lineno)d][%(threadName)s][%(levelname)s] %(message)s"

Definition at line 28 of file colored_log.py.

S_LOG_MSG_FORMAT_W_LINENO_WO_THREADS

str S_LOG_MSG_FORMAT_W_LINENO_WO_THREADS = "%(asctime)s [%(name)s:%(lineno)d][%(levelname)s] %(message)s"

Definition at line 27 of file colored_log.py.

S_LOG_MSG_FORMAT_WO_LINENO_W_THREADS

str S_LOG_MSG_FORMAT_WO_LINENO_W_THREADS = "%(asctime)s [%(name)s][%(threadName)s][%(levelname)s] %(message)s"

Definition at line 26 of file colored_log.py.

S_LOG_MSG_FORMAT_WO_LINENO_WO_THREADS

str S_LOG_MSG_FORMAT_WO_LINENO_WO_THREADS = "%(asctime)s [%(name)s][%(levelname)s] %(message)s"

Definition at line 25 of file colored_log.py.