orionis.http.routes.contracts.route_resolver.IRouteResolver

ORIONIS API REFERENCE

Modules Classes Names

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

class documentation

class IRouteResolver(ABC): (source)

Known subclasses: orionis.http.routes.route_resolver.RouteResolver

View In Hierarchy

Undocumented

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.

@abstractmethod

def allRoutes(self) -> list: (source) ¶

overridden in orionis.http.routes.route_resolver.RouteResolver

Return all compiled routes across all HTTP methods.

Parameters
None	This method does not accept parameters.

Returns
`list[CompiledRoute]`	Deduplicated list of every registered compiled route.

@abstractmethod

def fallback(self) -> tuple | None: (source) ¶

overridden in orionis.http.routes.route_resolver.RouteResolver

Return the registered fallback handler.

Parameters
None	This method does not accept parameters.

Returns
`tuple \| None`	Fallback descriptor or `None` if not registered.

@abstractmethod

def invalidateCache(self): (source) ¶

overridden in orionis.http.routes.route_resolver.RouteResolver

Clear the hot-path cache.

Parameters
None	This method does not accept parameters.

Returns
`None`	Remove all cached entries.

@abstractmethod

def options(self, path: str) -> list[str]: (source) ¶

overridden in orionis.http.routes.route_resolver.RouteResolver

Resolve all allowed methods for a path.

Parameters
path:`str`	Raw request path.

Returns
`list[str]`	Sorted list of methods valid for the path.

@abstractmethod

def resolve(self, method: str, path: str) -> ResolvedRoute: (source) ¶

overridden in orionis.http.routes.route_resolver.RouteResolver

Resolve a method and path into a compiled route.

Parameters
method:`str`	HTTP method string.
path:`str`	Raw request path.

Returns
`ResolvedRoute`	Matched route and converted path parameters.

Raises
`RouteNotFound`	Raise when no route matches the path.
`MethodNotAllowed`	Raise when the path exists under a different method.