acme.runtime.ConsoleBase.ConsoleBase

class documentation

class ConsoleBase:

Known subclasses: acme.plugins.runtime.Console.Console, acme.plugins.runtime.MinimalConsole.MinimalConsole

Base class for console plugins.

Method	`doStartWithTextUI`	Check if the console should start with the text UI.
Method	`run`	This method must be implemented by a derived class. It runs the main console loop. This is a blocking call that will run until the console is stopped.
Method	`runTUI`	Open the text UI.
Method	`shutdown`	Shutdown the Console instance.
Method	`shutdownCSE`	Shutdown the CSE. Confirm shutdown before actually doing that.
Method	`stop`	Stop the console loop.
Class Variable	`textUI`	Injected TextUI instance.

def doStartWithTextUI(self) -> bool: ¶

Check if the console should start with the text UI.

Returns
`bool`	True if the console should start with the text UI, False otherwise.

def run(self): ¶

overridden in acme.plugins.runtime.Console.Console, acme.plugins.runtime.MinimalConsole.MinimalConsole

This method must be implemented by a derived class. It runs the main console loop. This is a blocking call that will run until the console is stopped.

def runTUI(self, key: str | None = None): ¶

Open the text UI.

def shutdown(self) -> bool: ¶

Shutdown the Console instance.

Returns
`bool`	Always returns True.

def shutdownCSE(self, key: str): ¶

Shutdown the CSE. Confirm shutdown before actually doing that.

Parameters
key:`str`	Input key. Ignored.

def stop(self): ¶

Stop the console loop.

textUI: TextUI = ¶

Injected TextUI instance.