log_manager module

Python dual-logging setup (console and log file).

It supports different log levels and colorized output.

Created by Fonic <https://github.com/fonic> Date: 04/05/20 - 02/07/23

Based on: https://stackoverflow.com/a/13733863/1976617 https://uran198.github.io/en/python/2016/07/12/colorful-python-logging.html https://en.wikipedia.org/wiki/ANSI_escape_code#Colors

Todo

Modernize this, with type hint etc.

class LogFormatter(color, *args, **kwargs)

Bases: Formatter

Logging formatter supporting colorized output.

COLOR_CODES = {   10: '\x1b[1;30m',     20: '\x1b[0;37m',     30: '\x1b[1;33m',     40: '\x1b[1;31m',     50: '\x1b[1;35m'}

RESET_CODE = '\x1b[0m'

format(record, *args, **kwargs)

Format the specified record as text.

The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

converter()

localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,

tm_sec,tm_wday,tm_yday,tm_isdst)

Convert seconds since the Epoch to a time tuple expressing local time. When ‘seconds’ is not passed in, convert the current time instead.

default_msec_format = '%s,%03d'

default_time_format = '%Y-%m-%d %H:%M:%S'

formatException(ei)

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

formatMessage(record)

formatStack(stack_info)

This method is provided as an extension point for specialized formatting of stack information.

The input data is a string as returned from a call to traceback.print_stack(), but with the last trailing newline removed.

The base implementation just returns the value passed in.

formatTime(record, datefmt=None)

Return the creation time of the specified LogRecord as formatted text.

This method should be called from format() by a formatter which wants to make use of a formatted time. This method can be overridden in formatters to provide for any specific requirement, but the basic behaviour is as follows: if datefmt (a string) is specified, it is used with time.strftime() to format the creation time of the record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used. The resulting string is returned. This function uses a user-configurable function to convert the creation time to a tuple. By default, time.localtime() is used; to change this for a particular formatter instance, set the ‘converter’ attribute to a function with the same signature as time.localtime() or time.gmtime(). To change it for all formatters, for example if you want all logging times to be shown in GMT, set the ‘converter’ attribute in the Formatter class.

usesTime()

Check if the format uses the creation time of the record.

class SuppressMessageFilter(suppressed_substrings)

Bases: Filter

Filter to temporarily suppress some logs.

Parameters:

suppressed_substrings (Collection[str])

filter(record)

Determine if the specified record is to be logged.

Parameters:

record (LogRecord) – The log record to be evaluated.

Returns:

False if the message contains one of the suppressed substrings; True otherwise.

Return type:

bool

suppress_log_messages(logger_name, substrings)

Temporarily suppress log messages that contain any of the given substrings.

Parameters:

• logger_name (str) – Name of the logger to apply the filter to. Use “” for the root logger.

• substrings (list[str]) – Substrings to match against log messages. Messages containing any of these substrings will be suppressed.

Yields:

None – Yields control to the context block with the filter active.

set_up_logging(console_log_output='stdout', console_log_level='INFO', console_log_color=True, console_log_line_template='%(color_on)s[%(levelname)-8s] [%(filename)-20s]%(color_off)s %(message)s', logfile_file=PosixPath('multipac_testbench.log'), logfile_log_level='INFO', logfile_log_color=False, logfile_line_template=('%(color_on)s[%(asctime)s] [%(levelname)-8s] [%(filename)-20s]%(color_off)s '

'%(message)s'))

Set up logging.

main()

Main function.