acme.textui.ACMEContainerTools.ACMEToolsTree

class documentation

class ACMEToolsTree(TextualTree):

Constructor: ACMEToolsTree(*args, **kwargs)

View In Hierarchy

The tree view for the tools and commands.

Method __init__ Initialize the tree view.
Method on_mount Mount the tree view.
Method on_show Show the tools tree.
Method on_tree_node_highlighted Show the tool description when a node is highlighted.
Method printLogs Print the logs of the selected node to the log widget. The output depends on the value of self.allLogs.
Method stopAutoRunScript Stop the autorun worker if it is running and the node is different from the previous autorun node.
Class Variable scriptManager Injected ScriptManager instance.
Instance Variable allLogs Whether all logs should be shown.
Instance Variable auto_expand Whether the tree should auto expand. Inherited from TextualTree.
Instance Variable autoRunName The name of the autorun script.
Instance Variable autoRunWorker The autorun worker.
Instance Variable logs The logs for the scripts.
Instance Variable nodes The nodes for the scripts.
Instance Variable parentContainer The parent container.
Method _executeScript Executes the given script context.
Method _showTool Show the script's description when a node is highlighted.
Instance Variable _app The application.
def __init__(self, *args: Any, **kwargs: Any):

Initialize the tree view.

Parameters
*args:AnyThe arguments.
**kwargs:AnyThe keyword arguments.
def on_mount(self):

Mount the tree view.

def on_show(self):

Show the tools tree.

def on_tree_node_highlighted(self, node: TextualTree.NodeHighlighted):

Show the tool description when a node is highlighted.

Parameters
node:TextualTree.NodeHighlightedThe highlighted node.
def printLogs(self):

Print the logs of the selected node to the log widget. The output depends on the value of self.allLogs.

def stopAutoRunScript(self, name: str | None = None):

Stop the autorun worker if it is running and the node is different from the previous autorun node.

Parameters
name:str | NoneThe name of the script to stop. If None, the current autorun script is stopped, independent of its name.
scriptManager: ScriptManager =

Injected ScriptManager instance.

allLogs: bool =

Whether all logs should be shown.

auto_expand: bool =

Whether the tree should auto expand. Inherited from TextualTree.

autoRunName: str =

The name of the autorun script.

autoRunWorker: BackgroundWorker =

The autorun worker.

logs: dict[str, list[str]] =

The logs for the scripts.

nodes: dict[str, TreeNode] =

The nodes for the scripts.

parentContainer =

The parent container.

def _executeScript(self, name: str, autoRun: bool | None = False, argument: str | None = '') -> bool:

Executes the given script context.

Parameters
name:strThe name of the script.
autoRun:bool | NoneUndocumented
argument:str | NoneUndocumented
Returns
boolUndocumented
def _showTool(self, node: TreeNode):

Show the script's description when a node is highlighted.

Also start the autorun worker if the meta tag "tuiAutoRun" is set.

Parameters
node:TreeNodeThe highlighted node.
_app =

The application.