`arelle.logging.handlers.StructuredMessageLogHandler`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Classes¶

StructuredMessageLogHandler

Custom logging handler to handle logging traffic.

Data¶

`REFS`
`MSG`
`MESSAGE_CODE`
`LEVELNAME`
`ARGS`

API¶

arelle.logging.handlers.StructuredMessageLogHandler.REFS¶: ‘refs’

arelle.logging.handlers.StructuredMessageLogHandler.MSG¶: ‘msg’

arelle.logging.handlers.StructuredMessageLogHandler.MESSAGE_CODE¶: ‘messageCode’

arelle.logging.handlers.StructuredMessageLogHandler.LEVELNAME¶: ‘levelname’

arelle.logging.handlers.StructuredMessageLogHandler.ARGS¶: ‘args’

class arelle.logging.handlers.StructuredMessageLogHandler.StructuredMessageLogHandler(cntlr: arelle.Cntlr.Cntlr | None = None)¶

Bases: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler

Custom logging handler to handle logging traffic.

Initialization

Initializes the instance - basically setting the formatter to None and the filter list to empty.

flush() → None¶: Nothing to Flush, so this overload causes flush to be a no-op.

emit(logRecord: logging.LogRecord) → None¶

Converts a log record to a map format and adds it to the list of messages

Parameters:: logRecord – The log record to use for the message
Returns:: None
Return type:: None

static get_message(log_record: logging.LogRecord) → str | tuple[object, ...] | collections.abc.Mapping[str, object] | None¶

Gets the message that we want to report from the log record.

Parameters:: log_record – The log record to use for the message
Returns:: The message that we want to use

logRecordBuffer: list[logging.LogRecord]¶: None

cntlr: arelle.Cntlr.Cntlr | None¶: None

filename: str | None¶: None

filemode: str¶: None

htmlTitle: str¶: ‘Arelle Message Log’

clearLogBuffer() → None¶

getXml(clearLogBuffer: bool = True, includeDeclaration: bool = True) → str¶

getJson(clearLogBuffer: bool = True) → str¶

getHtml(clearLogBuffer: bool = True) → str¶

getLines(clearLogBuffer: bool = True) → list[str]¶

getText(separator: str = '\n', clearLogBuffer: bool = True) → str¶

logTextMaxLength: int¶: None

recordToXml(logRec: logging.LogRecord) → str¶

recordToJson(logRec: logging.LogRecord) → dict[str, Any]¶

recordToHtml(logRec: logging.LogRecord) → str¶

get_name()¶

set_name(name)¶

name¶: ‘property(…)’

createLock()¶

acquire()¶

release()¶

setLevel(level)¶

format(record)¶

handle(record)¶

setFormatter(fmt)¶

close()¶

handleError(record)¶

addFilter(filter)¶

removeFilter(filter)¶

filter(record)¶