Logging

Logging helpers format cihai’s command-line output. Library users normally configure logging in their application and leave cihai.log.LogFormatter and cihai.log.DebugLogFormatter to the CLI layer.

Log utilities for cihai.

cihai.log

class cihai.log.LogFormatter
class[source]
class[source]
class cihai.log.LogFormatter

Bases: Formatter

Log formatter for cihai.

__init__(color=True, **kwargs)
method[source]
method[source]
__init__(color=True, **kwargs)

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.

Parameters:
Return type:

None

format(record)
method[source]
method[source]
format(record)

Format log message to include newlines and prefixes.

Parameters:

record (LogRecord)

Return type:

str

template(record)
method[source]
method[source]
template(record)

Return the prefix for the log message. Template for Formatter.

Parameters:

record (logging.LogRecord) – Passed in from inside the logging.Formatter.format() record.

Return type:

str

class cihai.log.DebugLogFormatter
class[source]
class[source]
class cihai.log.DebugLogFormatter

Bases: LogFormatter

Provides greater technical details than standard log Formatter.

template(record)
method[source]
method[source]
template(record)

Return the prefix for the log message. Template for Formatter.

Parameters:

record (logging.LogRecord) – Passed in from inside the logging.Formatter.format() record.

Return type:

str