orionis.http.routes.contracts.router.IRouter

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 IRouter(ABC): (source)

Known subclasses: orionis.http.routes.router.Router

View In Hierarchy

Undocumented

Method	`auth`	Register the built-in web authentication routes.
Method	`delete`	Register a DELETE route.
Method	`export`	Export all registered routes and the fallback handler.
Method	`fallback`	Register the fallback handler for unmatched routes (HTTP 404).
Method	`get`	Register a GET route.
Method	`group`	Register a group of routes with a shared prefix and middleware.
Method	`hub`	Register a Hub connection endpoint with a fixed wire codec.
Method	`patch`	Register a PATCH route.
Method	`post`	Register a POST route.
Method	`put`	Register a PUT route.
Method	`query`	Register a QUERY route.
Method	`view`	Register a GET route that renders a template with no controller.
Method	`websocket`	Register a WebSocket connection handler independently of HTTP routes.
Class Variable	`__slots__`	Undocumented

@abstractmethod

def auth(self, login_controller: type | None = None, register_controller: type | None = None, forgot_password_controller: type | None = None): (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
login_controller:`type \| None, optional`	Controller for login and logout. Defaults to the built-in controller.
register_controller:`type \| None, optional`	Controller for registration and email verification. Defaults to the built-in controller.
forgot_password_controller:`type \| None, optional`	Controller for forgot-password and password-reset routes. Defaults to the built-in controller.

Returns
`None`	Routes are registered on this router.

Raises
`ValueError`	If registration is attempted outside the web route context.

@abstractmethod

def delete(self, path: str, action: RouteAction | None = None) -> FluentRoute: (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
path:`str`	URL path for the route.
action:`RouteAction \| None, optional`	Callable, invokable controller class (defining `__call__`), or `[ControllerClass, 'method_name']` list. If omitted or None, call `action(controller, handler)` on the returned route before exporting the router.

Returns
`FluentRoute`	The registered FluentRoute instance.

@abstractmethod

def export(self) -> dict: (source) ¶

overridden in orionis.http.routes.router.Router

Export all registered routes and the fallback handler.

Returns

dict

A dictionary with two keys:

'routes': list of all registered routes as dicts.
'fallback': tuple (class_or_None, handler_or_callable).

Raises
`ValueError`	If a registered route still has no action or view.

@abstractmethod

def fallback(self, action: RouteAction): (source) ¶

overridden in orionis.http.routes.router.Router

Only one fallback may be registered; a second call raises FallbackRouteAlreadyRegisteredException.

Parameters
action:`RouteAction`	Callable, invokable controller class (defining `__call__`), or `[ControllerClass, 'method_name']` list. Required because fallback registration does not return a fluent route builder.

Returns
`None`	The fallback is stored on the instance; no value is returned.

Raises
`FallbackRouteAlreadyRegisteredException`	If a fallback handler has already been registered.
`TypeError`	If the action is None or is not an accepted handler form.
`ValueError`	If a controller pair has an invalid length or names a missing method.

@abstractmethod

def get(self, path: str, action: RouteAction | None = None) -> FluentRoute: (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
path:`str`	URL path for the route.
action:`RouteAction \| None, optional`	Callable, invokable controller class (defining `__call__`), or `[ControllerClass, 'method_name']` list. If omitted or None, call `action(controller, handler)` on the returned route before exporting the router.

Returns
`FluentRoute`	The registered FluentRoute instance.

@abstractmethod

overridden in orionis.http.routes.router.Router

Parameters
prefix:`str \| None, optional`	URL prefix prepended to every route path in the group.
middleware:`MiddlewareInput \| None, optional`	Middleware classes to attach to every route in the group. Accepts a single class or a container of classes.
without_middleware:`MiddlewareInput \| None, optional`	Middleware classes to exclude from every route in the group. Accepts a single class or a container of classes.
routes:`Sequence[FluentRoute \| RouteGroup] \| None, optional`	Routes or nested groups to include.
public:`bool \| None, optional`	Stateless profile inherited by descendants without an explicit choice.

Returns
`RouteGroup`	Flattened membership for composition by another group.

Raises
`ValueError`	If routes is empty or `None`.
`ValueError`	If prefix is not a `str`.
`ValueError`	If any entry in middleware or without_middleware is not a `BaseMiddleware` subclass.
`TypeError`	If membership contains neither routes nor groups.

@abstractmethod

def hub(self, path: str, hub: type[Hub], *, protocol: str = 'json') -> FluentRoute: (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
path:`str`	WebSocket route path, with optional converted parameters.
hub:`type[Hub]`	Hub subclass resolved through the application container.
protocol:`str, optional`	`json` by default, or `msgpack` for binary frames.

Returns
`FluentRoute`	Registered Hub route builder.

@abstractmethod

def patch(self, path: str, action: RouteAction | None = None) -> FluentRoute: (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
path:`str`	URL path for the route.
action:`RouteAction \| None, optional`	Callable, invokable controller class (defining `__call__`), or `[ControllerClass, 'method_name']` list. If omitted or None, call `action(controller, handler)` on the returned route before exporting the router.

Returns
`FluentRoute`	The registered FluentRoute instance.

@abstractmethod

def post(self, path: str, action: RouteAction | None = None) -> FluentRoute: (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
path:`str`	URL path for the route.
action:`RouteAction \| None, optional`	Callable, invokable controller class (defining `__call__`), or `[ControllerClass, 'method_name']` list. If omitted or None, call `action(controller, handler)` on the returned route before exporting the router.

Returns
`FluentRoute`	The registered FluentRoute instance.

@abstractmethod

def put(self, path: str, action: RouteAction | None = None) -> FluentRoute: (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
path:`str`	URL path for the route.
action:`RouteAction \| None, optional`	Callable, invokable controller class (defining `__call__`), or `[ControllerClass, 'method_name']` list. If omitted or None, call `action(controller, handler)` on the returned route before exporting the router.

Returns
`FluentRoute`	The registered FluentRoute instance.

@abstractmethod

def query(self, path: str, action: RouteAction | None = None) -> FluentRoute: (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
path:`str`	URL path for the route.
action:`RouteAction \| None, optional`	Callable, invokable controller class (defining `__call__`), or `[ControllerClass, 'method_name']` list. If omitted or None, call `action(controller, handler)` on the returned route before exporting the router.

Returns
`FluentRoute`	The registered FluentRoute instance.

@abstractmethod

def view(self, path: str, view: str) -> FluentRoute: (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
path:`str`	URL path for the route.
view:`str`	Template name in dot notation (e.g. `'welcome'`)

Returns
`FluentRoute`	The registered FluentRoute instance.

@abstractmethod

def websocket(self, path: str, action: RouteAction | None = None) -> FluentRoute: (source) ¶

overridden in orionis.http.routes.router.Router

Parameters
path:`str`	Connection path with optional converted parameters.
action:`RouteAction \| None, optional`	Function, controller action, or invokable controller.

Returns
`FluentRoute`	Registered connection route builder.

__slots__: tuple = (source) ¶

Undocumented