ORIONIS API REFERENCE

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

orionis.console.output.contracts.var_dumper.IVarDumper

class documentation

class IVarDumper(ABC): (source)

Known subclasses: orionis.console.output.var_dumper.VarDumper

View In Hierarchy

Undocumented

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.
def expandAll(self, *, expand: bool = True) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Set whether to expand all nested data structures.

Parameters
expand:bool, optionalIf True, expands all nested data structures. Default is True.
Returns
VarDumperThe current instance with updated expand all setting.
def forceExit(self, *, force: bool = True) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Set whether to terminate the program after dumping.

Parameters
force:bool, optionalIf True, the program will terminate after dumping. Default is True.
Returns
IVarDumperReturns the current instance with the updated force exit setting.
Raises
TypeErrorIf 'force' is not of type bool.
def lineNumber(self, number: int | None) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Set the line number for header display.

Parameters
number:int or NoneLine number to display in the header.
Returns
IVarDumperReturns self with updated line number.
Raises
TypeErrorIf 'number' is not of type int or None.
def maxDepth(self, depth: int | None) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Set the maximum depth for nested structures.

Parameters
depth:int or NoneMaximum depth for nested structures. None means unlimited.
Returns
IVarDumperReturns self with updated max depth.
Raises
TypeErrorIf 'depth' is not int or None.
def modulePath(self, path: str | None) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Set the module path to display in the header.

Parameters
path:str or NoneModule path to display in the header.
Returns
IVarDumperReturns the current instance with updated module path.
Raises
TypeErrorIf 'path' is not of type str or None.
def print(self, *, insert_line: bool = False): (source)
overridden in orionis.console.output.var_dumper.VarDumper

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, optionalIf True, insert a blank line before and after the output. Default is False.
Returns
NoneThis method does not return any value.
def redirectOutput(self, *, redirect: bool = True) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Set whether to temporarily restore stdout/stderr during output.

Parameters
redirect:bool, optionalIf True, temporarily restores stdout and stderr to their original streams during output. Default is True.
Returns
IVarDumperThe current instance with the updated redirect output setting.
Raises
TypeErrorIf 'redirect' is not of type bool.
def showIndex(self, *, show: bool = True) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Set whether to display an index number for each argument.

Parameters
show:bool, optionalIf True, show an index number for each argument. Default is True.
Returns
IVarDumperThe current instance with updated show index setting.
def showTypes(self, *, show: bool = True) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

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

Parameters
show:bool, optionalIf True, display the type of each argument in the panel title. Default is True.
Returns
IVarDumperThe current instance with updated show types setting.
def toHtml(self, *, insert_line: bool = False) -> str: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Generate the HTML representation of the dumped output.

Notes

Calls the print method to prepare the output and then exports it as HTML.

Parameters
insert_line:bool, optionalIf True, insert a blank line before and after the output. Default is False.
Returns
strHTML string containing the formatted dumped output.
def value(self, value: type[T]) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Add a value to be dumped.

Notes

The value is deep-copied and stored internally for later output.

Parameters
value:type[T]The value to be stored for dumping.
Returns
IVarDumperReturns the current instance for method chaining.
def values(self, *args: tuple | list) -> IVarDumper: (source)
overridden in orionis.console.output.var_dumper.VarDumper

Receive and store multiple values to be dumped.

Parameters
*args:tupleValues to be dumped.
Returns
IVarDumperReturns the current instance for method chaining.
Raises
TypeErrorIf 'args' is not of type tuple or list.