orionis.console.output.contracts.console.IConsole

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class IConsole(ABC): (source)

Known subclasses: orionis.console.Console

View In Hierarchy

Undocumented

Method	`anticipate`	Provide autocomplete suggestions based on user input.
Method	`ask`	Prompt user for input and return the response.
Method	`choice`	Prompt user to select an option from a list.
Method	`clear`	Clear the console screen.
Method	`clearLine`	Clear the current line in the console.
Method	`confirm`	Ask for confirmation and return True or False.
Method	`dump`	Dump variable information to the console with formatting options.
Method	`error`	Print an error message with a red background.
Method	`exception`	Print exception details and stack trace.
Method	`exitError`	Exit the program with an error message.
Method	`exitSuccess`	Exit the program with a success message.
Method	`fail`	Print a failure message with a red background.
Method	`info`	Print an informational message with a blue background.
Method	`line`	Print a horizontal line in the console.
Method	`newLine`	Print multiple new lines.
Method	`secret`	Prompt for hidden input using the provided question.
Async Method	`sleep`	Asynchronously sleep for a specified number of seconds.
Method	`success`	Print a success message with a green background.
Method	`table`	Print a formatted table with bold headers and box-drawing borders.
Method	`textError`	Print an error message in red.
Method	`textErrorBold`	Print a bold error message in red.
Method	`textInfo`	Print an informational message in blue.
Method	`textInfoBold`	Print a bold informational message in blue.
Method	`textMuted`	Print a muted (gray) message.
Method	`textMutedBold`	Print a bold muted (gray) message.
Method	`textSuccess`	Print a success message in green.
Method	`textSuccessBold`	Print a bold success message in green.
Method	`textUnderline`	Print an underlined message.
Method	`textWarning`	Print a warning message in yellow.
Method	`textWarningBold`	Print a bold warning message in yellow.
Method	`warning`	Print a warning message with a yellow background.
Method	`write`	Write values to the output stream and move to the next line.
Method	`writeLine`	Print a message and move to the next line.
Property	`progressBar`	Get a new instance of the ProgressBar class.

@abstractmethod

def anticipate(self, question: str, options: list, default: None = None) -> str: (source) ¶

overridden in orionis.console.Console

Provide autocomplete suggestions based on user input.

Notes

Match the beginning of user input with available options. Return the first match, or default/user input if no match.

Parameters
question:`str`	Prompt for the user.
options:`list of str`	List of possible autocomplete options.
default:`str, optional`	Default value if no match is found. Defaults to None.

Returns
`str`	Chosen option if matched, otherwise default or user input.

@abstractmethod

def ask(self, question: str) -> str: (source) ¶

overridden in orionis.console.Console

Prompt user for input and return the response.

Parameters
question:`str`	Message to display to the user.

Returns
`str`	User's input as a string.

@abstractmethod

def choice(self, question: str, choices: list, default_index: int = 0) -> str: (source) ¶

overridden in orionis.console.Console

Prompt user to select an option from a list.

Notes

Display a numbered list of choices and prompt the user to select one. Re-prompt until a valid selection is made.

Parameters
question:`str`	Prompt message for the user.
choices:`list of str`	List of available choices.
default_index:`int, optional`	Index of the default choice (zero-based). Default is 0.

Returns
`str`	Selected choice from the list.

Raises
`ValueError`	If `choices` is empty or `default_index` is out of range.

@abstractmethod

def clear(self): (source) ¶

overridden in orionis.console.Console

Clear the console screen.

Notes

Emite códigos de escape ANSI para limpiar la pantalla y mover el cursor al origen, evitando el overhead de lanzar un subproceso.

Returns
`None`	This method does not return any value.

@abstractmethod

def clearLine(self): (source) ¶

overridden in orionis.console.Console

Clear the current line in the console.

Notes

Move the cursor to the start of the line and overwrite it with a space. Return the cursor to the beginning.

Returns
`None`	This method does not return any value.

@abstractmethod

def confirm(self, question: str, *, default: bool = False) -> bool: (source) ¶

overridden in orionis.console.Console

Ask for confirmation and return True or False.

Parameters
question:`str`	Confirmation prompt for the user.
default:`bool, optional`	Default response if user presses Enter. False means 'No'.

