Inheritance diagram for tty_ov.tty_ov:

Collaboration diagram for tty_ov.tty_ov:

Data Fields
int	ERR = 84

int	ERROR = ERR

int	SUCCESS = 0

	COLOUR_LIB = ColouriseOutput()

	ASK_QUESTION = AskQuestion()

dict	CONSTANTS

bool	COLOURISE_OUTPUT = True

	TTYI

Data Fields inherited from tty_ov.tty_ov.TTY
str	program_version = self.__version__

str	client_name = "(c) OpenValue"

str	program_author = "(c) Henry Letellier"

list	history = []

	prompt_history = InMemoryHistory()

int	history_index = 0

	success = success

	err = err

	error = error

bool	continue_tty_loop = True

int	current_tty_status = self.success

	colour_lib = colour_lib

	ask_question = ask_question

list	options = []

	colours = self.colour_lib.unix_colour_pallet

	tty_colours = colours

	reset_colour = None

	prompt_colour = None

	default_colour = None

	error_colour = None

	success_colour = None

	info_colour = None

str	user_input = ""

	user_session = prompt_toolkit.PromptSession()

str	input_split_char = " "

str	help_function_child_name = "help"

list	help_help_options

bool	enable_multi_command_help = True

	help_title_colour = None

	help_command_colour = None

	help_description_colour = None

	colourise_output = colourise_output

	env_term_colour = None

	env_shell_colour = None

	env_definition_colour = None

str	session_name = "main"

	session_name_colour = None

str	old_pwd = os.getcwd()

str	home = None

	ls = HLLs(self.success, self.error)

str	master_session = "main"

str	command_seperator_token = "@#"

str	comment_token = "--"

	pipe_input = None

list	auto_complete_list = []

int	auto_complete_index = 0

str	auto_complete_usr_input = ""

str	auto_complete_default_usr_input = ""

str	command_description_token_inner = "desc"

str	colourise_output = "")

str	current_tty_status = "prompt":

bool	current_tty_status = True)

list	history_index = self.history[self.history_index]

bool	options = True

Additional Inherited Members
Public Member Functions inherited from tty_ov.tty_ov.TTY
None	__init__ (self, int err, int error, int success, ColouriseOutput colour_lib, AskQuestion ask_question, Dict colours, bool colourise_output=True)

None	print_on_tty (self, str colour, str string)

int	run_external_command (self, str command)

str	list_to_str (self, List[any] hl_list, str join=" ")

int	version (self, List args)

int	show_history (self, List args)

int	process_session_name (self, List args)

int	author (self, List args)

int	client (self, List args)

int	env (self, List args)

None	session_admin (self)

int	env_plus_plus (self, List args)

int	setenv (self, List args)

int	unset_single_variable (self, str argument)

int	ask_for_env_to_unset (self)

int	unsetenv (self, List args)

None	display_status_code (self, List args)

None	function_help (self, str function_name, str description)

None	help_help (self)

None	help_prompt (self)

int	process_help_call (self, List args)

int	help (self, List args)

int	pwd (self, List args)

str	sanitize_directory_path (self, str dir_name)

int	create_directories (self, str path, bool show_if_created=True)

int	make_directory (self, List args)

int	check_file_path (self, str file_path)

int	create_a_file (self, str filename)

int	touch (self, List arg)

int	remove_a_directory (self, str directory_path)

int	remove_directory (self, List args)

int	remove_an_item (self, str path)

int	remove_file (self, List args)

int	cd_access_directory (self, str path)

int	cd_go_further_than_home (self, str path)

int	cd_rollback (self, str path)

int	change_directory (self, List args)

int	exit (self, List args)

int	kill (self, List args)

None	display_status_in_prompt (self)

None	create_key_prompt_bindings (self)

str	process_key_inputs (self)

None	display_prompt (self)

str	get_current_folder (self)

int	bind_ls (self, List args)

int	hello_world (self, List args)

int	run_command (self, List args)

bool	check_if_admin_for_windows (self)

bool	is_admin (self)

int	run_as_windows_admin (self, str file)

int	check_admin (self, List args)

int	save_to_file (self, str data, str filepath)

int	run_as_admin (self, List args)

bool	is_exactly_in_string (self, str string1, str string2)

None	process_input (self)

None	assing_colours (self)

int	command_seperator (self, List args)

int	update_comment_token (self, List args)

None	title (self)

None	get_the_home_path (self)

None	commands_to_auto_complete (self)

None	load_basics (self)

int	unload_basics (self)

int	import_functions_into_shell (self, List[Dict[str, any]] functions)

int	remove_function_from_options (self, Dict[str, any] function)

int	remove_functions_from_shell (self, List[Dict[str, any]] functions)

None	goodbye_message (self)

None	run_complex_input (self, List[str] complex_input)

None	process_complex_input (self, List usr_input)

None	process_if_arg_input (self)

str	clean_string (self, str input_string)

None	process_if_pipe_input (self)

int	mainloop (self, session_name="main")

Protected Member Functions inherited from tty_ov.tty_ov.TTY
int	_set_file_content (self, str file_path, str content, str mode="w", str encoding="utf-8", str newline="\n")

Detailed Description

 A name rebind to for those who whish to follow the library name

Definition at line 45 of file __init__.py.

Field Documentation

◆ ASK_QUESTION

tty_ov.tty_ov.ASK_QUESTION = AskQuestion()

Definition at line 2042 of file tty_ov.py.

◆ COLOUR_LIB

tty_ov.tty_ov.COLOUR_LIB = ColouriseOutput()

Definition at line 2041 of file tty_ov.py.

◆ COLOURISE_OUTPUT

bool tty_ov.tty_ov.COLOURISE_OUTPUT = True

Definition at line 2058 of file tty_ov.py.

◆ CONSTANTS

dict tty_ov.tty_ov.CONSTANTS

Initial value:

=  {
        "default": "0A",
        "prompt": "0B",
        "error": "0C",
        "success": "03",
        "info": "0D",
        "reset": "rr",
        "help_title_colour": "0E",
        "help_command_colour": "0A",
        "help_description_colour": "0F",
        "env_term_colour": "09",
        "env_shell_colour": "03",
        "env_definition_colour": "0B",
        "session_name_colour": "0D"
    }

Definition at line 2043 of file tty_ov.py.

◆ ERR

int tty_ov.tty_ov.ERR = 84

Definition at line 2038 of file tty_ov.py.

◆ ERROR

int tty_ov.tty_ov.ERROR = ERR

Definition at line 2039 of file tty_ov.py.

◆ SUCCESS

int tty_ov.tty_ov.SUCCESS = 0

Definition at line 2040 of file tty_ov.py.

◆ TTYI

tty_ov.tty_ov.TTYI