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

Declare explicit state serialization and trusted job registration.

Method decode Restore a registered job without constructing dependencies.
Method decodeEnvelope Validate a stored envelope before execution.
Method encode Serialize only the job's declared persistent fields.
Method encodeEnvelope Encode a versioned immutable envelope.
Method register Register an application-trusted concrete job class.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
def decode(self, identity: str, payload: bytes) -> BaseJob: (source)

Restore a registered job without constructing dependencies.

Parameters
identity:strIdentity present in the trusted registry.
payload:bytesSerialized persistent state.
Returns
orionis.queues.BaseJobJob whose handle method can receive DI services.
def decodeEnvelope(self, payload: bytes) -> JobEnvelope: (source)

Validate a stored envelope before execution.

Parameters
payload:bytesUntrusted JSON wire data.
Returns
orionis.queues.JobEnvelopeValidated immutable execution data.
def encode(self, job: BaseJob) -> tuple[str, bytes]: (source)

Serialize only the job's declared persistent fields.

Parameters
job:orionis.queues.BaseJobApplication job instance.
Returns
tuple[str, bytes]Stable identity and MessagePack state.
def encodeEnvelope(self, envelope: JobEnvelope) -> bytes: (source)

Encode a versioned immutable envelope.

Parameters
envelope:orionis.queues.JobEnvelopeImmutable data to persist.
Returns
bytesThe JSON wire representation.
def register(self, job_type: type[BaseJob]): (source)

Register an application-trusted concrete job class.

Parameters
job_type:type[orionis.queues.BaseJob]Class supplied by trusted application code.
Returns
NoneCache the class and its persistent field metadata.
__slots__: tuple = (source)

Declare that this class introduces no additional instance slots.