orionis.failure.contracts.handler.IBaseExceptionHandler

ORIONIS API REFERENCE

Modules Classes Names

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 IBaseExceptionHandler(ABC): (source)

Known subclasses: orionis.failure.base.BaseExceptionHandler

View In Hierarchy

Undocumented

Async Method	`handleCLI`	Render the exception message for CLI output.
Async Method	`handleHTTP`	Handle the exception for HTTP responses.
Method	`isExceptionIgnored`	Determine whether the given exception should be ignored.
Async Method	`report`	Report or log an exception.
Method	`toThrowable`	Convert an exception to a structured Throwable object.

@abstractmethod

async def handleCLI(self, exception: BaseException, console: IConsole): (source) ¶

overridden in orionis.failure.base.BaseExceptionHandler

Render the exception message for CLI output.

Parameters
exception:`BaseException`	The exception instance that was caught.
console:`IConsole`	The console instance for output.

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

@abstractmethod

async def handleHTTP(self, exception: BaseException, request: Request | TransportAdapter) -> Response | None: (source) ¶

overridden in orionis.failure.base.BaseExceptionHandler

Handle the exception for HTTP responses.

Parameters
exception:`BaseException`	The exception instance that was caught.
request:`Request \| TransportAdapter`	The HTTP request instance or transport adapter that was being processed.

Returns
`Response \| None`	The HTTP response if handled, otherwise None.

@abstractmethod

def isExceptionIgnored(self, exception: BaseException) -> bool: (source) ¶

overridden in orionis.failure.base.BaseExceptionHandler

Determine whether the given exception should be ignored.

Parameters
exception:`BaseException`	The exception instance to check.

Returns
`bool`	True if the exception should be ignored, otherwise False.

@abstractmethod

async def report(self, exception: BaseException, log: ILogger) -> Throwable | None: (source) ¶

overridden in orionis.failure.base.BaseExceptionHandler

Report or log an exception.

Parameters
exception:`BaseException`	The exception instance that was caught.
log:`ILogger`	The logger instance for error reporting.

Returns
`Throwable or None`	The structured Throwable object if reported, otherwise None.

@abstractmethod

def toThrowable(self, exception: BaseException) -> Throwable: (source) ¶

overridden in orionis.failure.base.BaseExceptionHandler

Convert an exception to a structured Throwable object.

Parameters
exception:`BaseException`	Exception instance to be converted.

Returns
`Throwable`	Structured Throwable object containing class, message, arguments, and traceback.