palgen.application.log#

Palgen logging helpers

Module Contents#

class palgen.application.log.LogFormatter#
palgen.application.log.LogFormatter logging.Formatter logging.Formatter logging.PercentStyle logging.PercentStyle logging.PercentStyle->logging.Formatter _style palgen.application.log.LogFormatter palgen.application.log.LogFormatter palgen.application.log.LogFormatter palgen.application.log.LogFormatter->logging.Formatter

Custom log formatter

Initialize the formatter with specified format strings.

Initialize the formatter either with the specified format string, or a default as described above. Allow for specialized date formatting with the optional datefmt argument. If datefmt is omitted, you get an ISO8601-like (or RFC 3339-like) format.

Use a style parameter of ‘%’, ‘{’ or ‘$’ to specify that you want to use one of %-formatting, str.format() ({}) formatting or string.Template formatting in your format string.

Changed in version 3.2: Added the style parameter.

__slots__ = ('formatters',)#
colors#
time_fmt = '%Y-%m-%d %H:%M:%S'#
converter#
default_time_format = '%Y-%m-%d %H:%M:%S'#
default_msec_format = '%s,%03d'#
static get_format(color)#

Returns a format string with the appropriate color.

Parameters:

color (str) – ANSI escape code

Returns:

fmt string

Return type:

str

format(record)#

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.

Parameters:

record (logging.LogRecord) –

Return type:

str

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.

formatException(ei)#

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

usesTime()#

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

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.

palgen.application.log.setup_logger()#

Enables this custom logger globally.

Return type:

None

palgen.application.log.set_min_level(level)#

Disables output of messages below the given level

Parameters:

level (int) – log level #TODO copy description from palliate

palgen.application.log.handle_exception(type_, value, trace)#

Global exception handler. Prints uncaught exceptions with the custom formatter.

Parameters:

  • type – Exception type

  • value – Exception value

  • trace – Exception trace