orionis.console.output.var

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 VarDumper(IVarDumper): (source)

Constructor: VarDumper()

View In Hierarchy

Undocumented

Method	`__forceExit`	Terminate the program if the force exit flag is set.
Method	`__init__`	Initialize the VarDumper instance with default configuration.
Method	`__makeConsole`	Create and return a configured Console instance for output formatting.
Method	`__makePanel`	Create a Rich Panel with a pretty-printed representation of the value.
Method	`__printLine`	Print a blank line to the console if requested.
Method	`__redirectOutput`	Redirect standard output and error streams temporarily.
Method	`__resolveCallerInfo`	Resolve and set the caller's module path and line number.
Method	`__storeClonedValue`	Clone the given value using deep copy and store its type information.
Method	`expandAll`	Set whether to expand all nested data structures.
Method	`forceExit`	Set whether to terminate the program after dumping.
Method	`lineNumber`	Set the line number for header display.
Method	`maxDepth`	Set the maximum depth for nested structures.
Method	`modulePath`	Set the module path to display in the header.
Method	`print`	Print the stored values in a formatted manner and return HTML output.
Method	`redirectOutput`	Set whether to temporarily restore stdout/stderr during output.
Method	`showIndex`	Set whether to display an index number for each argument.
Method	`showTypes`	Set whether to display the type of each argument in the panel title.
Method	`toHtml`	Generate the HTML representation of the dumped output.
Method	`value`	Add a value to be dumped.
Method	`values`	Receive and store multiple values to be dumped.
Instance Variable	`__args`	Undocumented
Instance Variable	`__console`	Undocumented
Instance Variable	`__expand_all`	Undocumented
Instance Variable	`__force_exit`	Undocumented
Instance Variable	`__last_index`	Undocumented
Instance Variable	`__line_number`	Undocumented
Instance Variable	`__max_depth`	Undocumented
Instance Variable	`__module_path`	Undocumented
Instance Variable	`__original_stderr`	Undocumented
Instance Variable	`__original_stdout`	Undocumented
Instance Variable	`__redirect_output`	Undocumented
Instance Variable	`__redirected_output`	Undocumented
Instance Variable	`__show_header`	Undocumented
Instance Variable	`__show_index`	Undocumented
Instance Variable	`__show_types`	Undocumented

def __forceExit(self): (source) ¶

Terminate the program if the force exit flag is set.

If the internal force exit flag is True, terminate the program using os._exit(1) or sys.exit(1) depending on the redirect output flag.

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

def __init__(self): (source) ¶

Initialize the VarDumper instance with default configuration.

Sets up internal state for variable dumping, including display options, output formatting, and argument storage.

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

def __makeConsole(self) -> Console: (source) ¶

Create and return a configured Console instance for output formatting.

Returns
`Console`	A Console object with a custom theme for variable dumping and recording enabled.

def __makePanel(self, value: type[T], _type: str) -> Panel: (source) ¶

Create a Rich Panel with a pretty-printed representation of the value.

Notes

Uses internal configuration for indentation, expansion, and panel width.

Parameters
value:`type[T]`	Object to be pretty-printed inside the panel.
_type:`str`	Type name of the value for display in the panel title.

Returns
`Panel`	Rich Panel object displaying the formatted content.

def __printLine(self, *, insert_line: bool = False): (source) ¶

Print a blank line to the console if requested.

Notes

Prints a blank line to the standard output if insert_line is True.

Parameters
insert_line:`bool, optional`	If True, print a blank line. Default is False.

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

def __redirectOutput(self): (source) ¶

Redirect standard output and error streams temporarily.

If output redirection is enabled and not already redirected, this method saves the current stdout and stderr, then redirects them to the original system streams. If already redirected, it restores stdout and stderr to their previously saved values.

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

def __resolveCallerInfo(self): (source) ¶

Resolve and set the caller's module path and line number.

If the internal module path or line number is not set, this method uses the inspect module to retrieve the caller's frame and extract the relevant information. If the frame is unavailable, it sets default values.

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

def __storeClonedValue(self, value: type[T]): (source) ¶

Clone the given value using deep copy and store its type information.

Notes

The type information is obtained from the __name__ attribute of the value's type.

Parameters
value:`type[T]`	Value to be cloned.

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

def expandAll(self, *, expand: bool = True) -> VarDumper: (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.expandAll

Set whether to expand all nested data structures.

Parameters
expand:`bool, optional`	If True, expands all nested data structures. Default is True.

Returns
`VarDumper`	The current instance with updated expand all setting.

def forceExit(self, *, force: bool = True) -> VarDumper: (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.forceExit

Set whether to terminate the program after dumping.

Parameters
force:`bool, optional`	If True, the program will terminate after dumping. Default is True.

Returns
`VarDumper`	Returns the current instance with the updated force exit setting.

Raises
`TypeError`	If 'force' is not of type bool.

def lineNumber(self, number: int | None) -> VarDumper: (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.lineNumber

Set the line number for header display.

Parameters
number:`int or None`	Line number to display in the header.

Returns
`VarDumper`	Returns self with updated line number.

Raises
`TypeError`	If 'number' is not of type int or None.

def maxDepth(self, depth: int | None) -> VarDumper: (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.maxDepth

Set the maximum depth for nested structures.

Parameters
depth:`int or None`	Maximum depth for nested structures. None means unlimited.

Returns
`VarDumper`	Returns self with updated max depth.

Raises
`TypeError`	If 'depth' is not int or None.

def modulePath(self, path: str | None) -> VarDumper: (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.modulePath

Set the module path to display in the header.

Parameters
path:`str or None`	Module path to display in the header.

Returns
`VarDumper`	Returns the current instance with updated module path.

Raises
`TypeError`	If 'path' is not of type str or None.

def print(self, *, insert_line: bool = False): (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.print

Print the stored values in a formatted manner and return HTML output.

Optionally inserts a blank line before and after the output, resolves caller information, prints a header with module and line details, and displays each stored value in a styled panel. Handles optional output redirection and program termination.

Parameters
insert_line:`bool, optional`	If True, insert a blank line before and after the output. Default is False.

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

def redirectOutput(self, *, redirect: bool = True) -> VarDumper: (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.redirectOutput

Set whether to temporarily restore stdout/stderr during output.

Parameters
redirect:`bool, optional`	If True, temporarily restores stdout and stderr to their original streams during output. Default is True.

Returns
`VarDumper`	The current instance with the updated redirect output setting.

Raises
`TypeError`	If 'redirect' is not of type bool.

def showIndex(self, *, show: bool = True) -> VarDumper: (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.showIndex

Set whether to display an index number for each argument.

Parameters
show:`bool, optional`	If True, show an index number for each argument. Default is True.

Returns
`VarDumper`	The current instance with updated show index setting.

def showTypes(self, *, show: bool = True) -> VarDumper: (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.showTypes

Set whether to display the type of each argument in the panel title.

Parameters
show:`bool, optional`	If True, display the type of each argument in the panel title. Default is True.

Returns
`VarDumper`	The current instance with updated show types setting.

def toHtml(self, *, insert_line: bool = False) -> str: (source) ¶

overrides orionis.console.output.contracts.var_dumper.IVarDumper.toHtml

Generate the HTML representation of the dumped output.

Notes

Calls the print method to prepare the output and then exports it with a light terminal palette and inline styles, so the dump is readable and self-contained when embedded in a page. The module and line header is omitted from the HTML output.