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
class IJobSerializer(ABC): (source)
Known subclasses: orionis.queues.serializer.JobSerializer
Declare explicit state serialization and trusted job registration.
| Method | decode |
Restore a registered job without constructing dependencies. |
| Method | decode |
Validate a stored envelope before execution. |
| Method | encode |
Serialize only the job's declared persistent fields. |
| Method | encode |
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. |
overridden in
orionis.queues.serializer.JobSerializerRestore a registered job without constructing dependencies.
| Parameters | |
identity:str | Identity present in the trusted registry. |
payload:bytes | Serialized persistent state. |
| Returns | |
orionis.queues.BaseJob | Job whose handle method can receive DI services. |
overridden in
orionis.queues.serializer.JobSerializerValidate a stored envelope before execution.
| Parameters | |
payload:bytes | Untrusted JSON wire data. |
| Returns | |
orionis.queues.JobEnvelope | Validated immutable execution data. |
overridden in
orionis.queues.serializer.JobSerializerSerialize only the job's declared persistent fields.
| Parameters | |
job:orionis.queues.BaseJob | Application job instance. |
| Returns | |
tuple[str, bytes] | Stable identity and MessagePack state. |
overridden in
orionis.queues.serializer.JobSerializerEncode a versioned immutable envelope.
| Parameters | |
envelope:orionis.queues.JobEnvelope | Immutable data to persist. |
| Returns | |
bytes | The JSON wire representation. |
overridden in
orionis.queues.serializer.JobSerializerRegister an application-trusted concrete job class.
| Parameters | |
jobtype[orionis.queues.BaseJob] | Class supplied by trusted application code. |
| Returns | |
None | Cache the class and its persistent field metadata. |
overridden in
orionis.queues.serializer.JobSerializerDeclare that this class introduces no additional instance slots.