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.

Explore modules View classes

orionis.http

package documentation
(source)

Undocumented

Package adapters Undocumented
Package base No package docstring; 1/1 class, 0/1 module documented
Package contracts Undocumented
Package default Undocumented
Package enums No package docstring; 1/3 class, 0/2 module documented
Package exceptions Undocumented
Module factory Undocumented
Module kernel No module docstring; 0/3 constant, 2/3 classes documented
Package layer Undocumented
Module middleware Undocumented
Package payload Undocumented
Module request No module docstring; 0/6 constant, 1/1 function, 1/1 exception documented
Module responses Undocumented
Package routes Undocumented
Module sse No module docstring; 1/1 function, 1/1 class documented
Module types Undocumented
Module validation No module docstring; 0/3 constant, 4/4 functions documented
Module websocket Undocumented
Module websocket_message Undocumented
Module websocket_middleware Undocumented

From __init__.py:

Class BaseMiddleware Base class for HTTP middleware implementations.
Class EventStreamResponse Stream typed server-sent events through the existing response transport.
Class FileResponse No class docstring; 0/3 instance variable, 0/1 class variable, 4/4 methods documented
Class HTMLResponse No class docstring; 0/1 class variable, 0/1 constant, 1/1 method documented
Class JSONResponse No class docstring; 0/4 instance variable, 0/1 class variable, 0/1 constant, 2/2 methods, 1/1 static method documented
Class PlainTextResponse No class docstring; 0/1 class variable, 0/1 constant, 1/1 method documented
Class RedirectResponse No class docstring; 0/1 class variable, 0/1 constant, 1/1 method documented
Class Request No class docstring; 20/20 properties, 0/28 instance variable, 0/2 class variable, 33/33 methods documented
Class Response No class docstring; 0/8 instance variable, 0/2 class variable, 24/24 methods documented
Class ResponseFactory Build every kind of HTTP response from a single entry-point.
Class ResponseTemplate Store validated immutable content for independent response instances.
Class ServerSentEvent Represent one immutable UTF-8 server-sent event.
Class StreamingResponse No class docstring; 0/1 instance variable, 0/1 class variable, 2/2 methods documented
Class WebSocket Own one server-independent connection with direct awaited messaging.
Class WebSocketMessage Retain an immutable message without copying its payload.
Class WebSocketMessageType Identify a normalized complete WebSocket message.
Class WebSocketMiddleware Define a connection middleware resolved inside each WebSocket scope.
Class WebSocketState Describe the connection lifecycle independently of its server.
Exception WebSocketDisconnected Report a terminal connection failure with available close details.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXPORTS Undocumented
Constant _WEBSOCKET_MESSAGE_MODULE Undocumented
Type Alias NextCallable Undocumented
Variable response Undocumented
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
_EXPORTS = (source)

Undocumented

Value
{'BaseMiddleware': ('orionis.http.middleware', 'BaseMiddleware'),
 'EventStreamResponse': ('orionis.http.responses', 'EventStreamResponse'),
 'FileResponse': ('orionis.http.responses', 'FileResponse'),
 'HTMLResponse': ('orionis.http.responses', 'HTMLResponse'),
 'HttpResponse': ('orionis.http.types', 'HttpResponse'),
 'JSONResponse': ('orionis.http.responses', 'JSONResponse'),
 'NextCallable': ('orionis.http.middleware', 'NextCallable'),
...
_WEBSOCKET_MESSAGE_MODULE: str = (source)

Undocumented

Value
'orionis.http.websocket_message'
NextCallable = (source)

Undocumented

Value
Callable[[], Awaitable[Response]]
response: ResponseFactory = (source)

Undocumented