LogViewer Class Reference

Inheritance diagram for LogViewer:

Collaboration diagram for LogViewer:

Public Member Functions
def	__init__ (self, log_content)
def	format_logmessage (self, buf, message, indent=4, base=0)
def	create (self)

Public Attributes
	log_content
	The log content to show.
	log_levels
	The log levels of the framework.
	log_color_codes
	The color codes for the log messages.
	log_message
	A templated line in the log.
	toggle_button_line
	The toggle button.

Detailed Description

A widget to show the log of a calculation.

Definition at line 295 of file viewer.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			log_content
	)

Initialize the log viewer.

Definition at line 300 of file viewer.py.

    def __init__(self, log_content):
        """
        Initialize the log viewer.
        """
 
        
        self.log_content = log_content
 
        
        self.log_levels = ["DEBUG", "INFO", "RESULT", "WARNING", "ERROR", "FATAL", "DEFAULT"]
 
        
        self.log_color_codes = {"DEBUG": "gray", "ERROR": "red", "FATAL": "red", "INFO": "black", "RESULT": "green",
                                "WARNING": "orange", "DEFAULT": "black"}
 
        
        self.log_message = """<pre class="log-line-{type_lower}" title="{info}">[{level}] {message}{var_output}</pre>"""
 
        
        self.toggle_button_line = """<a onclick="$('.log-line-{type_lower}').hide();
                                                 $('.log-line-{type_lower}-hide-button').hide();
                                                 $('.log-line-{type_lower}-show-button').show();"                                        style="cursor: pointer; margin: 0px 10px;"
                                        class="log-line-{type_lower}-hide-button">Hide {type_upper}</a>
                                     <a onclick="$('.log-line-{type_lower}').show();
                                                 $('.log-line-{type_lower}-hide-button').show();
                                                 $('.log-line-{type_lower}-show-button').hide();"
                                        style="cursor: pointer; margin: 0px 10px; display: none;"
                                        class="log-line-{type_lower}-show-button">Show {type_upper}</a>"""
 
 

Member Function Documentation

create()

def create

(

self

)

Create the log viewer.

Reimplemented from IPythonWidget.

Definition at line 345 of file viewer.py.

    def create(self):
        """
        Create the log viewer.
        """
        from ipywidgets import HTML, HBox, VBox
 
        output = StringIO()
        output.write("<style scoped>\n")
        for level, color in self.log_color_codes.items():
            level = level.lower()
            output.write(f".log-line-{level} {{margin:0; padding:0; line-height:normal; color: {color} !important;}}\n")
 
        output.write("""</style><div style="max-height: 400px; overflow-y: auto; width: 100%";>""")
 
        for line in self.log_content.split("\n"):
            if line.startswith('{"level"'):
                try:
                    message = json.loads(line)
                    # ok, message is parsed. Prepare some info string which
                    # contains the info about the message in a indented
                    # format but don't completely json or pprint because it
                    # takes to much time
                    buf = StringIO()
                    self.format_logmessage(buf, message)
                    info = escape(buf.getvalue())
                    # add variables if necessary
                    variables = message.get("variables", "")
                    if variables:
                        variables = "\n".join([""] + [f"\t{k} = {v}" for k, v in variables.items()])
                    # and write out
                    level = message["level"].lower()
                    output.write(self.log_message.format(info=info, type_lower=level, var_output=variables, **message))
                    continue
                except json.JSONDecodeError:
                    # any error: treat as default output, not a log line
                    pass
 
            output.write('<pre class="log-line-default">')
            output.write(line)
            output.write('</pre>')
 
        output.write("</div>")
 
        html = HTML()
        html.value = output.getvalue()
        html.width = "100%"
        html.margin = "5px"
 
        buttons = []
        for type in self.log_levels:
            buttons.append(HTML(self.toggle_button_line.format(type_lower=type.lower(), type_upper=type.upper())))
 
        buttons_view = HBox(buttons)
        buttons_view.margin = "10px 0px"
        result_vbox = VBox((buttons_view, html))
 
        return result_vbox

format_logmessage()

def format_logmessage	(		self,
			buf,
			message,
			indent = 4,
			base = 0
	)

Format the json object of a logmessage as key: value list with recursion and indentation
Funnily this is faster than json.dumps() and looks a bit better in the title attribute

Definition at line 330 of file viewer.py.

    def format_logmessage(self, buf, message, indent=4, base=0):
        """
        Format the json object of a logmessage as key: value list with recursion and indentation
        Funnily this is faster than json.dumps() and looks a bit better in the title attribute
        """
        for key, val in message.items():
            if not val:
                continue
            if isinstance(val, dict):
                buf.write(f"{key}:\n")
                self.format_logmessage(buf, val, indent=indent, base=base + indent)
            else:
                buf.write(base * " ")
                buf.write(f"{key}: {val!r}\n")
 

Member Data Documentation

log_color_codes

log_color_codes

The color codes for the log messages.

Definition at line 312 of file viewer.py.

log_content

log_content

The log content to show.

Definition at line 306 of file viewer.py.

log_levels

log_levels

The log levels of the framework.

Definition at line 309 of file viewer.py.

log_message

log_message

A templated line in the log.

Definition at line 316 of file viewer.py.

toggle_button_line

toggle_button_line

The toggle button.

Definition at line 319 of file viewer.py.

---

The documentation for this class was generated from the following file:

• framework/scripts/hep_ipython_tools/viewer.py