semantic_router.utils.logger.CustomFormatter#

class semantic_router.utils.logger.CustomFormatter#

Bases: ColoredFormatter

__init__()#

Set the format and colors the ColoredFormatter will use.

The fmt, datefmt, style, and default args are passed on to the logging.Formatter constructor.

The secondary_log_colors argument can be used to create additional log_color attributes. Each key in the dictionary will set {key}_log_color, using the value to select from a different log_colors set.

Parameters:

  • fmt (str): The format string to use.

  • datefmt (str): A format string for the date.

  • log_colors (dict):

    A mapping of log level names to color names.

  • reset (bool):

    Implicitly append a color reset to all records unless False.

  • style (‘%’ or ‘{’ or ‘$’):

    The format style to use.

  • secondary_log_colors (dict):

    Map secondary log_color attributes. (New in version 2.6.)

  • validate (bool)

    Validate the format string.

  • stream (typing.IO)

    The stream formatted messages will be printed to. Used to toggle colour on non-TTY outputs. Optional.

  • no_color (bool):

    Disable color output.

  • force_color (bool):

    Enable color output. Takes precedence over no_color.

Methods

__init__()

Set the format and colors the ColoredFormatter will use.

converter

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

format(record)

Format the specified record as text.

formatException(ei)

Format and return the specified exception information as a string.

formatMessage(record)

Format a message from a record object.

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

default_msec_format

default_time_format

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)#

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.

formatException(ei)#

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

formatMessage(record: LogRecord) → str#

Format a message from a record object.

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.