PathViewer Class Reference

Inheritance diagram for PathViewer:

Public Member Functions
	__init__ (self, path, standalone=False)
	create (self)
	show (self)

Public Attributes
	path = path.modules()
	The path to show.
	standalone = standalone
	In the standalone mode, the basic parameters of the modules are shown.

Detailed Description

Viewer object for the ipython_handler_basf2 path.
Do not use it on your own.

Definition at line 39 of file viewer.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			path,
			standalone = False )

Create a new path viewer object with the path from the process

Definition at line 46 of file viewer.py.

    def __init__(self, path, standalone=False):
        """
        Create a new path viewer object with the path from the process
        """
        
        try:
            self.path = path.modules()
        except BaseException:
            self.path = path
 
        
        self.standalone = standalone
 

Member Function Documentation

create()

create

(

self

)

Create the widget

Reimplemented from IPythonWidget.

Definition at line 59 of file viewer.py.

    def create(self):
        """
        Create the widget
        """
 
        import ipywidgets as widgets
 
        if self.path is None:
            return widgets.HTML("No modules in path.")
 
        a = widgets.Accordion()
        children = []
 
        for i, element in enumerate(self.path):
            html = ModuleViewer(element, standalone=self.standalone)
            children.append(html.create())
            if isinstance(html.module.name, str):
                a.set_title(i, html.module.name)
            else:
                a.set_title(i, html.module.name())
 
        a.children = children
 
        return a
 
 

show()

show ( self )

inherited

Show the widget

Reimplemented in ProgressBarViewer.

Definition at line 31 of file viewer.py.

    def show(self):
        """
        Show the widget
        """
        from IPython.core.display import display
 
        a = self.create()
        display(a)
 
 

Member Data Documentation

path

path = path.modules()

The path to show.

Definition at line 52 of file viewer.py.

standalone

standalone = standalone

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

Definition at line 57 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