scipp.logging.WidgetHandler#

class scipp.logging.WidgetHandler(level, widget)#

Logging handler that sends messages to a LogWidget for display in Jupyter notebooks.

Messages are formatted into a WidgetLogRecord and not into a string.

This handler introduces special formatting for objects with an HTML representation. If the log message is a single such object, its HTML repr is embedded in the widget. Strings are formatted to replace %s with the HTML repr and %r with a plain string repr using str(x) and repr(x) is inaccessible.

__init__(level, widget)#

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

Methods

__init__(level, widget)

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

acquire()

Acquire the I/O thread lock.

addFilter(filter)

Add the specified filter to this handler.

close()

Tidy up any resources used by the handler.

createLock()

Acquire a thread lock for serializing access to the underlying I/O.

emit(record)

Send the formatted record to the widget.

filter(record)

Determine if a record is loggable by consulting all the filters.

flush()

Ensure all logging output has been flushed.

format(record)

Format the specified record for consumption by a LogWidget.

get_name()

handle(record)

Conditionally emit the specified logging record.

handleError(record)

Handle errors which occur during an emit() call.

release()

Release the I/O thread lock.

removeFilter(filter)

Remove the specified filter from this handler.

setFormatter(fmt)

Set the formatter for this handler.

setLevel(level)

Set the logging level of this handler.

set_name(name)

Attributes

name

emit(record)#

Send the formatted record to the widget.

Return type:

None

format(record)#

Format the specified record for consumption by a LogWidget.

Return type:

WidgetLogRecord