ColoredFormatter

class lib.logger.ColoredFormatter(fmt: str, pad_newlines: bool = False, **kwargs)

Bases: Formatter

Overrides the stand logging.Formatter to enable colored labels for message level labels on supported platforms

Parameters:

fmt (str) – The format string for the message as a whole
pad_newlines (bool) – If True new lines will be padded to appear in line with the log message, if False they will be left aligned
kwargs – Standard logging.Formatter keyword arguments

Attributes Summary

`default_msec_format`
`default_time_format`

Methods Summary

`converter`	localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,
`format`(record)	Color the log message level if supported otherwise return the standard log message.
`formatException`(ei)	Format and return the specified exception information as a string.
`formatMessage`(record)
`formatStack`(stack_info)	This method is provided as an extension point for specialized formatting of stack information.
`formatTime`(record[, datefmt])	Return the creation time of the specified LogRecord as formatted text.
`usesTime`()	Check if the format uses the creation time of the record.

Attributes Documentation

default_msec_format = '%s,%03d'

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

Methods Documentation

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.

format(record: LogRecord) → str

Color the log message level if supported otherwise return the standard log message.

Parameters:: record (LogRecord) – The incoming log record to be formatted for entry into the logger.
Return type:: The formatted log message

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.

format(record: LogRecord) → str

Color the log message level if supported otherwise return the standard log message.

Parameters:: record (LogRecord) – The incoming log record to be formatted for entry into the logger.
Return type:: The formatted log message