ModuleViewer Class Reference

Inheritance diagram for ModuleViewer:

Collaboration diagram for ModuleViewer:

Public Member Functions
def	__init__ (self, module, standalone=True)
def	get_color_code (self, param)
def	create (self)

Public Attributes
	module
	The module to show.
	standalone
	In the standalone mode, the basic parameters of the modules are shown.
	table_beginning_html
	Template for the table beginning.
	td_html
	Template for the table cell.
	table_row_parameters
	Template for the row of parameters.
	table_row_help
	Template for the row with help.
	table_row_html_single
	Template for the simple row.
	table_title_html
	Template for the table title.

Detailed Description

A widget for showing module parameter with their content (not standalone)
or with their description (standalone).

Definition at line 85 of file viewer.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			module,
			standalone = True
	)

 Init with a module as a string or a registered one. 

Definition at line 91 of file viewer.py.

    def __init__(self, module, standalone=True):
        """ Init with a module as a string or a registered one. """
 
        
        if isinstance(module, str):
            import basf2.core as _basf2
            self.module = _basf2.register_module(module)
        else:
            self.module = module
 
        
        self.standalone = standalone
 
        
        self.table_beginning_html = """<table style="margin-left: auto; margin-right: auto;
                                       border-collapse: separate; border-spacing: 0px;">"""
 
        
        self.td_html = "style=\"padding: 10px;\""
 
        
        self.table_row_parameters = """<tr><td {td_style}>{param.name}</td>
                                      <td{color_text} {td_style}>{param.values}</td>
                                      <td style="color: gray; {td_style}>{param.default}</td></tr>"""
 
        
        self.table_row_help = """<tr><td {td_style}>{param.name}</td>
                                      <td {td_style}>{param.type}</td>
                                      <td {td_style}>{param.values}</td>
                                      <td style="color: gray; {td_style}>{param.description}</td></tr>"""
 
        
        self.table_row_html_single = """<tr><td colspan="4" {td_style}>{text}</td></tr>"""
 
        
        self.table_title_html = """<thead><td colspan="4" style="text-align: center;
                                   font-size: 18pt;" {td_style}>{module_name} ({package})</td></thead>"""
 

Member Function Documentation

create()

def create

(

self

)

Show the widget.

Reimplemented from IPythonWidget.

Definition at line 141 of file viewer.py.

    def create(self):
        """
        Show the widget.
        """
        import ipywidgets as widgets
 
        html = widgets.HTML()
        html.value = self.table_beginning_html
 
        if self.standalone:
            if isinstance(self.module.name, str):
                module_name = self.module.name
            else:
                module_name = self.module.name()
 
            html.value += self.table_title_html.format(module_name=module_name, package=self.module.package(),
                                                       td_style=self.td_html)
 
            html.value += self.table_row_html_single.format(text=self.module.description(), td_style=self.td_html)
 
        if len(self.module.available_params()) == 0:
            html.value += self.table_row_html_single.format(text="No parameters available.", td_style=self.td_html)
        else:
            for param in self.module.available_params():
                color_text = self.get_color_code(param)
 
                if self.standalone:
                    table_row_html = self.table_row_help
                else:
                    table_row_html = self.table_row_parameters
 
                html.value += table_row_html.format(param=param, color_text=color_text, td_style=self.td_html)
        html.value += "</table>"
 
        return html
 
 

get_color_code()

def get_color_code	(		self,
			param
	)

 Handy function for getting a color based on a parameter:
 if it has the default value, no color,
 if not, red color.

Definition at line 129 of file viewer.py.

    def get_color_code(self, param):
        """
         Handy function for getting a color based on a parameter:
         if it has the default value, no color,
         if not, red color.
        """
        if str(param.values) != str(param.default) and str(param.default) != "":
            color_text = " style='color: red;'"
        else:
            color_text = ""
        return color_text
 

Member Data Documentation

module

module

The module to show.

Definition at line 97 of file viewer.py.

standalone

standalone

In the standalone mode, the basic parameters of the modules are shown.

Definition at line 102 of file viewer.py.

table_beginning_html

table_beginning_html

Template for the table beginning.

Definition at line 105 of file viewer.py.

table_row_help

table_row_help

Template for the row with help.

Definition at line 117 of file viewer.py.

table_row_html_single

table_row_html_single

Template for the simple row.

Definition at line 123 of file viewer.py.

table_row_parameters

table_row_parameters

Template for the row of parameters.

Definition at line 112 of file viewer.py.

table_title_html

table_title_html

Template for the table title.

Definition at line 126 of file viewer.py.

td_html

td_html

Template for the table cell.

Definition at line 109 of file viewer.py.

---

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

• framework/scripts/hep_ipython_tools/ipython_handler_basf2/viewer.py