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.
class IVarDumper(ABC): (source)
Known subclasses: orionis.console.output.var_dumper.VarDumper
Define the contract for var dumper implementations.
| Method | expand |
Set whether to expand all nested data structures. |
| Method | force |
Set whether to terminate the program after dumping. |
| Method | line |
Set the line number for header display. |
| Method | max |
Set the maximum depth for nested structures. |
| Method | module |
Set the module path to display in the header. |
| Method | print |
Print the stored values to the console in a formatted manner. |
| Method | redirect |
Set whether to temporarily restore stdout/stderr during output. |
| Method | show |
Set whether to display an index number for each argument. |
| Method | show |
Set whether to display the type of each argument in the panel title. |
| Method | to |
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. |
orionis.console.output.var_dumper.VarDumperSet whether to expand all nested data structures.
| Parameters | |
expand:bool, optional | If True, expands all nested data structures. Default is True. |
| Returns | |
orionis.console.output.contracts.var_dumper.IVarDumper | The current instance with updated expand all setting. |
orionis.console.output.var_dumper.VarDumperSet whether to terminate the program after dumping.
| Parameters | |
force:bool, optional | If True, the program will terminate after dumping. Default is True. |
| Returns | |
orionis.console.output.contracts.var_dumper.IVarDumper | Returns the current instance with the updated force exit setting. |
| Raises | |
TypeError | If 'force' is not of type bool. |
orionis.console.output.var_dumper.VarDumperSet the line number for header display.
| Parameters | |
number:int or None | Line number to display in the header. |
| Returns | |
orionis.console.output.contracts.var_dumper.IVarDumper | Returns self with updated line number. |
| Raises | |
TypeError | If 'number' is not of type int or None. |
orionis.console.output.var_dumper.VarDumperSet the maximum depth for nested structures.
| Parameters | |
depth:int or None | Maximum depth for nested structures. None means unlimited. |
| Returns | |
orionis.console.output.contracts.var_dumper.IVarDumper | Returns self with updated max depth. |
| Raises | |
TypeError | If 'depth' is not int or None. |
orionis.console.output.var_dumper.VarDumperSet the module path to display in the header.
| Parameters | |
path:str or None | Module path to display in the header. |
| Returns | |
orionis.console.output.contracts.var_dumper.IVarDumper | Returns the current instance with updated module path. |
| Raises | |
TypeError | If 'path' is not of type str or None. |
orionis.console.output.var_dumper.VarDumperPrint the stored values to the console in a formatted manner.
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 | |
insertbool, optional | If True, insert a blank line before and after the output. Default is False. |
| Returns | |
None | This method does not return any value. |
orionis.console.output.var_dumper.VarDumperSet 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 | |
orionis.console.output.contracts.var_dumper.IVarDumper | The current instance with the updated redirect output setting. |
| Raises | |
TypeError | If 'redirect' is not of type bool. |
orionis.console.output.var_dumper.VarDumperSet 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 | |
orionis.console.output.contracts.var_dumper.IVarDumper | The current instance with updated show index setting. |
orionis.console.output.var_dumper.VarDumperSet 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 | |
orionis.console.output.contracts.var_dumper.IVarDumper | The current instance with updated show types setting. |
orionis.console.output.var_dumper.VarDumperGenerate the HTML representation of the dumped output.
Notes
Render to an isolated in-memory console without writing to standard output, redirecting streams, or terminating execution. Export a self-contained fragment with native HTML panels and the framework's diagnostic palette. Each panel identifies the source filename and line, using configured values or the first HTML export's caller. Do not alter the terminal's module header or index counter.
| Parameters | |
insertbool, optional | If True, insert a blank line before and after the output. Default is False. |
| Returns | |
str | HTML string containing the formatted dumped output. |
orionis.console.output.var_dumper.VarDumperAdd a value to be dumped.
Notes
The value is deep-copied and stored internally for later output.
| Parameters | |
value:type[orionis.console.output.contracts.var_dumper.T] | The value to be stored for dumping. |
| Returns | |
orionis.console.output.contracts.var_dumper.IVarDumper | Returns the current instance for method chaining. |
orionis.console.output.var_dumper.VarDumperReceive and store multiple values to be dumped.
| Parameters | |
*args:tuple | Values to be dumped. |
| Returns | |
orionis.console.output.contracts.var_dumper.IVarDumper | Returns the current instance for method chaining. |
| Raises | |
TypeError | If 'args' is not of type tuple or list. |