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

class IKernelHTTP(ABC): (source)

Known subclasses: orionis.http.kernel.KernelHTTP

View In Hierarchy

Define the contract for kernel http implementations.

Async Method boot Boot the HTTP kernel by initializing core components.
Method disconnectPaths Return static protocol endpoints requiring proactive cancellation.
Async Method handleASGI Handle an incoming ASGI HTTP request end-to-end.
Async Method handleRSGI Handle an incoming RSGI HTTP request end-to-end.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
async def boot(self): (source)

Boot the HTTP kernel by initializing core components.

Resolve routes, initialize middleware stack, configure response adapters, and set up request printer for each protocol.

Returns
NoneBoot the HTTP kernel by initializing core components.
def disconnectPaths(self) -> frozenset[str]: (source)

Return static protocol endpoints requiring proactive cancellation.

Returns
frozenset[str]Static protocol endpoints requiring proactive cancellation.
async def handleASGI(self, scope: dict, receive: object, send: object): (source)

Handle an incoming ASGI HTTP request end-to-end.

Open a per-request scope, run global middleware, resolve the route, build the request object, invoke the handler, and send the response.

Parameters
scope:dictASGI connection scope dict with request metadata.
receive:objectASGI receive callable for reading request body and events.
send:objectASGI send callable for sending response messages.
Returns
NoneHandle an incoming ASGI HTTP request end-to-end.
async def handleRSGI(self, scope: Scope, protocol: HTTPProtocol | WebsocketProtocol) -> object | None: (source)

Handle an incoming RSGI HTTP request end-to-end.

Open a per-request scope, run global middleware, resolve the route, build the request object, invoke the handler, and send the response.

Parameters
scope:granian.rsgi.ScopeGranian RSGI scope object with connection metadata.
protocol:granian.rsgi.HTTPProtocolRSGI HTTP protocol object used to send the response.
Returns
object | NoneThe result of sending the RSGI response, or None on error.
__slots__: tuple = (source)

Declare that this class introduces no additional instance slots.