modbot.utilities.logging.ColoredFormatter

class modbot.utilities.logging.ColoredFormatter(fmt=None, datefmt=None, style='%', validate=True)

Bases: Formatter

Colored formatting for log output

Methods

converter	localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,
format(record)	Apply level specific coloring
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.
get_username_color(badges)	Get username color based on badges
usesTime()	Check if the format uses the creation time of the record.

Attributes

COLORS
COL_SEQ
FORMATS
USERNAME_COLORS
default_msec_format
default_time_format
full_format
level
level_format
msg_format
other_format
val

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)

Apply level specific coloring

formatException(ei)

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

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.

get_username_color(badges)

Get username color based on badges

usesTime()

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