Returns
`bool`	True if user enters 'Y' or 'YES', False otherwise.

@abstractmethod

def dump(self, *args: type[Any], show_types: bool = True, show_index: bool = False, expand_all: bool = True, max_depth: int | None = None, module_path: str | None = None, line_number: int | None = None, force_exit: bool = False, redirect_output: bool = False, insert_line: bool = False): (source) ¶

overridden in orionis.console.Console

Dump variable information to the console with formatting options.

Parameters
*args:`Any`	Variables to be dumped.
show_types:`bool, optional`	Show variable types (default is True).
show_index:`bool, optional`	Show index for collections (default is False).
expand_all:`bool, optional`	Expand all nested structures (default is True).
max_depth:`int or None, optional`	Maximum depth to expand (default is None).
module_path:`str or None, optional`	Path of the module (default is None).
line_number:`int or None, optional`	Line number for context (default is None).
force_exit:`bool, optional`	Force program exit after dump (default is False).
redirect_output:`bool, optional`	Redirect output to file or stream (default is False).
insert_line:`bool, optional`	Insert a line after output (default is False).

Returns
`None`	This method does not return any value.

@abstractmethod

def error(self, message: str, *, timestamp: bool = True): (source) ¶

overridden in orionis.console.Console

Print an error message with a red background.

Notes

Uses ANSI escape codes for error style.

Parameters
message:`str`	Error message to print.
timestamp:`bool, optional`	If True, include a timestamp (default is True).

Returns
`None`	This method does not return any value.

@abstractmethod

def exception(self, exception: Exception): (source) ¶

overridden in orionis.console.Console

Print exception details and stack trace.

Notes

Shows exception type, message, and stack trace using rich formatting.

Parameters
exception:`Exception`	Exception to display.

Returns
`None`	This method does not return any value.

@abstractmethod

def exitError(self, message: str | None = None): (source) ¶

overridden in orionis.console.Console

Exit the program with an error message.

Parameters
message:`str, optional`	Error message to print before exiting.

Returns
`None`	This method does not return any value.

@abstractmethod

def exitSuccess(self, message: str | None = None): (source) ¶

overridden in orionis.console.Console

Exit the program with a success message.

Parameters
message:`str or None, optional`	Success message to print before exiting.

Returns
`None`	This method does not return any value.

@abstractmethod

def fail(self, message: str, *, timestamp: bool = True): (source) ¶

overridden in orionis.console.Console

Print a failure message with a red background.

Notes

Uses ANSI escape codes for fail style.

Parameters
message:`str`	Failure message to print.
timestamp:`bool, optional`	If True, include a timestamp (default is True).

Returns
`None`	This method does not return any value.

@abstractmethod

def info(self, message: str, *, timestamp: bool = True): (source) ¶

overridden in orionis.console.Console

Print an informational message with a blue background.

Parameters
message:`str`	Informational message to print.
timestamp:`bool, optional`	If True, include a timestamp (default is True).

Returns
`None`	This method does not return any value.

@abstractmethod

def line(self): (source) ¶

overridden in orionis.console.Console

Print a horizontal line in the console.

Notes

Outputs a newline character as a visual separator.

Returns
`None`	This method does not return any value.

@abstractmethod

def newLine(self, count: int = 1): (source) ¶

overridden in orionis.console.Console

Print multiple new lines.

Parameters
count:`int, optional`	Number of new lines to print (default is 1).

Returns
`None`	This method does not return any value.

Raises
`ValueError`	If count is less than or equal to 0.

@abstractmethod

def secret(self, question: str) -> str: (source) ¶

overridden in orionis.console.Console

Prompt for hidden input using the provided question.

Notes

Uses getpass to hide input, suitable for passwords.

Parameters
question:`str`	Prompt message for the user.

Returns
`str`	User's hidden input as a string.

@abstractmethod

async def sleep(self, seconds: float): (source) ¶

overridden in orionis.console.Console

Asynchronously sleep for a specified number of seconds.

Parameters
seconds:`float`	Number of seconds to sleep.

Returns
`None`	This method does not return any value.

@abstractmethod

def success(self, message: str, *, timestamp: bool = True): (source) ¶

