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

Write a runtime-visible maintenance state for HTTP workers.

Method handle Atomically update the state periodically read by HTTP workers.
Class Variable state State selected by the maintenance-mode command.
Class Variable status_message Console message describing the resulting maintenance status.
Class Variable timestamps Timestamps flag used by MaintenanceModeCommand.
def handle(self, app: IApplication, console: Console) -> int: (source)

Atomically update the state periodically read by HTTP workers.

Parameters
app:orionis.IApplicationApplication providing the framework storage directory.
console:orionis.console.ConsoleConsole used to report the state change.
Returns
intZero when the state is written; one when the write fails.
status_message: ClassVar[str] = (source)

Console message describing the resulting maintenance status.

timestamps: bool = (source)

Timestamps flag used by MaintenanceModeCommand.