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

Define the contract for route resolver implementations.

Method allRoutes Return all compiled routes across all HTTP methods.
Method fallback Return the registered fallback handler.
Method invalidateCache Clear the hot-path cache.
Method options Resolve all allowed methods for a path.
Method resolve Resolve a method and path into a compiled route.
def allRoutes(self) -> list: (source)

Return all compiled routes across all HTTP methods.

Returns
list[orionis.http.routes.entities.compiled_route.CompiledRoute]Deduplicated list of every registered compiled route.
def fallback(self) -> tuple | None: (source)

Return the registered fallback handler.

Returns
tuple | NoneFallback descriptor or None if not registered.
def invalidateCache(self): (source)

Clear the hot-path cache.

Returns
NoneRemove all cached entries.
def options(self, path: str) -> list[str]: (source)

Resolve all allowed methods for a path.

Parameters
path:strRaw request path.
Returns
list[str]Sorted list of methods valid for the path.
def resolve(self, method: str, path: str) -> ResolvedRoute: (source)

Resolve a method and path into a compiled route.

Parameters
method:strHTTP method string.
path:strRaw request path.
Returns
orionis.http.routes.entities.resolved_route.ResolvedRouteMatched route and converted path parameters.
Raises
orionis.http.routes.exceptions.route_not_found.RouteNotFoundRaise when no route matches the path.
orionis.http.routes.exceptions.method_not_allowed.MethodNotAllowedRaise when the path exists under a different method.