orionis.queues.contracts.serializer.IJobSerializer

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

Known subclasses: orionis.queues.serializer.JobSerializer

View In Hierarchy

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__`	Undocumented

@abstractmethod

def decode(self, identity: str, payload: bytes) -> BaseJob: (source) ¶

overridden in orionis.queues.serializer.JobSerializer

Restore a registered job without constructing dependencies.

Parameters
identity:`str`	Identity present in the trusted registry.
payload:`bytes`	Serialized persistent state.

Returns
`BaseJob`	Job whose handle method can receive DI services.

@abstractmethod

def decodeEnvelope(self, payload: bytes) -> JobEnvelope: (source) ¶

overridden in orionis.queues.serializer.JobSerializer

Validate a stored envelope before execution.

Parameters
payload:`bytes`	Untrusted JSON wire data.

Returns
`JobEnvelope`	Validated immutable execution data.

@abstractmethod

def encode(self, job: BaseJob) -> tuple[str, bytes]: (source) ¶

overridden in orionis.queues.serializer.JobSerializer

Serialize only the job's declared persistent fields.

Parameters
job:`BaseJob`	Application job instance.

Returns
`tuple[str, bytes]`	Stable identity and MessagePack state.

@abstractmethod

def encodeEnvelope(self, envelope: JobEnvelope) -> bytes: (source) ¶

overridden in orionis.queues.serializer.JobSerializer

Encode a versioned immutable envelope.

Parameters
envelope:`JobEnvelope`	Immutable data to persist.

Returns
`bytes`	The JSON wire representation.

@abstractmethod

def register(self, job_type: type[BaseJob]): (source) ¶

overridden in orionis.queues.serializer.JobSerializer

Register an application-trusted concrete job class.

Parameters
job_type:`type[BaseJob]`	Class supplied by trusted application code.

Returns
`None`	Cache the class and its persistent field metadata.

__slots__: tuple = (source) ¶

overridden in orionis.queues.serializer.JobSerializer

Undocumented