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.

class documentation

class IDumper(ABC): (source)

Known subclasses: orionis.console.Dumper

View In Hierarchy

Undocumented

Static Method dd Dump variables to the console and terminate execution.
Static Method dump Dump variables to the console for debugging.
def dd(*args: tuple[Any], show_types: bool = False, show_index: bool = False, expand_all: bool = True, max_depth: int | None = None, module_path: str | None = None, line_number: int | None = None, redirect_output: bool = False, insert_line: bool = False): (source)

Dump variables to the console and terminate execution.

Parameters
*args:AnyVariables to dump.
show_types:bool, optionalWhether to show variable types. Default is False.
show_index:bool, optionalWhether to show index for each variable. Default is False.
expand_all:bool, optionalWhether to expand all nested structures. Default is True.
max_depth:int or None, optionalMaximum depth for expansion. Default is None.
module_path:str or None, optionalPath of the calling module. Default is None.
line_number:int or None, optionalLine number of the call. Default is None.
redirect_output:bool, optionalWhether to redirect output. Default is False.
insert_line:bool, optionalWhether to insert a separating line before output. Default is False.
Returns
NoneThis method does not return a value.
def dump(*args: tuple[Any], show_types: bool = False, show_index: bool = False, expand_all: bool = True, max_depth: int | None = None, module_path: str | None = None, line_number: int | None = None, redirect_output: bool = False, insert_line: bool = False): (source)

Dump variables to the console for debugging.

Parameters
*args:AnyVariables to dump.
show_types:bool, optionalWhether to show variable types. Default is False.
show_index:bool, optionalWhether to show index for each variable. Default is False.
expand_all:bool, optionalWhether to expand all nested structures. Default is True.
max_depth:int or None, optionalMaximum depth for expansion. Default is None.
module_path:str or None, optionalPath of the calling module. Default is None.
line_number:int or None, optionalLine number of the call. Default is None.
redirect_output:bool, optionalWhether to redirect output. Default is False.
insert_line:bool, optionalWhether to insert a separating line before output. Default is False.
Returns
NoneThis method does not return a value.