overridden in orionis.console.Console

Print a success message with a green background.

Parameters
message:`str`	Success message to print.
timestamp:`bool, optional`	If True, include a timestamp (default is True).

Returns
`None`	This method does not return any value.

@abstractmethod

def table(self, headers: list, rows: list): (source) ¶

overridden in orionis.console.Console

Print a formatted table with bold headers and box-drawing borders.

Notes

Adjust column widths dynamically and use bold for headers.

Parameters
headers:`list of str`	Column headers for the table.
rows:`list of list of str`	Table rows, each as a list of column values.

Returns
`None`	This method does not return any value.

Raises
`ValueError`	If headers or rows are empty.

@abstractmethod

def textError(self, message: str): (source) ¶

overridden in orionis.console.Console

Print an error message in red.

Notes

Uses ANSI escape codes for error style.

Parameters
message:`str`	Error message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textErrorBold(self, message: str): (source) ¶

overridden in orionis.console.Console

Print a bold error message in red.

Notes

Uses ANSI escape codes for bold error style.

Parameters
message:`str`	Error message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textInfo(self, message: str): (source) ¶

overridden in orionis.console.Console

Print an informational message in blue.

Parameters
message:`str`	Informational message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textInfoBold(self, message: str): (source) ¶

overridden in orionis.console.Console

Print a bold informational message in blue.

Parameters
message:`str`	Informational message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textMuted(self, message: str): (source) ¶

overridden in orionis.console.Console

Print a muted (gray) message.

Notes

Uses ANSI escape codes for muted style.

Parameters
message:`str`	Message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textMutedBold(self, message: str): (source) ¶

overridden in orionis.console.Console

Print a bold muted (gray) message.

Notes

Uses ANSI escape codes for bold muted style.

Parameters
message:`str`	Message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textSuccess(self, message: str): (source) ¶

overridden in orionis.console.Console

Print a success message in green.

Parameters
message:`str`	Success message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textSuccessBold(self, message: str): (source) ¶

overridden in orionis.console.Console

Print a bold success message in green.

Parameters
message:`str`	Success message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textUnderline(self, message: str): (source) ¶

overridden in orionis.console.Console

Print an underlined message.

Notes

Uses ANSI escape codes for underline style.

Parameters
message:`str`	Message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textWarning(self, message: str): (source) ¶

overridden in orionis.console.Console

Print a warning message in yellow.

Notes

Uses ANSI escape codes for warning style.

Parameters
message:`str`	Warning message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def textWarningBold(self, message: str): (source) ¶

overridden in orionis.console.Console

Print a bold warning message in yellow.

Notes

Uses ANSI escape codes for bold warning style.

Parameters
message:`str`	Warning message to print.

Returns
`None`	This method does not return any value.

@abstractmethod

def warning(self, message: str, *, timestamp: bool = True): (source) ¶

overridden in orionis.console.Console

Print a warning message with a yellow background.

Notes

Uses ANSI escape codes for warning style.

Parameters
message:`str`	Warning message to print.
timestamp:`bool, optional`	If True, include a timestamp (default is True).

Returns
`None`	This method does not return any value.

@abstractmethod

def write(self, *values: object, sep: str | None = ' ', end: str | None = '\n', file: SupportsWrite[str] | None = None, flush: bool = False): (source) ¶

overridden in orionis.console.Console

Write values to the output stream and move to the next line.

Parameters
*values:`object`	Values to print.
sep:`str \| None, optional`	Separator between values. Defaults to " ".
end:`str \| None, optional`	String appended after the last value. Defaults to "n".
file:`SupportsWrite[str] \| None, optional`	Output stream. Defaults to sys.stdout.
flush:`bool, optional`	Whether to forcibly flush the stream. Defaults to False.

Returns
`None`	This method prints values and returns None.

@abstractmethod

def writeLine(self, message: str): (source) ¶

overridden in orionis.console.Console

Print a message and move to the next line.

Parameters
message:`str`	Message to print.

Returns
`None`	This method does not return any value.

@property
@abstractmethod

progressBar: IProgressBar = (source) ¶

overridden in orionis.console.Console

Get a new instance of the ProgressBar class.

Returns
`IProgressBar`	A new instance of the ProgressBar class.