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.

module documentation

Undocumented

Function _assert_declaration Reject invalid synchronous declarations without leaking coroutines.
Function _is_mailable_class Check whether a value is a Mailable subclass.
Async Function _run_callback Run one configurator exactly once and await an asynchronous result.
def _assert_declaration(value: object, expected: type, label: str): (source)

Reject invalid synchronous declarations without leaking coroutines.

Parameters
value:objectDeclaration result.
expected:typeRequired runtime type.
label:strDeclaration method or field name.
Returns
NoneAccept only the required type.
Raises
MailCompositionExceptionIf the declared value violates its synchronous contract.
def _is_mailable_class(value: object) -> TypeGuard[type[Mailable]]: (source)

Check whether a value is a Mailable subclass.

Parameters
value:objectValue to inspect.
Returns
boolWhether value is a class derived from Mailable.
async def _run_callback(callback: object, message: Message): (source)

Run one configurator exactly once and await an asynchronous result.

Parameters
callback:objectFunction, method, or callable object supplied by the caller.
message:MessageConfigurator exclusive to the current operation.
Returns
NoneApply the callback mutations to the supplied message.
Raises
MailCompositionExceptionIf the callback is not callable, fails, or returns another value.