bout_runners.utils.logs¶
Contains methods which deals with logging.
Functions
Get the logging configuration. |
|
|
Set up the logger. |
Classes
|
Class which adds the indent formatter to the logging formatter. |
-
class
bout_runners.utils.logs.IndentFormatter(fmt: Optional[str] = None, datefmt: Optional[str] = None)[source]¶ Class which adds the indent formatter to the logging formatter.
References
https://code.activestate.com/recipes/412603-stack-based-indentation-of-formatted-logging/
Methods
converter([seconds])Convert seconds since the Epoch to a time tuple expressing local time.
format(record)Format the log string.
formatException(ei)Format and return the specified exception information as a string.
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.
formatMessage
Call constructor and set member data.
- Parameters
- fmtstr or None
String to format
- datefmtstr or None
Format of date
Methods
converter([seconds])Convert seconds since the Epoch to a time tuple expressing local time.
format(record)Format the log string.
formatException(ei)Format and return the specified exception information as a string.
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.
formatMessage
-
converter([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: logging.LogRecord) → str[source]¶ Format the log string.
- Parameters
- recordLogRecord
The record to modify
- Returns
- outstr
Formatted log record
-
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.
-
usesTime()¶ Check if the format uses the creation time of the record.