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

Represent a task execution event with scheduling and result information.

Method __post_init__ Initialize the TaskEvent instance after dataclass creation.
Class Variable description Description produced by field.
Instance Variable code Event status or result code.
Instance Variable exception Exception raised during task execution.
Instance Variable jobstore Storage backend for the job.
Instance Variable retval Return value from task execution.
Instance Variable scheduled_run_time Specific scheduled execution time.
Instance Variable scheduled_run_times Collection of scheduled execution times.
Instance Variable signature Task signature identifier.
Instance Variable traceback Exception traceback information.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
def __post_init__(self): (source)

Initialize the TaskEvent instance after dataclass creation.

Map the event code to a human-readable message and set it as the description.

Parameters
self:orionis.console.entities.TaskEventThe instance of TaskEvent being initialized.
Returns
NoneThis method does not return a value.
description: str = (source)

Description produced by field.

Event status or result code.

exception: typing.Any | None, default None = (source)

Exception raised during task execution.

jobstore: str, default "memory" = (source)

Storage backend for the job.

retval: typing.Any | None, default None = (source)

Return value from task execution.

scheduled_run_time: typing.Any | None, default None = (source)

Specific scheduled execution time.

scheduled_run_times: typing.Any | None, default None = (source)

Collection of scheduled execution times.

signature: str = (source)

Task signature identifier.

traceback: typing.Any | None, default None = (source)

Exception traceback information.