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

Define the contract for dumper implementations.

Static Method dd Dump variables and stop the current execution context.
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 and stop the current execution context.

Notes

Debug HTTP requests receive an HTML response without terminating the server. Source filename and line are captured at the dump call, before HTTP exception handling. Console calls retain their termination behavior.

Parameters
*args:typing.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, optionalSource path for the header. HTTP defaults to the caller's filename.
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.
Raises
RuntimeErrorIf HTTP dumping is attempted outside debug request dispatch.
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:typing.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.