acli Namespace Reference

Namespaces
	daq_async_commands
	daq_commands
	logger
	mal_client
	shell_base
	std_async_commands
	std_commands

Classes
class	CustomCompleter
	Prompt toolkit Custom Completer class. More...

Functions
def	class_meta_data (class_name)
	Build metadata dictionary to be used by CustomCompleter class. More...
def	interactive_shell (history, prompt, cmdobj, cmdif)
	Implements Prompt Toolkit asynchronous shell. More...
def	main (module, class_name, class_args, prompt, history_file, log_level)
	Asynchronouos shell for interactive communication with servers. More...

Variables
	parse = None
	style
	log = logging.getLogger(__name__)

Function Documentation

class_meta_data()

def acli.class_meta_data

(

class_name

)

Build metadata dictionary to be used by CustomCompleter class.

Parameters

class_name

Class name

Returns

Class metadata dictionary

This function inquiry command class and retrieve the meta information of its methods such as arguments and their descriptions.

interactive_shell()

def acli.interactive_shell	(		history,
			prompt,
			cmdobj,
			cmdif
	)

Implements Prompt Toolkit asynchronous shell.

Parameters

history	Prompt Toolkit file history object
prompt	Prompt string
cmdobj	Generic command shell object
cmdif	Class instance implementing CLI commands

main()

def acli.main	(		module,
			class_name,
			class_args,
			prompt,
			history_file,
			log_level
	)

Asynchronouos shell for interactive communication with servers.

Variable Documentation

log

acli.log = logging.getLogger(__name__)

parse

acli.parse = None

style

acli.style

Initial value:

=  Style.from_dict(
    {
        'pygments.comment': '#888888 bold',
        'pygments.keyword': '#ff88ff bold',
        'pygments.literal.string': '#88aaaa',
        "pygments.literal.string.doc": "#88aaaa",
        "pygments.literal.string.interpol": "bold #88aaaa",
        "pygments.literal.string.escape": "bold #88aaaa",
        "pygments.literal.string.regex": "#88aaaa",
        "pygments.literal.string.symbol": "#88aaaa",
        "pygments.literal.string.other": "#88aaaa",
        "completion-menu.completion": "bg:#008888 #ffffff",
        "completion-menu.completion.current": "bg:#00aaaa #000000",
        "scrollbar.background": "bg:#88aaaa",
        "scrollbar.button": "bg:#222222",
    }
)