CustomFormatter class
Formatter able to write colored logs.
Colors are used to colorize log meta information such as: - the calling module name - the caling function name (available with 'extended' format only) - logging level (available with 'extended' format only)
Methods
- def _init_formatters(self)
- Initialize inner formatters for each supported logging level.
- def converter(...)
- localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min, tm_sec,tm_wday,tm_yday,tm_isdst)
- def format(self, record)
- def formatException(self, ei)
- Format and return the specified exception information as a string.
- def formatMessage(self, record)
- def formatStack(self, stack_info)
- This method is provided as an extension point for specialized formatting of stack information.
- def formatTime(self, record, datefmt = None)
- Return the creation time of the specified LogRecord as formatted text.
- def usesTime(self)
- Check if the format uses the creation time of the record.
Special methods
- def __init__(self, frmt: str, colored: bool = False)
Data
- LOGGING_LEVEL_COLORS = ...
- default_msec_format = '%s,%03d'
- default_time_format = '%Y-%m-%d %H:%M:%S'
Method documentation
def lbaf.
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.
def lbaf.
Format and return the specified exception information as a string.
This default implementation just uses traceback.print_exception()
def lbaf.
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 :func:`traceback.print_stack`, but with the last trailing newline removed.
The base implementation just returns the value passed in.
def lbaf.
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.